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

Get lead

GET /v1/leads/:id

Returns a lead by ID with all fields.

Parameters

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

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/leads/42" \
  -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/leads/42', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Lead:', data.title, '— status:', data.stageId)

JavaScript — OAuth application

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

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

Response fields

The lead object with all fields — see Lead fields.

Request with related entities — the include parameter:

GET /v1/leads/5001?include=contact,company

Available includes: contact, company. The result is in the _included field. More about includes: Related data.

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 42,
    "title": "Website request #42",
    "name": "John",
    "lastName": "Smith",
    "secondName": "Michael",
    "stageId": "NEW",
    "companyTitle": "Acme LLC",
    "companyId": 15,
    "contactId": 71,
    "opportunity": 150000,
    "currencyId": "USD",
    "sourceId": "WEB",
    "sourceDescription": "Feedback form",
    "assignedById": 1,
    "createdBy": 1,
    "opened": true,
    "comments": "Call after 14:00",
    "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": "2026-04-10T14:30:00+00:00",
    "updatedTime": "2026-04-12T09:15:00+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 — lead not found:

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

Errors

HTTP Code Description
404 ENTITY_NOT_FOUND Lead not found
403 ACCESS_DENIED No access to the lead
403 SCOPE_DENIED The API key does not have the crm scope
401 TOKEN_MISSING The API key has no configured tokens

Full list of common API errors — Errors.

See also