KEkeycardai
Zones

List zones

Changed on

Returns a list of zones for the authenticated organization. Cursor pagination via after/before and limit, plus expand[]=total_count, name substring search, and sort, are supported on every request. filter[permission][in] narrows the list to zones where the caller holds at least one of the given permissions.

get/zones

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

Query parameters

slugstring
cursorstring
afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count' | 'permissions'
OR
string[]
filter[organization_id]string
string
OR
string[]

Only return zones where the caller is allowed ANY of these permissions (<resource_type>:<action>, e.g. applications:list). Repeatable (one permission per occurrence); values are unioned, max 20 (a stricter cap than the authorization service's 50). The accessible zone set is resolved by the authorization service and composes with cursor pagination, search, sort and expand[]=total_count. Malformed values are a 400.

Response

Default Response

Example response

{
  "items": [
    {
      "permissions": {
        "zones": {
          "read": true,
          "update": true,
          "delete": false,
          "create": false
        },
        "applications": {
          "read": true,
          "list": true,
          "create": false
        }
      }
    }
  ]
}

Changes

  • 0dee67e0a73aRevision changes
    • warning

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

    • info

      added the new optional query request parameter filter[permission][in]

  • 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

    • info

      added to the response property allOf list for the response status

    • info

      response property page_info deprecated

    • info

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