Outpost logoOutpost Docs

Get a paginated list of tenants

GET
/v1/tenants
x-api-key<token>

Project-scoped API key. Keys carry either the ADMIN or TENANT role; a route additionally requires that the key's role is listed in its x-required-roles. Machine-to-machine callers should use this.

In: header

Query Parameters

limit?string
Default"20"
cursor?string
status?string

Value in

  • "active"
  • "disabled"
search?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/tenants"
{  "data": [    {      "tenantId": "string",      "name": "string",      "status": "active",      "projectCount": 0,      "createdAt": 0,      "updatedAt": 0    }  ],  "cursor": "string",  "hasMore": true}