---
title: "ListResources"
method: GET
path: "/v1alpha/resources"
tags: ["ResourcesService"]
---

# ListResources

`GET /v1alpha/resources`

## Query parameters

- `integrationId` string
- `resourcePath` string[]
- `pageParameters.skip` integer
- `pageParameters.pageSize` integer
- `pageParameters.pageToken` string

## Response `200`

OK

- ListResourcesResponse
  - `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.
  - `resources` ResourceUrn[]
    - `catalog` 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
    - `integrationFqn` string — the Fully Qualified Name of the data resource on the processing platform / data catalog.
    - `platform` 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
    - `resourcePath` ResourceNode[]
      - `displayName` string — human readable string. If absent use name.
      - `isLeaf` boolean — data resource
      - `name` string — the bits between the slashes. the technical path to the data. can be uuid (Collibra for instance)
      - `platformName` string — dataset, schema, table, whatever... For display purposes only. FIXME platform type

## 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-26** `7569cbc2340d` — 1 info
  - endpoint added
- **2023-11-17** `04d64891152e` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/getstrm/apis/pace-api/changes/v1alpha/resources/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)