Semaphor

List tenants

Returns all tenants in your organization, including each tenant's default owner, calendar preferences, and user count. Use the search parameter for case-insensitive filtering by tenant name.

GET
/api/management/v1/tenants

Authorization

BearerAuth
AuthorizationBearer <token>

A project-scoped access token. Generate one via the Token API with your project ID and project secret.

In: header

Query Parameters

search?string

Case-insensitive filter applied to tenant names.

limit?integer

Maximum number of tenants to return.

Default500
Range1 <= value <= 1000
offset?integer

Number of tenants to skip for pagination.

Default0
Range0 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X get "https://semaphor.cloud/api/management/v1/tenants"
{
  "tenants": [
    {
      "id": "string",
      "name": "string",
      "organizationId": "string",
      "organization": {
        "id": "string",
        "name": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "defaultOwnerId": "string",
      "defaultOwner": {
        "name": "string",
        "email": "user@example.com"
      },
      "defaultCalendarContext": {
        "tz": "string",
        "weekStart": 0
      },
      "userCount": 0
    }
  ],
  "total": 0,
  "message": "string",
  "code": "string"
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}