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

List of dictionaries

GET /v1/statuses

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

Parameters

Parameter Type Default Description
Parameterlimit Typenumber Default50 DescriptionNumber of records (up to 5000). When limit > 50, auto-pagination applies
Parameteroffset Typenumber Default0 DescriptionSkip N records
Parameterselect Typestring Default— DescriptionField selection: ?select=id,name,entityId
Parametersort Typestring Default— DescriptionSort using shorthand syntax: ?sort=-sort. A minus sign indicates descending order
Parameterorder Typeobject Default— DescriptionSorting: ?order[sort]=asc
Parameterfilter Typeobject Default— DescriptionExact 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.
Filtering syntax. 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
ParameterwithTotal Typestring Default— DescriptionAccepted but has no effect on the response: meta.total is returned for any value and any offset

Examples

curl — personal key

Terminal 
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

Terminal 
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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of dictionary records (all fields — see Dictionary fields)
Fieldmeta.total Typenumber DescriptionNumber of records matching the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether 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
HTTP400 CodeUNSUPPORTED_FILTER DescriptionAn 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
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the crm scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP429 CodeRATE_LIMITED DescriptionRate 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.

See also