GET
/
api
/
v1
/
tenants
/
{tenant_id}
{
  "name": "<string>",
  "slug": "<string>",
  "is_active": true,
  "scim_enabled": true,
  "scim_api_key": "<string>",
  "scim_base_url": "<string>",
  "id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "scim_api_key_unhashed": "<string>"
}

Retrieve a tenant’s information by its tenant ID.

  • Method: GET
  • Path: /api/v1/tenants/{tenant_id}

​
Path Parameter

  • tenant_id (integer, required): The ID of the tenant

​
Response

Returns a Tenant object.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
tenant_id
integer
required

Response

200
application/json

Successful Response

The response is of type object.