---
updatedAt: 2026-03-30T13:31:48.000Z
agentTools:
  siteIndex: https://documentation.bloomreach.com/llms.txt
  projectIndex: https://documentation.bloomreach.com/engagement/llms.txt
---

# Get all catalogs

**/data/v2/projects/{projectToken}/catalogs**

Retrieve a list of all the catalogs in your project. The list contains the IDs and names.

# Definition

## Authorization

In this API call you must use the following authorization access and permissions:

[block:parameters]
{
  "data": {
    "h-0": "Available access type",
    "h-1": "Permissions needed",
    "0-0": "Private access",
    "0-1": "Catalogs > Get catalog list"
  },
  "cols": 2,
  "rows": 1
}
[/block]

Read more about:

* [Authentication](https://documentation.bloomreach.com/engagement/reference/authentication)
* [Setting up permissions](https://documentation.bloomreach.com/engagement/reference/prerequisites)
* [Creating an authorization header](https://documentation.bloomreach.com/engagement/reference/technical-information)

## Path parameters

[block:parameters]
{
  "data": {
    "h-0": "Parameter",
    "h-1": "Type",
    "h-2": "Description",
    "h-3": "Required",
    "0-3": "Required",
    "0-2": "The ID of your project.",
    "0-1": "string",
    "0-0": "projectToken"
  },
  "cols": 4,
  "rows": 1
}
[/block]

## Header

[block:parameters]
{
  "data": {
    "h-0": "Parameter",
    "h-1": "Type",
    "h-2": "Description",
    "h-3": "Required",
    "0-0": "authorization",
    "1-0": "content-type",
    "0-1": "string",
    "0-2": "Used for authentication. Read more in the [Authentication](https://documentation.bloomreach.com/engagement/reference/authentication) section.",
    "0-3": "Required",
    "1-3": "Required",
    "1-2": "application/json",
    "1-1": "string"
  },
  "cols": 4,
  "rows": 2
}
[/block]

# Response description

[block:parameters]
{
  "data": {
    "h-0": "Attribute",
    "h-1": "Type",
    "0-0": "data",
    "0-1": "array of objects",
    "h-2": "Description",
    "0-2": "List of catalog descriptions (catalog `id` and `name`)",
    "1-0": "success",
    "1-1": "boolean",
    "1-2": "Result status"
  },
  "cols": 3,
  "rows": 2
}
[/block]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "catalog-api",
    "version": "2"
  },
  "servers": [
    {
      "url": "https://api.exponea.com"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/data/v2/projects/{projectToken}/catalogs": {
      "get": {
        "summary": "Get all catalogs",
        "description": "**/data/v2/projects/{projectToken}/catalogs**\n\nRetrieve a list of all the catalogs in your project. The list contains the IDs and names.",
        "operationId": "get-all-catalogs-2",
        "parameters": [
          {
            "name": "projectToken",
            "in": "path",
            "schema": {
              "type": "string",
              "default": "12345678-1234-1234-1234-123456789abc"
            },
            "required": true
          },
          {
            "name": "authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Basic <APIKeyID/APISecret>"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": [\n        {\n            \"id\": \"60758e2d18883e1048b817a8\",\n            \"name\": \"catalog_1\"\n        },\n        {\n            \"id\": \"60758e326518b58d8077ba67\",\n            \"name\": \"catalog_2\"\n        }\n    ],\n    \"success\": true\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "60758e2d18883e1048b817a8"
                          },
                          "name": {
                            "type": "string",
                            "example": "catalog_1"
                          }
                        }
                      }
                    },
                    "success": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"errors\": {\n        \"_global\": [\n            \"No permission to get catalog list. Check Project settings -> API -> Catalogs -> Get catalog list.\"\n        ]\n    },\n    \"success\": false\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "object",
                      "properties": {
                        "_global": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "No permission to get catalog list. Check Project settings -> API -> Catalogs -> Get catalog list."
                          }
                        }
                      }
                    },
                    "success": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```