For AI agents: markdown of this page — /docs-content-en/entities/contacts/get.md documentation index — /llms.txt

Get contact

GET /v1/contacts/:id

Returns a contact by ID with all fields.

Parameters

Parameter Type Required Description
id (path) number yes Contact ID

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/contacts/71" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth app

Terminal 
curl "https://vibecode.bitrix24.com/v1/contacts/71" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/contacts/71', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Contact:', data.name, data.lastName)
console.log('Retrieved:', data.id)

JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/contacts/71', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

More about include: Related data.

Response fields

The contact object with all fields — see Contact fields.

(include)

Retrieve related entities together with the contact — the include parameter in the GET request:

GET /v1/contacts/71?include=company

Available includes: company, requisite. Result in the _included field.

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 71,
    "name": "John",
    "lastName": "Brown",
    "companyId": 1,
    "assignedById": 1,
    "sourceId": "WEB",
    "typeId": "CLIENT",
    "phone": "+12025550123",
    "phoneWork": "+12025550123",
    "email": "info@example.com",
    "emailWork": "info@example.com",
    "emailHome": "home@example.com",
    "hasPhone": true,
    "hasEmail": true,
    "fm": [
      { "id": 41, "typeId": "PHONE", "valueType": "WORK", "value": "+12025550123" },
      { "id": 43, "typeId": "EMAIL", "valueType": "WORK", "value": "info@example.com" },
      { "id": 45, "typeId": "EMAIL", "valueType": "HOME", "value": "home@example.com" }
    ],
    "createdTime": "2020-05-08T10:48:20+00:00",
    "updatedTime": "2025-08-22T13:01:31+00:00"
  }
}

Phone and email in the response are strings with the primary value, and per-type values are in the phoneWork, phoneMobile, emailWork, emailHome fields. The full list with types is in the fm[] array ({ id, typeId, valueType, value }, where id is the entry identifier). Check presence via hasPhone/hasEmail: when there is no phone, phone comes back as an empty string. A specific fm[] entry cannot be modified or removed by its id through the API — PATCH adds new records.

Error response example

404 — contact not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Item not found"
  }
}

Errors

HTTP Code Description
404 ENTITY_NOT_FOUND Contact not found
403 ACCESS_DENIED No access to the contact
403 SCOPE_DENIED API key lacks the crm scope
401 TOKEN_MISSING API key has no configured tokens

Full list of common API errors — Errors.

See also