## List of dictionaries

`GET /v1/statuses`

Returns CRM dictionary records. Use `filter[entityId]` to select a specific type.

## Parameters

| Parameter | Type | Default | Description |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Number of records (up to 5000). When `limit > 50`, auto-pagination applies |
| `offset` | number | `0` | Skip N records |
| `select` | string | — | Field selection: `?select=id,name,entityId` |
| `sort` | string | — | Sort using shorthand syntax: `?sort=-sort`. A minus sign indicates descending order |
| `order` | object | — | Sorting: `?order[sort]=asc` |
| `filter` | object | — | Exact match on a single value only, for the fields `id`, `entityId`, `statusId`, `name`, `sort`, `semantics`, `categoryId`. A value list (`$in` or an array) is not supported on any field: the dictionary method does not accept one, so such a filter is rejected immediately with `400 UNSUPPORTED_FILTER` — pass a single value and request several values in separate calls or via `POST /v1/batch`. Operators (`>`, `>=`, `<`, `<=`, `!`, `%`, `$ne`, `$contains`, `$nin`) and other fields (for example `color`) are not supported — also `400 UNSUPPORTED_FILTER`.<br>[Filtering syntax](/docs/filtering). Example: `?filter[entityId]=DEAL_STAGE` — stages of the general pipeline, `?filter[entityId]=DEAL_STAGE_3` — stages of the pipeline with ID `3`. Pipeline IDs: `GET /v1/deal-categories` |
| `withTotal` | string | — | Accepted but has no effect on the response: `meta.total` is returned for any value and any `offset` |

## Examples

### curl — personal key

```bash
curl -g "https://vibecode.bitrix24.com/v1/statuses?filter[entityId]=DEAL_STAGE&order[sort]=asc" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl -g "https://vibecode.bitrix24.com/v1/statuses?filter[entityId]=DEAL_STAGE&order[sort]=asc" \
  -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/statuses?filter[entityId]=DEAL_STAGE&order[sort]=asc', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data, meta } = await res.json()
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/statuses?filter[entityId]=DEAL_STAGE&order[sort]=asc', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data, meta } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of dictionary records (all fields — see [Dictionary fields](/docs/entities/statuses/fields)) |
| `meta.total` | number | Number of records matching the filter |
| `meta.hasMore` | boolean | Whether there are more records beyond `limit` |

## Response example

Two of eight records are shown.

```json
{
  "success": true,
  "data": [
    {
      "id": 101,
      "entityId": "DEAL_STAGE",
      "statusId": "NEW",
      "name": "New",
      "nameInit": "New",
      "sort": 10,
      "system": true,
      "categoryId": null,
      "color": "#39A8EF",
      "semantics": null,
      "description": null,
      "extra": { "SEMANTICS": "process", "COLOR": "#39A8EF" }
    },
    {
      "id": 103,
      "entityId": "DEAL_STAGE",
      "statusId": "PREPARATION",
      "name": "Preparing documents",
      "nameInit": null,
      "sort": 20,
      "system": false,
      "categoryId": null,
      "color": "#2FC6F6",
      "semantics": null,
      "description": null,
      "extra": { "SEMANTICS": "process", "COLOR": "#2FC6F6" }
    }
  ],
  "meta": { "total": 8, "hasMore": false }
}
```

## Error response example

400 — an operator or unsupported field in the filter:

```json
{
  "success": false,
  "error": {
    "code": "UNSUPPORTED_FILTER",
    "message": "UNSUPPORTED_FILTER: 'color' is not filterable on 'statuses'. Its Bitrix24 method (crm.status.list) filters by exact match only. Filterable: id, entityId, statusId, name, sort, semantics, categoryId."
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `UNSUPPORTED_FILTER` | An operator, an unsupported field, or a value list. Filter by exact match on a single value — on the fields `id`, `entityId`, `statusId`, `name`, `sort`, `semantics`, `categoryId` |
| 403 | `SCOPE_DENIED` | The API key lacks the `crm` scope |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 429 | `RATE_LIMITED` | Rate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the `x-ratelimit-limit` header. Retry after the delay in the `Retry-After` header |

For the full list of errors, see [Errors](/docs/errors).

## See also

- [CRM dictionaries](/docs/entities/statuses)
- [Create dictionary record](/docs/entities/statuses/create)
- [Filtering syntax](/docs/filtering)
- [Batch](/docs/batch)