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

List participants

GET /v1/call-lists/:id/items

Returns call list participants in pages of 50 records, along with the current status of each participant in the call list.

Parameters

Parameter Type Required Default Description
Parameterid (path) Typenumber Requiredyes Default— DescriptionCall list ID. List: GET /v1/call-lists
Parameteroffset (query) Typenumber Requiredno Default0 DescriptionPage offset: 0 or a multiple of 50. A page holds up to 50 participants, and the page size is fixed

Examples

curl — personal key

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

curl — OAuth application

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

const { success, data, meta } = await res.json()
console.log(`${data.length} participants on the page, next offset ${meta.nextOffset}`)

JavaScript — OAuth application

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

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionParticipants on the current page
Fielddata[].id Typenumber DescriptionParticipant ID in CRM — a contact, company or deal, depending on entityType. Record: GET /v1/contacts/:id, GET /v1/companies/:id, GET /v1/deals/:id
Fielddata[].status Typestring DescriptionParticipant status code, for example IN_WORK. The status name is in the status dictionary, matched by statusId
Fielddata[].entityType Typenumber DescriptionParticipant type as a number — the same code as the list's entityTypeId, see key fields: 3 — contact, 4 — company, 2 — deal. In the get a call list response, the field of the same name, entityType, is a string — CONTACT, COMPANY, DEAL
Fieldmeta.offset Typenumber DescriptionOffset of the current page, as in the request
Fieldmeta.limit Typenumber DescriptionPage size, always 50
Fieldmeta.nextOffset Typenumber DescriptionOffset of the next page, always offset + 50. It is returned on every page and does not indicate whether more participants follow

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 9,
      "status": "IN_WORK",
      "entityType": 3
    },
    {
      "id": 17,
      "status": "IN_WORK",
      "entityType": 3
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 50,
    "nextOffset": 50
  }
}

Error response example

404 — no call list with this ID exists:

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

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo call list with this id exists, or it is not accessible to the key owner
HTTP400 CodeINVALID_PARAMS Descriptionid is not a positive integer, offset is not a multiple of 50, or a query parameter other than offset is passed
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionThe requested page has no participant accessible to the key owner. A page past the end of the list returns the same error — see "Known specifics"
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the request for another reason. The reason text is in message
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionBitrix24 returned a response that could not be parsed
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured Bitrix24 tokens
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is not passed

Full list of common API errors — Errors.

Known specifics

The end of the list is a 403 rejection. Read pages in sequence with offsets 0, 50, 100 and so on until 403 BITRIX_ACCESS_DENIED is returned. This rejection is returned for a page that has no participant accessible to the key owner. If the key can access all list participants, such a page lies past the end of the list.

A partial page also occurs in the middle of the list. A page is assembled before participants inaccessible to the key owner are removed from it. So data may contain fewer than 50 records while the next page still has participants.

See also