GET
/
api
/
v1
/
tenants
/
[
  {
    "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 list of tenants in the system.

  • Method: GET
  • Path: /api/v1/tenants/

​
Query Parameters

  • skip (integer, optional): Number of records to skip
  • limit (integer, optional): Maximum number of records to return

​
Response

Returns an array of Tenant objects.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
skip
integer
default:0
​
limit
integer
default:100

Response

200
application/json

Successful Response

The response is of type Tenant · object[].