---
title: "List Resources"
method: GET
path: "/v1/resources"
tags: ["Catalog Resources"]
---

# List Resources

`GET /v1/resources`

Returns a paginated collection of resources.

## Query parameters

- `page` CursorPageParameters
  - `size` integer — The number of items included per page.
  - `after` string — Cursor param specifying the page (i.e. the next page) of data returned.
  - `before` string — Cursor param specifying the page (i.e. the previous page) of data returned.
- `filter` CatalogResourceFilterParameters
  - `id` StringFieldFilterExact — Filter using **one** of the following operators: `eq`, `oeq`, `neq`
    - `eq` string — The field exactly matches the provided value.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `name` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `integration.name` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `integration.display_name` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `integration.instance.id` UuidFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`
    - `eq` string — The field exactly matches the provided value.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `integration.instance.name` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `integration.instance.display_name` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `type` StringFieldFilterExact — Filter using **one** of the following operators: `eq`, `oeq`, `neq`
    - `eq` string — The field exactly matches the provided value.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `config` CatalogResourceConfigFieldFilter — Filters on the resource's `config` field. Filters must use dot-notation to identify the property that will be used to filter the results. For example: - `filter[config.control_plane_id]` - `filter[config.gateway_service_id][neq]=cedbd134-fc5c-4d44-9e38-ccd2a0c6e0ae`
    - `eq` string
    - `contains` string, required
    - `ocontains` string, required
    - `oeq` string, required
    - `neq` string, required
  - `integration_data` CatalogResourceIntegrationDataFieldFilter — Filters on the resource's `integration_data` field. Filters must use dot-notation to identify the property that will be used to filter the results. For example: - `filter[integration_data.control_plane.id]=760562c3-fedd-43e4-b742-fc1663fef188` - `filter[integration_data.gateway_service.name][contains]=legacy`
    - `eq` string
    - `contains` string, required
    - `ocontains` string, required
    - `oeq` string, required
    - `neq` string, required
  - `archived` boolean — Filter by a boolean value (true/false).
  - `service_associations` union — Filter by a numeric value.
    - number — Value strictly equals the given numeric value.
    - object
      - `eq` number, required — Value strictly equals the given numeric value.
    - object
      - `lt` number, required — Value is less than the given numeric value.
    - object
      - `lte` number, required — Value is less than or equal to the given numeric value.
    - object
      - `gt` number, required — Value is greater than the given numeric value.
    - object
      - `gte` number, required — Value is greater than or equal to the given numeric value.
  - `created_at` union — Filters on the given datetime (RFC-3339) field value.
    - object
      - `eq` string, date-time, required — Value strictly equals given RFC-3339 formatted timestamp in UTC
    - object
      - `lt` string, date-time, required — Value is less than the given RFC-3339 formatted timestamp in UTC
    - object
      - `lte` string, date-time, required — Value is less than or equal to the given RFC-3339 formatted timestamp in UTC
    - object
      - `gt` string, date-time, required — Value is greater than the given RFC-3339 formatted timestamp in UTC
    - object
      - `gte` string, date-time, required — Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC
  - `updated_at` union — Filters on the given datetime (RFC-3339) field value.
    - object
      - `eq` string, date-time, required — Value strictly equals given RFC-3339 formatted timestamp in UTC
    - object
      - `lt` string, date-time, required — Value is less than the given RFC-3339 formatted timestamp in UTC
    - object
      - `lte` string, date-time, required — Value is less than or equal to the given RFC-3339 formatted timestamp in UTC
    - object
      - `gt` string, date-time, required — Value is greater than the given RFC-3339 formatted timestamp in UTC
    - object
      - `gte` string, date-time, required — Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC
- `sort` string — The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

## Response `200`

A paginated list response for a collection of resources.

- object
  - `meta` CursorMeta, required — Pagination metadata.
    - `page` CursorMetaPage, required
      - `first` string, path — URI to the first page
      - `last` string, path — URI to the last page
      - `next` string, path, nullable, required — URI to the next page
      - `previous` string, path, nullable, required — URI to the previous page
      - `size` number, required — Requested page size
  - `data` CatalogResource[], required
    - `id` string, base64url, required — The resource ID.
    - `name` string, nullable, required — The name of the resource. Will be `null` when the resource has not yet been hydrated by the integration.
    - `integration` IntegrationRef, required — Short-hand descriptor of an integration installed within the catalog.
      - `name` string, required
      - `display_name` string, required
      - `instance` IntegrationInstanceRef, required — Short-hand descriptor of an integration instance.
        - `id` string, uuid, required — The integration instance ID.
        - `name` string, required — The machine name of the integration instance that uniquely identifies it within the catalog.
        - `display_name` string, required — The display name of the integration instance.
    - `type` string, required — The resource type. Available resource types are compiled from the integrations installed within the catalog.
    - `config` CatalogResourceConfig, required — JSON object representing the properties used to identify the resource in the third-party system. The schema depends on the resource type and is dynamically registered at runtime.
    - `integration_data` object, nullable, required — JSON object containing schemaless integration data of the resource. This field is always populated by the system backing the integration. When `null`, the resource has been manually initialized via API but has yet to be hydrated by the integration.
    - `archived` boolean, required — Whether or not the resource has been archived.
    - `service_associations` number, required — The number of catalog services this resource is mapped to.
    - `created_at` string, date-time, required — An ISO-8601 timestamp representation of entity creation date.
    - `updated_at` string, date-time, required — An ISO-8601 timestamp representation of entity update date.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/versions/0261aef4b1e2/schema)