Sign in

v2

latestOpenAPI 3.0.02026-07-31355176194.7 KB
v1Contacts

Retrieve a contact

get/v1/contacts/{id}

Path parameters

idnumber required

Response

idstring required
namestring

The contact’s full name or business name

emailstring

The contact’s email address

externalIdstring required
originstring required
phonestring

The contact’s phone number

locationstring required
avatarstring

Url of the contact image

facebookIdstring required
instagramIdstring required
telegramIdstring required
notesstring

The contact’s notes

isImportedboolean required
hasConversationboolean required
newContactboolean required
customFieldsobject required
isPrivateboolean

Private contacts can only be seen by users who have the permission to view private contacts

Example response

{
  "name": "João Silva",
  "email": "joaosilva@gmail.com",
  "phone": "5585997281648",
  "customFields": {
    "cpf": {
      "value": "060.715.303-54"
    }
  }
}