Documentation | Tenants › List Tenants

API Reference

Tenants

tenants

Methods

Delete A Tenant -> string

delete/v1/tenants/{tenant_id}

Delete a tenant

Get A Tenant ->

Tenant

get/v1/tenants/{tenant_id}

Get a tenant

List Tenants -> EntriesCursor<

Tenant

get/v1/tenants

List tenants

Parameters

after: string

Optional

The cursor to fetch entries after

before: string

Optional

The cursor to fetch entries before

page_size: number

Optional

The page size to fetch

Response fields

entries: Array<

Tenant

The list of tenants

page_info: { __typename, page_size, after, 1 more... }

The information about a paginated result

Request example

curl https://api.knock.app/v1/tenants \
    -H "Authorization: Bearer $KNOCK_API_KEY"

200Example

{
  "entries": [
    {
      "id": "tenant_123",
      "__typename": "Tenant"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "page_size": 25,
    "after": null,
    "before": null
  }
}

Set A Tenant ->

Tenant

put/v1/tenants/{tenant_id}

Set a tenant

Domain types

InlineTenantRequest = string |

TenantRequest

An inline tenant request

Tenant = { id, __typename }

A tenant entity

TenantRequest = { id, channel_data, preferences, 1 more... }

A tenant to be set in the system

Tenants

Bulk

tenants.bulk

Methods

Bulk Delete Tenants ->

BulkOperation

post/v1/tenants/bulk/delete

Bulk delete tenants

Bulk Set Tenants ->

BulkOperation

post/v1/tenants/bulk/set

Bulk set tenants