---
title: "List"
method: GET
path: "/catalogs/list"
tags: ["Catalogs"]
---

# List

`GET /catalogs/list`

List catalogs

## Query parameters

- `from` string
- `limit` integer

## Headers

- `X-Batch-Project` string, required

## Response `200`

Successfully listed all catalogs.

- object
  - `catalogs` Catalog[], required — Array of catalog objects.
    - `name` string, required — Unique identifier for the catalog, used for referencing in API calls.
    - `fields` Field[], required — List of fields that define the schema of items in the catalog.
      - `name` string, required — The name of the field as it will appear on catalog items.
      - `type` 'array' | 'bool' | 'date' | 'float' | 'integer' | 'string' | 'url', required — Enumerates the possible data types allowed for catalog fields.
    - `items` integer, required — Total number of items currently stored in this catalog.
    - `size` integer, required — Size of the catalog data in bytes.
    - `created` string, date-time, required — RFC 3339 UTC date indicating when the catalog was created.
    - `updated` string, date-time, required — RFC 3339 UTC date of the last update to the catalog.
    - `indexing_state` 'IN_PROGRESS' | 'APPLIED' — Indicates the current indexing state of the catalog items.
    - `pending_replace` PendingReplace — **Beta.** Progress of the pending revision of an open replace. Use it to see when the revision is ready to apply. Batch returns this block only while a replace session is open for the catalog. Batch also returns it only to callers that send `Batch-Beta: catalog-replace` on API version `2.11` or later.
      - `replace_token` string, required — Token that identifies the open replace session. Use it to send more items to the session or to complete it.
      - `indexing_state` 'IN_PROGRESS' | 'APPLIED', required — Indexing state of the pending revision. It must be `APPLIED` before you can complete the replace.
      - `items` integer, required — Number of items in the pending revision now.
      - `size` integer, required — Size of the pending revision data in bytes.
  - `count` integer, required — Total number of catalogs.
  - `has_more` boolean, required — Indicates whether more catalogs are available.
  - `next_from` string, required — Cursor for pagination if more results are available.

---

[API](https://skmtc.net/batch/apis/batch-rest-api.md) · [All operations](https://skmtc.net/batch/apis/batch-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/batch/batch-rest-api/revisions/ec696334ff35/schema)