Retrieve or create contacts
This endpoint serves two purposes depending on the request body: send a <b>contact_filter</b> object to retrieve contacts (yours and those shared with you), or a <b>contact_creation</b> object to create new ones. Only one parameter must be sent. When creating contacts, each contact is automatically assigned to the user associated with the API key used for the request. You can create up to 50 contacts at once. When retrieving contacts, the maximum number of contacts returned is defined by the <em>limit_count</em> variable (limited to 500 contacts). If the "search" parameter is filled, results are sorted by relevance (based on how well they match). Note: If you create a contact with an emoji in the firstname, lastname, or company fields, it will work but the emoji will not be displayed in the response body when retrieving the contact.
Permission: Contacts Write required when creating contacts. Contacts Read is sufficient for retrieval.
Monitoring: No impact.
Request body
Example request
{
"pagination": "a",
"alphabetical_order": "LastnameFirstnameCompanyASC",
"search": "Pierre De Test",
"limit_count": 10,
"limit_offset": 10
}Response
Successful operation — the filtered 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"
}
}
]
}
]
}