Tenants

List tenants

Changed on

Returns a paginated list of tenants.

Supports Flop pagination and filtering:

  • page - Page number (1-indexed, default: 1)
  • page_size - Items per page (default: 20, max: 100)
  • order_by - Field to sort by (name, slug, status, inserted_at, updated_at)
  • order_directions - Sort direction (asc or desc)

Results are scoped to the authenticated tenant.

get/api/tenants

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/tenants
  • Auth: none required

Query parameters

pageinteger

Page number (1-indexed)

page_sizeinteger

Items per page (max: 100)

order_bystring

Field to sort by

order_directionsstring

Sort direction (asc or desc)

Response

Tenant list

Example response

{
  "data": [
    {
      "enabled_regimes": [
        ""
      ],
      "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "inserted_at": "2020-04-20T16:20:00Z",
      "metadata": {},
      "name": "",
      "slug": "",
      "status": "active",
      "tenant_type": "platform",
      "updated_at": "2020-04-20T16:20:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 50,
    "total_count": 125,
    "total_pages": 3
  }
}

Changes