KEkeycardai
Applications

List applications

Changed on

Returns a paginated list of applications 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] and by exact identifier via filter[identifier]. 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 applications — mutually exclusive with after/before (returns 400 if combined). When filter[id] is set, limit is ignored and the response contains every requested application that exists in the zone, in a single page. IDs not in the zone are silently omitted.

get/zones/{zoneId}/applications

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}/applications
  • 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[]
string

Filter by exact application slug

OR
string[]
string

Filter by exact application identifier

OR
string[]
string

Restrict results to applications with this publicId. Repeatable, max 100. Mutually exclusive with after/before.

OR
string[]
filter[owner_type]'platform' | 'customer'

Filter by owner type: platform (Keycard-managed) or customer (org-created).

filter[owner_type][ne]'platform' | 'customer'

Exclude applications with this owner type, e.g. filter[owner_type][ne]=platform returns only org-created applications.

slugstring
identifierstring
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

Response

Default Response

Changes

  • 0dee67e0a73aRevision changes
    • info

      added the new optional query request parameter filter[owner_type]

    • info

      added the new optional query request parameter filter[owner_type][ne]

  • d65d51379d93Revision changes
    • warning

      deleted the query request parameter traits[]

    • warning

      deleted the query request parameter traits[all]

    • info

      added the non-success response with the status