---
title: "List resources"
method: GET
path: "/zones/{zoneId}/resources"
tags: ["Resources"]
---

# List resources

`GET /zones/{zoneId}/resources`

## Request

- Base URL: `https://docs.keycard.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.keycard.ai/zones/{zoneId}/resources`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Client credentials
    - Token URL: `/service-account-token`

Returns a paginated list of resources in the specified zone. Use cursor pagination via `after`/`before`, and `expand[]=total_count` to include the matching row count. Filter by exact identifier via `filter[identifier]`. Filter by trait via `filter[traits]` (repeated params are OR'd) or `filter[traits][all]` (contains-all). The scalar `identifier` query parameter is a backward-compatible alias for `filter[identifier]`: exact match on a single value, folded into the same exact-match identifier filter.

## Path parameters

- `zoneId` string, required

## Query parameters

- `after` string
- `before` string
- `limit` integer
- `expand[]` union
  - 'total_count'
  - string[]
- `filter[slug]` union
  - string: Filter by exact resource slug
  - string[]
- `filter[identifier]` union
  - string: Filter by exact resource identifier
  - string[]
- `filter[id]` union
  - string: Restrict results to resources with this publicId. Repeatable, max 100. Mutually exclusive with after/before.
  - string[]
- `query[name]` union
  - string: Search by name (substring match)
  - string[]
- `query[identifier]` union
  - string: Search by identifier (substring match)
  - string[]
- `query[]` union
  - string: Search across name and identifier (substring match)
  - string[]
- `sort` string
- `filter[owner_type]` 'platform' | 'customer'
- `identifier` string
- `credentialProviderId` string
- `slug` string
- `filter[traits]` union
  - string
  - string[]
- `filter[dependency_of_application_id][ne]` union
  - string: Resources that are not a dependency of this application. Repeatable (none of), max 100.
  - string[]

## Response `200`

Default Response

- object
  - `items` IamResource[], required
    - `id` string, required: Unique identifier of the resource
    - `organization_id` string, required: Organization that owns this resource
    - `zone_id` string, required: Zone this resource belongs to
    - `slug` string, required: URL-safe identifier, unique within the zone
    - `identifier` string, required: User specified identifier, unique within the zone
    - `name` string, required: Human-readable name
    - `description` string, nullable: Human-readable description
    - `scopes` string[], nullable: Scopes supported by the resource
    - `credential_provider_id` string: ID of the credential provider for this resource
    - `credential_provider` IamProvider: A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.
      - `id` string, required: Unique identifier of the provider
      - `organization_id` string, required: Organization that owns this provider
      - `zone_id` string, required: Zone this provider belongs to
      - `slug` string, required: URL-safe identifier, unique within the zone
      - `name` string, required: Human-readable name
      - `description` string, nullable: Human-readable description
      - `identifier` string, required: User specified identifier, unique within the zone
      - `type` 'external' | 'keycard-vault' | 'keycard-sts'
      - `client_id` string, nullable: OAuth 2.0 client identifier
      - `client_secret_set` boolean: Indicates whether a client secret is configured
      - `protocols` object, nullable: Protocol-specific configuration
        - `oauth2` IamProviderOAuth2Protocol, nullable: OAuth 2.0 protocol configuration
          - `issuer` string, uri, required: OIDC issuer URL used for discovery and token validation.
          - `authorization_endpoint` string, uri, nullable
          - `token_endpoint` string, uri, nullable
          - `registration_endpoint` string, uri, nullable
          - `jwks_uri` string, uri, nullable
          - `code_challenge_methods_supported` string[], nullable
          - `scopes_supported` string[], nullable
          - `authorization_resource_enabled` boolean, nullable: Whether to include the resource parameter in authorization requests.
          - `authorization_resource_parameter` string, nullable: The resource parameter value to include in authorization requests. Defaults to "resource" when authorization_resource_enabled is true.
          - `scope_parameter` string, nullable: The query parameter name for scopes in authorization requests. Defaults to "scope". Slack v2 uses "user_scope".
          - `scope_separator` string, nullable: The separator character for scope values. Defaults to " " (space). Slack v2 uses ",".
          - `token_response_access_token_pointer` string, nullable: Dot-separated path to the access token in the token response body. Defaults to "access_token". Slack v2 uses "authed_user.access_token".
          - `authorization_parameters` object, nullable: Custom query parameters appended to authorization redirect URLs. Use for non-standard providers (e.g. Google prompt=consent, access_type=offline).
        - `openid` IamProviderOpenIDProtocol, nullable: OpenID Connect protocol configuration
          - `userinfo_endpoint` string, uri, nullable
          - `user_identifier_claim` string, nullable: Name of a top-level string claim in this provider's ID Token to use as the user identifier on user creation. When not set, the user's Keycard ID is used.
          - `scopes` string[], nullable: Additional OIDC scopes to request from this provider during authentication (e.g. "groups"). Merged with the default scopes (openid, profile, email).
          - `single_logout_enabled` boolean, nullable: When true, logging out of the zone propagates the logout to this provider's end_session_endpoint (RP-initiated logout). Defaults to false.
      - `metadata` object, nullable: Provider metadata
        - `icon_url` string, uri: Icon URL
      - `owner_type` 'platform' | 'customer', required: Who owns this provider. Platform-owned providers cannot be modified via API.
      - `created_at` string, date-time, required: Entity creation timestamp
      - `updated_at` string, date-time, required: Entity update timestamp
    - `application_id` string: ID of the application that provides this resource
    - `application` IamApplication: An Application is a software system with an associated identity that can access Resources. It may act on its own behalf (machine-to-machine) or on behalf of a user (delegated access).
      - `id` string, required: Unique identifier of the application
      - `organization_id` string, required: Organization that owns this application
      - `zone_id` string, required: Zone this application belongs to
      - `slug` string, required: URL-safe identifier, unique within the zone
      - `identifier` string, required: User specified identifier, unique within the zone
      - `name` string, required: Human-readable name
      - `description` string, nullable: Human-readable description
      - `metadata` IamMetadata: Entity metadata
        - `docs_url` string, uri: Documentation URL
        - `icon_url` string, uri: Icon URL
      - `protocols` object, nullable: Protocol-specific configuration
        - `oauth2` IamApplicationOAuth2Protocol, nullable: OAuth 2.0 protocol configuration
          - `redirect_uris` string[], nullable: OAuth 2.0 redirect URIs for this application
          - `post_logout_redirect_uris` string[], nullable: OAuth 2.0 post-logout redirect URIs for this application
      - `dependencies_count` integer, required: Number of resource dependencies
      - `owner_type` 'platform' | 'customer', required: Who owns this application. Platform-owned applications cannot be modified via API.
      - `consent` 'implicit' | 'required', required: Consent mode for the application. 'implicit' means consent is automatically granted, 'required' means explicit user consent is needed.
      - `created_at` string, date-time, required: Entity creation timestamp
      - `updated_at` string, date-time, required: Entity update timestamp
    - `application_type` 'native' | 'web', required: The expected type of client for this credential. Native clients must use localhost URLs for redirect_uris or URIs with custom schemes. Web clients must use https URLs and must not use localhost as the hostname.
    - `prefix` boolean, required: When true, the resource identifier is treated as a URI prefix, protecting all URLs that share the identifier as a prefix at path/query/fragment boundaries. Protocol and hostname must match exactly. When multiple prefix resources satisfy an identifier query, the resource with the longest prefix is matched.
    - `credential_lifetime_seconds` integer, nullable: Credential lifetime override in seconds. When set, overrides the default credential lifetime for this resource. When absent, the default from the provider or zone is used.
    - `when_accessing` string[]: List of resource IDs that, when accessed, make this dependency available. Only present when this resource is returned as a dependency.
    - `metadata` IamMetadata: Entity metadata
      - `docs_url` string, uri: Documentation URL
      - `icon_url` string, uri: Icon URL
    - `owner_type` 'platform' | 'customer', required: Who owns this resource. Platform-owned resources cannot be modified via API.
    - `created_at` string, date-time, required: Entity creation timestamp
    - `updated_at` string, date-time, required: Entity update timestamp
  - `pagination` IamPagination, required: Cursor-based pagination metadata
    - `after_cursor` string, required: An opaque cursor used for paginating through a list of results
    - `before_cursor` string, required: An opaque cursor used for paginating through a list of results
    - `total_count` integer: Total number of items matching the query. Only included when expand[]=total_count is requested.

## Other responses

- `400`: Default Response
- `404`: Error response

## Changes

- **2026-10-29** `0dee67e0a73a`: 1 warning, 1 info
  - changed the pattern of the `query` request parameter `sort` from `^-?(created_at|name|identifier)(,\s*-?(created_at|name|identifier))*$` to `^-?(created_at|updated_at|name|identifier)(,\s*-?(created_at|updated_at|name|identifier))*$`
  - added the new optional `query` request parameter `filter[dependency_of_application_id][ne]`
- **2026-10-16** `0cfaff865771`: 1 warning, 6 info
  - removed the optional property `items/items/credential_provider/allOf[subschema #1: Provider]/protocols/openid/external_id_claim` from the response with the `200` status
  - added the new optional `query` request parameter `filter[id]`
  - added the new optional `query` request parameter `filter[slug]`
  - added the new optional `query` request parameter `query[]`
  - …3 more
- **2026-08-26** `d65d51379d93`: 6 info
  - added the new optional `query` request parameter `filter[identifier]`
  - added the new optional `query` request parameter `filter[owner_type]`
  - added the new optional `query` request parameter `filter[traits]`
  - added the non-success response with the status `404`
  - …2 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api/changes/zones/:zoneId/resources/get.md)

---

[API](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api.md) - [All operations](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api/llms.txt) - [OpenAPI document](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api/revisions/0dee67e0a73a?raw)