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

Get a call list

GET /v1/call-lists/:id

Returns one call list by ID, including lead and deal lists created in the Bitrix24 interface.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionCall list ID, a positive integer. List: GET /v1/call-lists

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/call-lists/17" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

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

const { success, data } = await res.json()
console.log(`List ${data.id}: participants of type ${data.entityType}`)

JavaScript — OAuth application

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

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionCall list
Fielddata.id Typenumber DescriptionCall list ID
Fielddata.dateCreate Typestring DescriptionCreation date as a YYYY-MM-DD HH:mm:ss string in the Bitrix24 account's local time, without a time zone
Fielddata.createdById Typenumber DescriptionWho created the list. User list: GET /v1/users
Fielddata.webformId Typenumber | null DescriptionCRM form linked to the list, or null. Form list: GET /v1/crm-forms
Fielddata.entityTypeId Typenumber DescriptionParticipant type as a number: 1 — lead, 2 — deal, 3 — contact, 4 — company
Fielddata.entityType Typestring DescriptionThe same type as a string: LEAD, DEAL, CONTACT, COMPANY

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 17,
    "dateCreate": "2026-10-13 09:42:01",
    "createdById": 1317,
    "webformId": null,
    "entityTypeId": 3,
    "entityType": "CONTACT"
  }
}

Error response example

404 — list not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Call list not found or inaccessible"
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo list with this id exists, or it is not accessible to the key owner
HTTP400 CodeINVALID_PARAMS Descriptionid is not a positive integer, for example abc or 0
HTTP400 CodeINVALID_PARAMS DescriptionA query string parameter is passed, for example ?select=id. The method accepts no query string parameters
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the request. The reason is in message
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionThe Bitrix24 response did not match the expected list structure
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no Bitrix24 tokens configured
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing

Full list of common API errors: Errors.

See also