Tenants
GET/Tenants
MCP tool
get_tenantsCore licenseReturns the tenants your API user can access. Pass a tenantId as a query parameter on any other endpoint to query that tenant's data. Without it, requests use your user's main tenant.
Most integrations only have access to one tenant and never need this endpoint. See Core concepts.
Parameters
None.
Example request
Response
| Field | Type | Description |
|---|---|---|
tenantId | string | Tenant identifier. Pass it as the tenantId query parameter on other endpoints. |
tenantName | string | Name of the tenant. |
tenantUrl | string | URL of the tenant. |
Querying another tenant
Add tenantId to any other request. Client ids are specific to each tenant, so call /Clients with the same tenantId first.
The match on tenantId is case-insensitive. A tenant your user cannot access returns 400 with "The user does not have access to this tenant or the tenant does not exist."
Errors
Only the common 401 and 429 responses. See Errors.