---
title: "ListCatalogs"
method: GET
path: "/v1alpha/catalogs"
tags: ["DataCatalogsService"]
---

# ListCatalogs

`GET /v1alpha/catalogs`

Lists all configured catalogs.

## Query parameters

- `pageParameters.skip` integer
- `pageParameters.pageSize` integer
- `pageParameters.pageToken` string

## Response `200`

OK

- ListCatalogsResponse
  - `catalogs` DataCatalog[]
    - `databases` Database[] — A top-most level of the catalog. This is typically a database.
      - `catalog` DataCatalog — recursive
      - `displayName` string
      - `id` string — The id of the database
      - `processingPlatform` ProcessingPlatform
        - `id` string — An arbitrary but unique identifier for the platform. This matches the id from the PACE app configuration.
        - `platformType` 'PLATFORM_TYPE_UNSPECIFIED' | 'DATABRICKS' | 'SNOWFLAKE' | 'BIGQUERY' | 'POSTGRES' | 'SYNAPSE', enum
      - `schemas` Schema[] — The schemas in this database.
        - `database` Database — recursive
        - `id` string — The id used by the catalog.
        - `name` string
        - `tables` Table[] — The tables in this schema.
          - `id` string — The id used by the catalog.
          - `name` string
          - `schema` Schema — recursive
          - `tags` string[]
        - `tags` string[]
      - `tags` string[]
      - `type` string
    - `id` string — An arbitrary but unique identifier for the catalog. This matches the id from the PACE app configuration.
    - `tags` string[]
    - `type` 'TYPE_UNSPECIFIED' | 'COLLIBRA' | 'ODD' | 'DATAHUB', enum
  - `pageInfo` PageInfo
    - `nextPageToken` string — token for the next page
    - `total` integer — The (estimated) total number of records. If the total is unknown, this value is -1.

## Other responses

- `default` — Default error response

## Changes

- **2024-01-26** `12ea67ec598f` — 2 info
  - added the new optional `query` request parameter `pageParameters.pageToken`
  - added the optional property `pageInfo/nextPageToken` to the response with the `200` status
- **2024-01-12** `fece62c921d3` — 3 info
  - added the optional property `catalogs/items/databases/items/processingPlatform` to the response with the `200` status
  - added `#/components/schemas/Schema` to the `catalogs/items/databases/items/schemas/items/tables/items/schema` response property `allOf` list for the response status `200`
  - removed `#/components/schemas/DataCatalog_Schema` from the `catalogs/items/databases/items/schemas/items/tables/items/schema` response property `allOf` list for the response status `200`
- **2024-01-08** `a00039bf1f21` — 1 warning, 2 info
  - removed the optional property `catalogs/items/databases/items/processingPlatform` from the response with the `200` status
  - added `#/components/schemas/DataCatalog_Schema` to the `catalogs/items/databases/items/schemas/items/tables/items/schema` response property `allOf` list for the response status `200`
  - removed `#/components/schemas/Schema` from the `catalogs/items/databases/items/schemas/items/tables/items/schema` response property `allOf` list for the response status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/getstrm/apis/pace-api/changes/v1alpha/catalogs/get.md)

---

[API](https://skmtc.dev/getstrm/apis/pace-api.md) · [All operations](https://skmtc.dev/getstrm/apis/pace-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getstrm/pace-api/revisions/7102a90e7c1e/schema)
