#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.tech/v1/contacts/71" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth app

Terminal 
curl "https://vibecode.bitrix24.tech/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.tech/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.tech/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": "Ivan",
    "lastName": "Petrov",
    "companyId": 1,
    "assignedById": 1,
    "sourceId": "WEB",
    "typeId": "CLIENT",
    "createdTime": "2020-05-08T10:48:20+03:00",
    "updatedTime": "2025-08-22T13:01:31+03:00"
  }
}

#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