POST /v1/tenants/list
Returns a paginated list of all tenants registered in this Permify instance.
Request Body
Number of tenants to return per page. Must be >= 1.
Pagination token from a previous response. Omit for the first page.
Response
The list of tenants.
ISO 8601 timestamp of when the tenant was created.
Pagination token for the next page. Empty when there are no more results.
Example
curl --location --request POST 'localhost:3476/v1/tenants/list' \
--header 'Content-Type: application/json' \
--data-raw '{
"page_size": 20,
"continuous_token": ""
}'
{
"page_size": 20,
"continuous_token": ""
}
{
"tenants": [
{
"id": "t1",
"name": "Default Tenant",
"created_at": "2023-01-01T00:00:00Z"
},
{
"id": "acme",
"name": "Acme Corp",
"created_at": "2024-01-15T10:30:00Z"
}
],
"continuous_token": ""
}
Error Codes
| HTTP Status | Description |
|---|
400 | Bad request |
401 | Unauthorized |
429 | Rate limit exceeded |
500 | Internal server error |
