KEkeycardai
Providers

List providers

Changed on

Returns a paginated list of providers in the specified zone. Use cursor pagination via after/before. Sort: comma-separated field list; prefix with - for descending. Use expand[]=total_count to include the matching row count. Filter by exact slug via filter[slug], exact identifier via filter[identifier] and provider type via filter[type]. Search via query[name] / query[identifier] / query[] (substring match, OR'd across repeated values). query[] matches against name and identifier. Pass filter[id] (repeatable, max 100) to restrict results to a known set of provider IDs — mutually exclusive with after/before (returns 400 if combined). When filter[id] is set, limit is ignored and the response contains every requested provider that exists in the zone, in a single page. Unknown or malformed IDs are silently omitted.

get/zones/{zoneId}/providers

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}/providers
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

Path parameters

zoneIdstring required

Query parameters

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count'
OR
string[]
slugstring
identifierstring
type'external' | 'keycard-vault' | 'keycard-sts'
string

Filter by exact provider slug

OR
string[]
string

Filter by exact provider identifier

OR
string[]
'external' | 'keycard-vault' | 'keycard-sts'

Filter by provider type

OR
string[]
string

Restrict results to providers with this ID. Repeatable, max 100. Mutually exclusive with after/before.

OR
string[]
string

Search by name (substring match)

OR
string[]
string

Search by identifier (substring match)

OR
string[]
string

Search across name and identifier (substring match)

OR
string[]
sortstring

Comma-separated sort fields. Prefix with - for descending. Allowed: created_at, name, identifier

cursorstring

Response

Default Response

Changes

  • 0cfaff865771Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter filter[identifier]

    • info

      added the new optional query request parameter filter[slug]

    • info

      added the new optional query request parameter filter[type]

    • info

      added the new optional query request parameter query[]

    • info

      added the new optional query request parameter query[identifier]

    • info

      added the new optional query request parameter query[name]

    • info

      added the new optional query request parameter sort

    • info

      added the non-success response with the status

    • info

      added to the response property allOf list for the response status

    • info

      response property page_info deprecated

  • d65d51379d93Revision changes
    • info

      added the new optional query request parameter filter[id]

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status