TenantService
Tenants
List tenants
Lists the tenants asserted in a workspace, newest first. query matches against a tenant's name and its external_id, for type-ahead filters.
get/v1/workspaces/{workspaceId}/tenants
Path parameters
workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q
Workspace ID.
Query parameters
limitinteger
Maximum number of results to return.
cursorstring
Pagination cursor from previous response.
querystring
Substring match against the tenant's name and external_id. Built for type-ahead filter pickers, where the operator knows the customer's own identifier rather than Cadenya's.
labelsstring
Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).
sortOrderstring
Sort order for results (asc or desc by creation time).
includeInfoboolean
When true, the info field on each returned tenant is populated. This costs several count queries per tenant, so it is off by default.
Response
OK
Example response
{
"items": [
{
"metadata": {
"accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
"workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
"profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
}
}
]
}