Skip to main content
GET
/
v1
/
tenants
List Tenants
curl --request GET \
  --url http://localhost:8000/v1/tenants
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "settings": {
        "description": "<string>",
        "timezone": "<string>"
      },
      "idp_config": {},
      "branding": {
        "brand_name": "<string>",
        "brand_color": "<string>",
        "logo_url": "<string>",
        "logo_dark_url": "<string>",
        "favicon_url": "<string>",
        "theme_overrides": {}
      }
    }
  ],
  "total": 1,
  "limit": 2,
  "offset": 1
}

Headers

​
authorization
string | null

Query Parameters

​
limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of items to skip

Required range: x >= 0

Cookies

​
ks_uat
string | null

Response

Successful Response

​
items
TenantResponse · object[]
required

List of items

​
total
integer
required

Total number of items

Required range: x >= 0
​
limit
integer
required

Number of items per page

Required range: x >= 1
​
offset
integer
required

Number of items to skip

Required range: x >= 0