# View catalog

Use `/catalogs/view` to view an existing catalog.

## View

> Get information about an existing catalog.

```json
{"openapi":"3.1.0","info":{"title":"Batch - REST API","version":"2.9"},"tags":[{"name":"Catalogs"}],"servers":[{"url":"https://api.batch.com/{version}","description":"production","variables":{"version":{"default":"2.11","description":"Version of the API"}}}],"security":[{"rest_key":[]}],"components":{"securitySchemes":{"rest_key":{"type":"http","scheme":"bearer","description":"## API Key Authentication\n\nAuthentication is required in order to interact with Batch's APIs.\n\nBatch implements authentication using API Keys, that we call the \"REST API Key\".\nYou can find it on your dashboard.\n\nPlease make sure that you keep this key secret. You should never use it in client apps to call APIs from there as it would\neasily be extractable.\n\n### How to authenticate\n\nIn order to authenticate your requests, add your REST API Key in the `Authorization` header and prefix it by `Bearer`. Example: `Authorization: Bearer bcd38d9rfb38ra28`.\n"}},"parameters":{"HeaderProjectKey":{"in":"header","name":"X-Batch-Project","description":"The unique project key, identifying a project on the Batch platform","schema":{"type":"string"},"required":true}},"schemas":{"catalog":{"description":"A catalog represents a structured collection of items and associated fields that define the schema of those items.","type":"object","required":["name","fields","items","size","created","updated"],"properties":{"name":{"type":"string","description":"Unique identifier for the catalog, used for referencing in API calls."},"fields":{"type":"array","description":"List of fields that define the schema of items in the catalog.","items":{"$ref":"#/components/schemas/field"},"minItems":1,"maxItems":25},"items":{"type":"integer","description":"Total number of items currently stored in this catalog."},"size":{"type":"integer","description":"Size of the catalog data in bytes."},"created":{"type":"string","format":"date-time","description":"RFC 3339 UTC date indicating when the catalog was created."},"updated":{"type":"string","format":"date-time","description":"RFC 3339 UTC date of the last update to the catalog."},"indexing_state":{"type":"string","enum":["IN_PROGRESS","APPLIED"],"description":"Indicates the current indexing state of the catalog items."}}},"field":{"description":"A field defines a single attribute type that items in the catalog can have. Each field has a unique name and a type.","type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the field as it will appear on catalog items.","pattern":"[a-z0-9_]+$","minLength":1,"maxLength":250},"type":{"$ref":"#/components/schemas/field_type","description":"The data type for this field, such as integer or string."}}},"field_type":{"type":"string","description":"Enumerates the possible data types allowed for catalog fields.","enum":["array","bool","date","float","integer","string","url"]},"Error":{"type":"object","required":["error_message","error_code"],"properties":{"error_message":{"description":"A human readable error message","type":"string"},"error_code":{"description":"Error code","type":"string"}}}},"responses":{"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Batch's services are under maintenance. Please try again later","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/catalogs/view":{"get":{"operationId":"catalog_view","summary":"View","description":"Get information about an existing catalog.","tags":["Catalogs"],"parameters":[{"$ref":"#/components/parameters/HeaderProjectKey"},{"name":"name","in":"query","required":true,"schema":{"type":"string"},"description":"Catalog identifier to retrieve."},{"name":"indexing_token","in":"query","required":false,"schema":{"type":"string"},"description":"Optional token used for indexing state tracking."}],"responses":{"200":{"description":"Successfully retrieved the catalog metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalog"}}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}}}}}}
```

### 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](https://doc.batch.com/developer/api/cep/..#request-headers-and-authentication).

#### 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.

```json
{
    "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.