Tenants

List tenants

Changed on Aug 13, 2026

List tenants for the current environment.

get/v1/tenants

Request

Base URL: https://api.knock.app
URL: https://api.knock.app/v1/tenants
Auth: HTTP bearer

Query parameters

tenant_idstring

Filter tenants by ID.

namestring

Filter tenants by name.

afterstring

The cursor to fetch entries after.

beforestring

The cursor to fetch entries before.

page_sizeinteger

The number of items per page (defaults to 50).

Response

Example response

{
  "entries": [
    {
      "__typename": "Tenant",
      "id": "tenant_jp123",
      "name": "Jurassic Park",
      "settings": {
        "branding": {
          "dark_icon_url": "https://example.com/trex_silhouette_icon_dark.png",
          "dark_logo_url": "https://example.com/amber_fossil_logo_dark.png",
          "dark_primary_color": "#FFFFFF",
          "dark_primary_color_contrast": "#000000",
          "icon_url": "https://example.com/trex_silhouette_icon.png",
          "logo_url": "https://example.com/amber_fossil_logo.png",
          "primary_color": "#DF1A22",
          "primary_color_contrast": "#FFDE00"
        },
        "preference_set": {
          "categories": {
            "safety": {
              "channel_types": {
                "email": true,
                "push": true
              }
            }
          },
          "channel_types": {
            "email": true,
            "in_app_feed": true,
            "push": true
          },
          "id": "default",
          "workflows": {
            "park_alert": {
              "channel_types": {
                "email": true,
                "push": true
              }
            }
          }
        }
      }
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "after": null,
    "before": null,
    "page_size": 25
  }
}

Changes

Aug 13, 2026fcba175ebc76 Revision changes
- breaking
  the ///// response's property type changed from boolean to no type for status
- info
  added subschema #1 subschema #3 to the ///// response property anyOf list for the response status
Jul 14, 2026de4604427056 Revision changes
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////////// response property for the response status
- warning
  added the new not_contains_all enum value to the /////////// response property for the response status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status

Operation history (5 revisions)