v1

latestOpenAPI 3.0.12026-07-2490182120.3 KB
groups
companies

List Group Availability

List the users in the group that have a certain availability status

get/v1/companies/{company_code_or_sid}/groups/{group_name}/availability

Path parameters

company_code_or_sidstring required
group_namestring required

Query parameters

status'AVAILABILITY_STATUS_AVAILABLE' | 'AVAILABILITY_STATUS_NOT_AVAILABLE' | 'AVAILABILITY_STATUS_RESERVED' | 'AVAILABILITY_STATUS_IN_CALL' | 'AVAILABILITY_STATUS_CONFIRMING' | 'AVAILABILITY_STATUS_OFFLINE' | 'AVAILABILITY_STATUS_INVALID'
page_sizeinteger
page_tokenstring

Response

Availability retrieved successfully.

company_code_or_sidstring
group_namestring
status'AVAILABILITY_STATUS_AVAILABLE' | 'AVAILABILITY_STATUS_NOT_AVAILABLE' | 'AVAILABILITY_STATUS_RESERVED' | 'AVAILABILITY_STATUS_IN_CALL' | 'AVAILABILITY_STATUS_CONFIRMING' | 'AVAILABILITY_STATUS_OFFLINE' | 'AVAILABILITY_STATUS_INVALID'
page_tokenstring
page_sizestring