Sign in

v1

latestSwagger 2.02026-08-06114161439.7 KB
group

List of all groups and associated users belonging to each group

Retrieves organizational groups with associated user information. Returns groups accessible to the authenticated user along with user assignments for each group. Supports pagination and filtering.

get/group/list

Query parameters

limitinteger

Maximum number of records to return per page. Integer, default 100, max 2000, min 1.

offsetinteger

Number of records to skip from the start of the result set. Integer, default 0, max 100000, min 0. Use with limit for pagination.

filterstring[]

URL-encoded comma-separated list of filter conditions in the form '<field> <op> <value>' where op is one of =, !=, <=, >=, >, <, like (spaces required around 'like'). Example: 'call_started > 2024-01-01'. Max 10 conditions. Filterable fields vary by endpoint.

Response

Groups with associated user assignments

group_idinteger

Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.

group_ext_idstring

A user defined external identifier for the group. Type: string.

group_namestring required

Human-readable name of the organization unit/group. String.

group_parent_idinteger

The unique ID for the group that would be a parent to the current group. Type: integer (int32).

top_group_idinteger

The unique ID for the top level group associated with current group. Type: integer (int32).

billing_idinteger

The unique ID for the group that is the billing node. Type: integer (int32).

addressstring

Caller's street address. String.

citystring

Caller's city (from caller-ID/location lookup). String.

statestring

Caller's state (from caller-ID/location lookup). String (two-letter US state code).

zipstring

The zip code for the group. Type: string.

phone_numberstring

Phone number as a string of digits. Typically 10 digits for US numbers.

group_createdstring date

The date and time when the group was created. Type: string (date).

group_modifiedstring date-time

The date and time when the group was last updated. Type: string (date-time).

industry_idinteger

The unique identifier for the industry selected. Type: integer (int32).

industry_namestring

The name of the industry selected. Type: string.