Retrieving a list of address book contact groups
| Method | get.group_contacts |
|---|---|
| Description | Getting a list of address book contact groups |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the client agent on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering criteria" |
fields |
array | no | See section "View of returned data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Name | Type | Valid values | Filtering | Sorting | Description |
|---|---|---|---|---|---|
id |
number | yes | Unique identifier of the address contact group books | ||
name |
string | yes | yes | Contact group name | |
is_system |
boolean | yes | Indication that the group is system and cannot be deleted | ||
| List of contacts included in the group | |||||
members |
array | yes | List of unique contact identifiers that are part of the group. | ||
contact_id |
number | Unique contact identifier, see method "get.contacts" |
|||
contact_full_name |
string | Last name First name Middle name of contact | |||
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"get.group_contacts", "params":{ "access_token":"string", "user_id":"number", "offset":"number", "limit":"number", "filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
} }
### JSON response structure```json
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"metadata":{
},
"data":[
{
"id":"number",
"name":"string",
"is_system":"boolean",
"members":[
{
"contacts_id":"number",
"contact_full_name":"string"
}
]
}
]
}
}
List of returned errors
See the section "List of errors for methods with the verb get"