GET /v1/tenants — List Your Child Tenants

GET /v1/tenants lists the calling key’s direct child tenants, each with its current allocation set and per-limit usage/remaining. Use this to build a partner-facing dashboard of your provisioned workspaces without querying each tenant individually.

Endpoint

GET https://api.knock2.ai/v1/tenants

Query Parameters

integer

default:"50"

Number of tenants to return. Minimum 1, maximum 100.

string

Opaque cursor from a previous response’s next_cursor. Omit on the first request.

Example Request

curl https://api.knock2.ai/v1/tenants \
  -H "Authorization: Bearer YOUR_PARENT_API_KEY"

Response

{
  "data": [
    {
      "product_slug": "acme_com_yourco_com",
      "name": "Acme Corp",
      "domain": "acme.com",
      "is_active": true,
      "billing_mode": "parent",
      "limits": [
        {
          "type": "credits",
          "value": 100,
          "period": "lifetime",
          "is_enforced": true,
          "equivalent_credits": 100,
          "used": 4,
          "remaining": 96
        }
      ]
    }
  ],
  "next_cursor": null,
  "has_more": false,
  "allocated_total_credits": 100,
  "plan_credits": 5000
}

array

Every allocation currently set on this tenant, each with used/remaining for its window. Empty when the tenant has no allocation (unlimited within your own pool).

number

The sum of every child’s credits-type allocation across all your children (not just this page), counting only allocations with is_enforced: true — a non-enforced allocation, or a contacts/accounts-type allocation, isn’t included here; read those from each tenant’s own limits.

number | null

Your own plan’s credit limit, so you can compare against allocated_total_credits and see your overbooking ratio. Over-allocating across children is allowed by design.

Required Scope

Requires tenants:read.

Error Responses

Status	Meaning
`401`	Missing or invalid API key.
`403`	Your API key does not have the `tenants:read` scope.
`429`	Rate limit exceeded.

Overview

Accounts

Contacts

Activity & Scores

Filter Sets

Webhooks

Enrichment & Auth

Tenants & Script

GET /v1/tenants — List Your Child Tenants

Endpoint

Query Parameters

Example Request

Response

Required Scope

Error Responses

​Endpoint

​Query Parameters

​Example Request

​Response

​Required Scope

​Error Responses

Endpoint

Query Parameters

Example Request

Response

Required Scope

Error Responses