List your contacts
Retrieves your list of contacts (yours and those shared with you). The maximum number of rows returned is set by the parameter <em>limit_count</em> (limited to 500 rows). All parameters are optional. If the "search" parameter is filled, results are sorted by relevance (according to how good the match is). Note: If a contact has an emoji in their firstname, lastname, and/or company, it will not be displayed in the response body.
Permission: Contacts Read required.
Monitoring: No impact.
Query parameters
[Deprecated] The character sequence assigned to pages in address book. Possible values are: 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '#' for any digit and '.' for any other characters. An empty value disables pagination. The pagination is based on the lastname by default, you can paginate by firstname or company name by combining the 'pagination' and 'alphabetical_order' fields.
[Deprecated] Alphabetical order impacts the pagination value. Possible values are : FirstnameLastnameCompanyDESC, FirstnameLastnameCompanyASC, LastnameFirstnameCompanyDESC, LastnameFirstnameCompanyASC, CompanyFirstnameLastnameDESC, CompanyFirstnameLastnameASC ,CompanyLastnameFirstnameDESC, CompanyLastnameFirstnameASC. Values all respect the format 'Field1Field2Field3ORDER' where 'Field1' will be the field the pagination is based on and 'ORDER' the order of the result (Ascending or Descending)
The keyword is used to search a specific contact. Index is based on firstname, lastname, company and phone number(s)
Maximum number of results to return per page. Default: server-defined.
Number of results to skip for pagination. Default: 0.
Response
Successful operation — the contact list is returned.
Example response
{
"list_count": 1,
"user_id": 123456,
"team_id": 123456,
"limit_count_setted": 1,
"contact_list_count": 1,
"contact_list": [
{
"contact_id": 654321,
"is_shared": true,
"im_owner": true,
"firstname": "John",
"lastname": "Doe",
"company": "DoeCompany",
"concat_name": "John Doe",
"color": "3CC8C8",
"initial": "JD",
"profile_picture": "default.jpg",
"creation_date": "2018-06-12T23:23:40.99Z",
"numbers": [
{
"number": 33184800000,
"type": "PHONE",
"format": {
"raw": 184800000,
"country_code": "33",
"country": "FR",
"e164": "+33184800000",
"international": "+33 1 84 80 00 00",
"international_alt": "33184800000",
"national": "01 84 80 00 00",
"national_alt": "0184800000",
"rfc3966": "tel:+33-1-84-80-00-00"
}
}
]
}
]
}