latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

contacts

Get a specific contact

Retrieves all data and phone numbers for a specific contact by their identifier.

Permission: Contacts Read required.

Monitoring: No impact.

get/contacts/{contactId}

Path parameters

contactIdinteger required
Example:123456

The identifier of the contact

Response

Successful operation — the contact details are returned.

contact_idinteger
is_sharedboolean
im_ownerboolean
social_servicestring nullable
social_service_idstring nullable
social_profile_urlstring nullable
social_datastring nullable
firstnamestring
lastnamestring
companystring
concat_namestring
colorstring
initialstring
profile_picturestring
creation_datestring date-time

Example response

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