Get a contact by ID

Retrieves a single contact by its unique identifier.

GET
/v1/contacts/{id}

Authorization

apiKeyAuth
x-api-key<token>

API key authentication. Create an API key in your user profile and include it in the x-api-key header.

In: header

Path Parameters

id*string

Which contact to address. Must be ONE of: the contact's UUID (e.g. '3fa85f64-5717-4562-b3fc-2c963f66afa6'); an email address (e.g. 'jane@example.com', matched across mail/Google/Outlook); a phone number (e.g. '+491234567890', matched across WhatsApp/Telegram); or 'provider:value' for a messaging handle where provider is one of linkedin, telegram, instagram (e.g. 'linkedin:john-doe', 'telegram:jdoe', 'instagram:jane'). The contact must already exist; unknown or malformed keys are rejected.

Length1 <= length <= 400

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/v1/contacts/string"
{
  "contact": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "firstName": "string",
    "lastName": "string",
    "avatarUrl": "string",
    "notes": {},
    "identifiers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "provider": "google",
        "value": "string",
        "messagingId": "string",
        "displayName": "string",
        "profileUrl": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string",
    "organizations": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    ],
    "users": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "avatarUrl": "string",
        "email": "user@example.com"
      }
    ],
    "deals": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    ],
    "tasks": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "type": "userPendingAuthorization"
      }
    ],
    "customFieldValues": [
      {
        "columnId": "b0676e1a-d8a0-4c5f-99e7-a0ee8909f6dd",
        "value": "string"
      }
    ]
  },
  "customColumns": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "label": "string",
      "entityType": "contact",
      "type": "plain"
    }
  ]
}
"string"
"string"
"string"
"string"