Retrieves a list of contact groups from the address book

Method	`get.group_contacts`
Description	Retrieves a list of contact groups from the address book
Who has access	Agents and clients

Request parameters

Name	Type	Required	Description
`access_token`	string	yes	Session key used to authenticate the request
`user_id`	number	no	Unique ID of the client user on whose behalf the request is made. Required when an agent makes the request. To retrieve a list of client users, call "get.customer_users".
`limit`	number	no	Maximum number of records to return. See the "Paging" section.
`offset`	number	no	Number of records to skip before returning results. Default: 0. See the "Paging" section.
`filter`	object	no	Filtering criteria. See the "Filters" section.
`fields`	array	no	Fields to include in the response. See the "Viewing returned data" section.
`sort`	array	no	Sorting criteria. See the "Data sorting" section.

Response parameters

Name	Type	Filtering	Sorting	Description
`id`	number	yes		Unique contact group ID
`name`	string	yes	yes	Contact group name
`is_system`	boolean	yes		Indicates whether the group is system-defined and cannot be deleted
Group members
`members`	array	yes		Contacts included in the group
`contact_id`	number			Unique contact ID. See `get.contacts`.
`contact_full_name`	string			Contact's full name

Example request

{
  "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"
    ]
  }
}

Example response

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{
    },
    "data":[
      {
        "id":"number",
        "name":"string",
        "is_system":"boolean",
        "members":[
          {
            "contact_id":"number",
            "contact_full_name":"string"
          }
        ]
      }
    ]
  }
}

List of returned errors

See the "List of errors for get methods" section.