## 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 |
|----------|-----|:-----:|----------|
| `id` (path) | number | yes | Call list ID, a positive integer. List: [`GET /v1/call-lists`](/docs/entities/call-lists/list) |

## Examples

### curl — personal key

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

### curl — OAuth application

```bash
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 |
|------|-----|----------|
| `success` | boolean | Always `true` on success |
| `data` | object | Call list |
| `data.id` | number | Call list ID |
| `data.dateCreate` | string | Creation date as a `YYYY-MM-DD HH:mm:ss` string in the Bitrix24 account's local time, without a time zone |
| `data.createdById` | number | Who created the list. User list: [`GET /v1/users`](/docs/entities/users) |
| `data.webformId` | number \| null | CRM form linked to the list, or `null`. Form list: [`GET /v1/crm-forms`](/docs/entities/crm-forms) |
| `data.entityTypeId` | number | Participant type as a number: `1` — lead, `2` — deal, `3` — contact, `4` — company |
| `data.entityType` | string | The 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 |
|------|-----|----------|
| 404 | `ENTITY_NOT_FOUND` | No list with this `id` exists, or it is not accessible to the key owner |
| 400 | `INVALID_PARAMS` | `id` is not a positive integer, for example `abc` or `0` |
| 400 | `INVALID_PARAMS` | A query string parameter is passed, for example `?select=id`. The method accepts no query string parameters |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the request. The reason is in `message` |
| 502 | `BITRIX_RESPONSE_INVALID` | The Bitrix24 response did not match the expected list structure |
| 403 | `SCOPE_DENIED` | The key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens configured |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |

Full list of common API errors: [Errors](/docs/errors).

## See also

- [List call lists](/docs/entities/call-lists/list)
- [Call list participants](/docs/entities/call-lists/items)
- [Replace participants](/docs/entities/call-lists/replace)
- [Participant statuses](/docs/entities/call-lists/statuses)
- [Entity reference](/docs/entity-api)