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

List order statuses

GET /v1/order-statuses

Returns a list of order and delivery statuses with filtering support.

Parameters

Parameter Type Default Description
Parameterlimit Typenumber Default50 DescriptionNumber of records (up to 5000)
Parameteroffset Typenumber Default0 DescriptionSkip N records
Parameterselect Typestring Default— DescriptionField selection: ?select=id,type,sort,color
Parametersort Typestring Default— DescriptionSort using the short syntax: ?sort=-sort; a minus sign indicates descending order
Parameterorder Typeobject Default— DescriptionSorting: ?order[sort]=asc. If sort is also passed, sort applies
Parameterfilter Typeobject Default— DescriptionFiltering by status fields.
Filtering syntax. Example: ?filter[type]=O
ParameterwithTotal Typeboolean Default— DescriptionAccepted but has no effect on the response: meta.total is returned even with withTotal=false

Examples

curl — personal key

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/order-statuses?limit=3&order[sort]=asc" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/order-statuses?limit=3&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/order-statuses?limit=3&order[sort]=asc', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Total statuses: ${meta.total}`)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/order-statuses?limit=3&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 statuses
Fielddata[].id Typestring DescriptionStatus code
Fielddata[].type Typestring DescriptionStatus type: O — order, D — delivery
Fielddata[].sort Typenumber | null DescriptionSort order
Fielddata[].notify Typeboolean DescriptionWhether to send a notification to the customer
Fielddata[].color Typestring | null DescriptionHEX color code or null
Fielddata[].xmlId Typestring | null DescriptionExternal identifier or null
Fieldmeta.total Typenumber DescriptionTotal number of records matching the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether there are more records beyond limit

Response example

JSON 
{
  "success": true,
  "data": [
    { "id": "T", "type": "O", "sort": 30, "notify": true, "color": "#ACE9FB", "xmlId": null },
    { "id": "N", "type": "O", "sort": 100, "notify": true, "color": "#ACE9FB", "xmlId": null },
    { "id": "S", "type": "O", "sort": 110, "notify": true, "color": "#ACE9FB", "xmlId": null }
  ],
  "meta": {
    "total": 9,
    "hasMore": true
  }
}

Error response example

403 — no scope:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'sale' scope"
  }
}

Errors

HTTP Code Description
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionFilter by a field that is not in the status schema
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the sale scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
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 general API errors, see Errors.

Known specifics

Separation by type. By default the response includes statuses of both types — order and delivery. To get only order statuses, add filter[type]=O. For delivery — filter[type]=D.

See also