--- title: "List Resources" method: GET path: "/api/v1/resource/catalog" tags: ["Resources"] --- # List Resources `GET /api/v1/resource/catalog` Use this endpoint to list all catalog resources. The resources can be sorted or filtered by most of the fields in the response, using the Sort and Filter JSON objects respectively. More details about the sort and filter query parameters can be found below. The default sort is by external usage in descending order. Please refer to our product documentation **[here](https://docs.secoda.co/api/reference/getting-started#catalog-filters)** for assistance with the `filter` param. We have exposed a filter generator in https://app.secoda.co/settings/api to make creating these requests easier. **Important Limitations:** - This endpoint has a maximum limit of 10,000 resources that can be returned across all pages - For large datasets exceeding 10,000 resources, consider using more specific `filter` to narrow your results ## Query parameters - `page` number - `teams` string - `filter` string - `sort` string ## Response `200` List of resources. - object - `links` object — Indicates Links to associated pages. - `next` string — The link to the next page (null if there are no more pages). - `previous` string — The link to the previous page (null if on the first page). - `meta` object — Reprents the meta data of the response. - `page` integer — The current page number. - `previous_page` integer — The previous page number (null if on the first page). - `next_page` integer — The next page number (null if on the last page). - `count` integer — The total count of items returned. - `total_pages` integer — The total number of pages. - `results` V1CatalogResponse[] - `id` string — Unique identifier for the resource. - `created_at` string, date-time — The creation timestamp of the resource in Secoda. - `updated_at` string, date-time — The last update timestamp of the resource in Secoda. - `entity_type` string — The type of the resource. - `native_type` string — The type of the resource as indicated in the integration. - `icon` string — An optional icon for the resource. - `title` string — The title of the resource. - `title_full` string — The full title of the resource, including its ancestry. - `title_cased` string — The title of the resource in title case format. - `description` string — Description of the resource. - `definition` string — The markdown documentation of the resource. - `definition_version` integer — Version number of the resource documentation. - `multiplayers` object[] — List of users interacting collaboratively on the resource [Not currently in use]. - `multiplayer_last_modified_by` string — The last user to modify the resource [Not currently in use]. - `multiplayer_last_modified` string — Timestamp of the last modification [Not currently in use]. - `owners` string[] — List of User IDs associated with the resource. - `owners_groups` string[] — List of Group IDs associated with the resource. - `collections` string[] — List of Collection IDs to which the resource belongs. - `tags` string[] — List of Tag IDs associated with the resource. - `workspace_id` string — Workspace identifier in which the resource resides. - `published` boolean — Flag indicating whether the resource is published and visible to Viewers. - `archived` boolean — Flag indicating whether the resource is archived. - `archived_at` string, nullable — Timestamp when the resource was archived. - `pii` boolean — Flag indicating if the resource contains personally identifiable information. - `verified` boolean — Flag indicating whether the resource has been verified. - `url` string — URL to access the resource on the web. - `parent` string — Parent ID of the resource. - `children_count` integer — Number of child entities associated with this resource. - `bookmarked_by` string[] — List of User IDs who have bookmarked the resource. - `integration` string — Identifier for integration from which the resource was extracted. - `external_updated_at` string — The last update timestamp of the resource in the source. - `internal_usage` integer — Number of times the resource has been viewed within Secoda. - `internal_users` string[] — List of users who have interacted with the resource in Secoda. - `external_users` string[] — List of users who have interacted with the resource in the source. - `external_usage` integer — Number of times the resource has been viewed or queried in the Source. - `databuilder_id` string — Unique identifier for the resource. - `search_metadata` object — A set of properties used for indexing in search. - `sources` string[] — Data sources that augment the resource, such as dbt. - `subscribers` string[] — List of users subscribed to updates on the resource. - `teams` string[] — Teams IDs associated with the resource. - `stale` boolean — Flag indicating if the resource is considered stale. - `stale_at` string — Timestamp indicating when the resource was last marked as stale. - `forced_unstale_by_user` boolean — Flag indicating if the stale status of the resource was removed by a user action. - `current_user_permissions` string — Permissions of the current user on the resource. - `row_count` integer — The number of rows present in the resource. - `byte_size` integer — The size of the data used by the dashboard in bytes. - `display_metadata` object — Display-specific metadata for rendering the resource in Secoda. - `question_status` string — Status of the question [Not currently in use for Catalog resources]. - `question_priority` string, nullable — Priority level of the question [Not currently in use for Catalog resources]. - `question_answered_by` string, nullable — User ID of the person who answered the question [Not currently in use for Catalog resources]. - `question_assigned_to` string, nullable — User ID of the person to whom the question is assigned [Not currently in use for Catalog resources]. ## Other responses - `400` — Bad request. - `500` — Internal server error. --- [API](https://skmtc.dev/secoda/apis/secoda-api.md) · [All operations](https://skmtc.dev/secoda/apis/secoda-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/secoda/secoda-api/revisions/e6d760bd7a94/schema)