Tenants
List Tenants
List all tenants with cursor-based pagination.
When self-hosting this endpoint requires Redis with RediSearch module (e.g., redis/redis-stack-server). If RediSearch is not available, this endpoint returns 501 Not Implemented.
When authenticated with a Tenant JWT, returns only the authenticated tenant.
get/tenants
Query parameters
Filter tenants by ID(s). Use bracket notation for multiple values (e.g., id[0]=t1&id[1]=t2 or id[]=t1&id[]=t2).
limitinteger
Number of tenants to return per page (1-100, default 20).
dir'asc' | 'desc'
Sort direction.
nextstring
Cursor for the next page of results. Mutually exclusive with prev.
prevstring
Cursor for the previous page of results. Mutually exclusive with next.
Response
List of tenants.
Example response
{
"models": [
{
"id": "123",
"destinations_count": 5,
"topics": [
"user.created",
"user.deleted"
],
"metadata": {
"name": "Acme Inc."
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"pagination": {
"order_by": "created_at",
"dir": "desc",
"limit": 100,
"next": "MTcwNDA2NzIwMA=="
},
"count": 42
}