Organizations / List
List all organizations
Route: /api/sys/v{version:apiVersion}/organizations
Method: GET
Authorisation: Minimum role: ADMIN
Request Arguments
| Name | Type | Source |
|---|---|---|
| filter | DTO_standard_filter | Query |
| include_inactive | Boolean | Query |
| only_inactive | Boolean | Query |
Request body example
Response object
Response status: 200 (OK)
Response type: DTO_tenant[]
Wrapper: DTO_response_wrap_get_many
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_standard_filter
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| channel | String | Channel | |
| sort_by_key | String | Sort by key | |
| brand_ids | Int32[] | Brand ids | |
| response_field_keys | String[] | Only return the fields specified | |
| filters | String[] | Each string needs to be structured: filters=field_key:operator:value1|value2|value3 Only used to store filters for passing along as querystring | |
| include_aggregations | Boolean | Include aggregations | |
| include_imported | Boolean | Include imported | |
| search | String | Search | |
| sort_order | ENUM sort_order | Sort order | |
| take | Int32 | Take | |
| page | Int32 | Page |
DTO_tenant
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| language | DTO_translation_language | Language | |
| mailboxes | DTO_reference_mailbox[] | Mailboxes | |
| tenant_users | DTO_reference_user[] | Tenant users | |
| 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 | |
| current_user_role | tenant_user_role (nullable) | ReadOnly | The current user's effective tenant role on this tenant. SUPER_ADMIN users are projected as OWNER. |
| is_active | Boolean | ReadOnly | Is active |
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 |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| profile_pic | String | ReadOnly | Profile pic |
| String | ReadOnly | ||
| role_enum_id | tenant_user_role (nullable) | Role enum id | |
| 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 | 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 sort_order
| Value | Name | Description |
|---|---|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
ENUM tenant_plan
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | FREE | FREE |
| 2 | SMALL | SMALL |
| 3 | MEDIUM | MEDIUM |
| 4 | LARGE | LARGE |
