Skip to main content
GET
/
api
/
v1
/
tenants
Get all tenants for current workspace (only allowed for default tenant)
curl --request GET \
  --url https://api.example.com/api/v1/tenants \
  --header 'x-calry-api-key: <api-key>'
[
  {
    "id": "<string>",
    "domain": "<string>",
    "name": "<string>",
    "workspaceID": "<string>",
    "isDefault": true,
    "status": "ACTIVE",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-calry-api-key
string
header
required

Headers

​
x-calry-tenant-id
string

Optional tenant ID to specify which tenant to operate as. If not provided, the default tenant will be used.

Response

List of tenants

​
id
string
required
​
domain
string
required
​
name
string
required
​
workspaceID
string
required
​
isDefault
boolean
required
​
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required