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

List smart process items

GET /v1/items/:entityTypeId

Returns a list of items in the specified smart process with filtering, sorting, and pagination.

Use the entityTypeId field from GET /v1/smart-processes in the /v1/items/:entityTypeId path. The type record's internal id is a different identifier. For example, if a type is returned as { "id": 3, "entityTypeId": 174 }, the path starts with /v1/items/174. Use the returned value rather than assuming all type IDs start at 1030.

Parameters

Parameter Type Default Description
ParameterentityTypeId (path) Typenumber Default— DescriptionSmart process type ID. List: GET /v1/smart-processes
Parameterlimit Typenumber Default50 DescriptionNumber of records (up to 5000)
Parameteroffset Typenumber Default0 DescriptionSkip N records. To walk the entire collection, a cursor is cheaper: order[id]=asc plus filter[>id] from meta.nextAfterId
Parametersort Typestring Default— DescriptionSorting in short syntax: ?sort=-createdTime, where a leading minus means descending. Separate multiple fields with commas
Parameterorder Typeobject Default— DescriptionSorting: ?order[createdTime]=desc. Applied only when sort is not sent
Parameterselect Typestring Default— DescriptionField selection: ?select=id,title,stageId
Parameterfilter Typeobject Default— DescriptionFiltering by fields from GET /v1/items/:entityTypeId/fields.
Filtering syntax. Example: ?filter[assignedById]=1
ParameterwithTotal Typestring Default— DescriptionWhether you need the count: true or false. false — do not request a count. This is the only way to guarantee that meta.total is absent from the response. Without the parameter: the API key setting applies, then the platform default — and in that case a short page still carries the exact count even without an explicit request. Paging and counts

Examples

The examples use entityTypeId = 156. Replace it with your smart process ID.

curl — personal key

Terminal 
curl -g -X GET "https://vibecode.bitrix24.com/v1/items/156?limit=10&order[createdTime]=desc&filter[assignedById]=1" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -g -X GET "https://vibecode.bitrix24.com/v1/items/156?limit=10&order[createdTime]=desc&filter[assignedById]=1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const params = new URLSearchParams({
  limit: '10',
  'order[createdTime]': 'desc',
  'filter[assignedById]': '1',
})

const res = await fetch(`https://vibecode.bitrix24.com/v1/items/156?${params}`, {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

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

JavaScript — OAuth application

javascript 
const params = new URLSearchParams({
  limit: '10',
  'order[createdTime]': 'desc',
  'filter[assignedById]': '1',
})

const res = await fetch(`https://vibecode.bitrix24.com/v1/items/156?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Pagination is returned in the meta object (as with all list endpoints on the platform), not at the top level.

Field Type Description
Fielddata Typearray DescriptionArray of items
Fieldmeta.total Typenumber DescriptionTotal number of records. An optional field: if no count was requested, it is absent from the response
Fieldmeta.hasMore Typeboolean DescriptionWhether more pages exist
Fieldmeta.nextAfterId Typestring DescriptionThe identifier of the last returned record. Returned when the sort is strictly id ascending, while hasMore is true. Pass it back as filter[>id] — a cheap replacement for a growing offset
Fielddata[].id Typenumber DescriptionItem ID
Fielddata[].title Typestring DescriptionName
Fielddata[].stageId Typestring DescriptionStage
Fielddata[].categoryId Typenumber DescriptionFunnel ID
Fielddata[].opportunity Typenumber DescriptionAmount
Fielddata[].currencyId Typestring DescriptionCurrency
Fielddata[].assignedById Typenumber DescriptionResponsible person
Fielddata[].createdTime Typedatetime DescriptionCreation date

The card URL of any item from the data array is built from its id:

https://<portal>.bitrix24.com/crm/type/<entityTypeId>/details/<id>/

<entityTypeId> — the smart process type ID (the same as in the request path). <portal> — the Bitrix24 portal domain. If the smart process is placed in a separate section of your Bitrix24 account, Bitrix24 opens the card at the corresponding path. Access is restricted by the employee's permissions in Bitrix24.

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 783,
      "title": "Supply contract",
      "stageId": "DT156_41:NEW",
      "categoryId": 41,
      "companyId": 15,
      "contactId": 42,
      "opportunity": 500000,
      "currencyId": "USD",
      "assignedById": 1,
      "createdBy": 1,
      "createdTime": "2026-04-15T14:30:00+00:00",
      "updatedTime": "2026-04-15T14:30:00+00:00"
    }
  ],
  "meta": { "total": 23, "hasMore": true }
}

Error response example

403 — no scope:

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

Errors

HTTP Code Description
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP400 CodeINVALID_DYNAMIC_PARAM DescriptionentityTypeId is not a positive integer or is reserved (1, 2, 3, 4, 7, 31)
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionThe filter field does not exist on the entity — the message lists the available fields
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionThe field in sort or order does not exist on the entity — the message lists the available fields
HTTP400 CodeINVALID_SORT_DIRECTION DescriptionThe direction in order[field] is not one of asc, desc, ASC, DESC
HTTP429 CodeRATE_LIMITED DescriptionRate limit exceeded: 300 requests per minute per portal, shared by all API keys of the portal. 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 common API errors, see Errors.

See also