GET /v1/tenants/{product_slug}/limits — Get a Tenant's Credit Allocations

GET /v1/tenants/{product_slug}/limits returns every allocation currently set on a tenant, each with used/remaining for its own window.

Endpoint

GET https://api.knock2.ai/v1/tenants/{product_slug}/limits

Path Parameter

string

required

Your own tenant, or a direct child’s slug.

Example Request

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

Response

{
  "data": [
    {
      "type": "credits",
      "value": 100,
      "period": "lifetime",
      "is_enforced": true,
      "equivalent_credits": 100,
      "used": 4,
      "remaining": 96
    }
  ]
}

number

Always in natural units for type — contacts, accounts, or credits.

number

The same cap expressed in credits, so allocations of different types are comparable.

An empty data array means the tenant has no allocation set and is unlimited within its parent’s own pool.

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.
`404`	No tenant found with this `product_slug` under your account.
`429`	Rate limit exceeded.

Overview

Accounts

Contacts

Activity & Scores

Filter Sets

Webhooks

Enrichment & Auth

Tenants & Script

GET /v1/tenants/{product_slug}/limits — Get a Tenant's Credit Allocations

Endpoint

Path Parameter

Example Request

Response

Required Scope

Error Responses

​Endpoint

​Path Parameter

​Example Request

​Response

​Required Scope

​Error Responses

Endpoint

Path Parameter

Example Request

Response

Required Scope

Error Responses