Combined contacts (combined_contacts)

Requests

HTTP verb Endpoint Description

GET

/rest/v1/addressbook/combined_contacts

Getting the list of combined contacts

Getting the list of combined contacts

Returns contact data representations, combining contacts and contact groups into one list. Group numbers are special values used by the system to expand a group into the set of contacts it contains.

Used in applications that select from a common contact list, for example in the selector meeting management application and service.

Returns the entire volume of contacts and groups. Groups are always first. By default returns no more than 1000 records unless otherwise specified in the limit parameter.

Each resource contains the following fields, mapped to fields of contact and contactgroup objects:

Resource field contact field contactgroup field

id

id

id

key

autokey

code

type

contact

contactgroup

name

displayname

name

number

number

group#<code>

Request

Table 1. Request parameters
Name Type Description

filter

object

filter by field values: id, key, name, number.

offset

int

offset in the list of resources to output.

limit

int

maximum number of resources in the list.

Example request
GET /rest/v1/addressbook/combined_contacts?offset=0&limit=2 HTTP/1.1

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "6f789596-0169-5710-017f-1c1b0d69174c",
    "key": "abc",
    "type": "contactgroup",
    "name": "ABC",
    "number": "group#abc"
  },
  {
    "id": "7b371f10-016a-0187-74fc-1c1b0d69174c",
    "type": "contact",
    "key": 1839,
    "name": "ABC",
    "number": "51515151"
  }
]