Service statusLog in

View catalog

Use /catalogs/view to view an existing catalog.

View

get

Get information about an existing catalog.

Authorizations
AuthorizationstringRequired

API Key Authentication

Authentication is required in order to interact with Batch's APIs.

Batch implements authentication using API Keys, that we call the "REST API Key". You can find it on your dashboard.

Please make sure that you keep this key secret. You should never use it in client apps to call APIs from there as it would easily be extractable.

How to authenticate

In order to authenticate your requests, add your REST API Key in the Authorization header and prefix it by Bearer. Example: Authorization: Bearer bcd38d9rfb38ra28.

Query parameters
namestringRequired

Catalog identifier to retrieve.

indexing_tokenstringOptional

Optional token used for indexing state tracking.

Header parameters
X-Batch-ProjectstringRequired

The unique project key, identifying a project on the Batch platform

Example: project_0664hxvwffvbpn278gxdyhsadddqgna6
Responses
get
/catalogs/view
GET /2.8/catalogs/view?name=text HTTP/1.1
Host: api.batch.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-Batch-Project: text
Accept: */*

{
  "name": "products",
  "fields": [
    {
      "name": "price",
      "type": "float"
    }
  ],
  "items": 42,
  "size": 4882372,
  "created": "2025-12-06T15:01:31.290Z",
  "updated": "2025-12-06T15:01:31.290Z",
  "indexing_state": "APPLIED"
}

Request structure

Route

The Catalog API exposes a GET endpoint that allows to get information about an existing catalog:

/catalogs/view

Headers and authentication

See Overview → Using Project APIs.

Query parameters

See the API Description.

Responses

Success

If the GET to the API endpoint is successful you will receive an HTTP 200 confirmation and information about your catalog.

{
    "name": "MOVIES",
    "items": 8807,
    "size": 7746977,
    "created": "2025-07-14T16:27:14Z",
    "updated": "2025-07-21T09:20:44Z",
    "fields": [
        {
            "name": "director",
            "type": "string"
        },
        {
            "name": "title",
            "type": "string"
        },
        {
            "name": "release_year",
            "type": "integer"
        },
        {
            "name": "cast",
            "type": "array"
        },
        {
            "name": "description",
            "type": "string"
        }
    ],
    "indexing_state": "APPLIED"
}

The indexing_state is the processing status of updated catalog items that returned the given indexing_token. If there is no indexing token provided, no indexing state will be returned.

2 values are possible for indexing state:

  • IN_PROGRESS : catalog item update processing is in progress

  • APPLIED : catalog item update processing is finished

Failure

If the POST data does not meet the API requirements you will receive an actionable error message. Contact us at support@batch.com if you need further support.

PreviousRemove catalogNextList catalogs

Last updated