Content

Groups / List

Returns all groups.

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/groups

Method: GET

Authorisation: Minimum role: USER

Name	Type	Source
filter	DTO_standard_filter	Query

Request body example

Response status: 200 (OK)

Response type: DTO_group[]

Other response statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

Name	Type	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

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

Name	Type	ReadOnly	Description
profile_pic	String	ReadOnly	Profile pic
email	String	ReadOnly	Email
id	Int32		Id
label	Object	ReadOnly	Label

Name	Type	ReadOnly	Description
id	Int32		The id of the reference
label	Object	ReadOnly	Name/Label from referenced object.

Value	Name	Description
0	ASC	ASC
1	DESC	DESC

PUT Groups / Update

GET Groups / Group_ only aggregates