Tenants
List
Returns the tenants the signed in user belongs to, each with its user count.
GET
/api/sys/v{version:apiVersion}/tenants
- Authorisation
- Minimum role: USER
Request arguments
Request body example
No input arguments
Response
- Status
- 200 (OK)
- Type
- DTO_tenant[]
- Wrapper
- DTO_response_wrap
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_tenant
| Name | Type | ReadOnly | Description |
|---|
| language | DTO_translation_language | | Language |
| mailboxes | DTO_reference_mailbox[] | | Mailboxes |
| id | Int32 | ReadOnly | Id |
| friendly_name | String | | Friendly name |
| unique_name | String | | Unique name |
| fqdn | String | ReadOnly | Fqdn |
| created | DateTime | | Created |
| user_count | Int32 | ReadOnly | User count |
| logo | String | ReadOnly | Logo |
| plan | ENUM tenant_plan | ReadOnly | Plan |
| expired_trial | Boolean | ReadOnly | Expired trial |
| time_zone | String | | Time zone |
DTO_translation_language
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | ReadOnly | Leave empty on input |
| name | String | | Name |
| code | String | | Code |
| icon | String | ReadOnly | Icon |
| icon_sqare | String | ReadOnly | Icon sqare |
DTO_reference_mailbox
| Name | Type | ReadOnly | Description |
|---|
| type | ENUM mailbox_type | ReadOnly | Type |
| status | ENUM mailbox_status | ReadOnly | Status |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
ENUM mailbox_type
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | PLATFORM_PROVIDED | Built in @tenant.deskhero.com |
| 2 | DNS | DNS setup / Custom Email domain |
| 3 | MICROSOFT | Auth2 Microsoft365 provided |
| 4 | GOOGLE | Auth2 Google provided |
ENUM mailbox_status
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | ACTIVE | ACTIVE |
| 2 | ACTIVATION_IN_PROGRESS | ACTIVATION_IN_PROGRESS |
| 101 | REQUIRE_REAUTH | REQUIRE_REAUTH |
| 102 | REQUIRE_FORWARD | REQUIRE_FORWARD |
ENUM tenant_plan
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | FREE | FREE |
| 2 | SMALL | SMALL |
| 3 | MEDIUM | MEDIUM |
| 4 | LARGE | LARGE |
Generated Aug 4, 2026 18:37
