Groups
Group_ only aggregates
Returns the distinct values and their counts for the group properties named in field_keys, which is what a filter input needs, and never returns group rows themselves (take is forced to 0).
Counts respect the filter passed along, while unfiltered_count on each value shows what the count would have been without it.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/groups/aggregate
- Authorisation
- Minimum role: USER
Request arguments
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_group[]
- Wrapper
- DTO_response_wrap_get_many
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_standard_filter
| Name | Type | ReadOnly | Description |
|---|
| sort_by_key | String | | Sort by key |
| 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_group
| Name | Type | ReadOnly | Description |
|---|
| group_users | DTO_reference_user[] | | Group users |
| group_admins | DTO_reference_user[] | | Group admins |
| mailboxes | DTO_reference[] | ReadOnly | Mailboxes |
| created_by | DTO_reference_user | ReadOnly | Created by |
| last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
| id | Int32 | ReadOnly | Leave empty on input |
| name | String | | Name |
| unique_key | String | | Main email key (unique_key@tenant.deskhero.com)
Used as forward address, and default group email |
| forward_to_email | String | ReadOnly | Forward to email |
| type | ENUM group_type | ReadOnly | Type |
| created | DateTime | ReadOnly | Created |
| last_updated | DateTime | ReadOnly | Last updated |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|
| profile_pic | String | ReadOnly | Profile pic |
| email | String | ReadOnly | Email |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
DTO_reference
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | | The id of the reference |
| label | Object | ReadOnly | Name/Label from referenced object. |
ENUM sort_order
| Value | Name | Description |
|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
ENUM group_type
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | CUSTOM | Custom |
| 2 | SYSTEM_EVERYONE | Sys everyone |
Generated Aug 4, 2026 18:37
