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

List smart process types

GET /v1/smart-processes

Returns the smart process types in your Bitrix24 account. Each type has an entityTypeId — use it to work with items via /v1/items/:entityTypeId.

Parameters

Parameter Type Default Description
Parameterfilter Typeobject Default— DescriptionFilter by fields. Example: ?filter[isStagesEnabled]=true. Filtering syntax
Parameterselect Typestring Default— DescriptionField selection: ?select=id,title,entityTypeId
Parametersort Typestring Default— DescriptionSort by field: ?sort=title (ascending), ?sort=-createdTime (descending)
Parameterlimit Typenumber Default50 DescriptionNumber of records, from 1 to 5000. A value above 5000 is reduced to 5000
Parameteroffset Typenumber Default0 DescriptionSkip N records from the start of the list
ParameterwithTotal Typestring Default— DescriptionThe values true and false are recognized. For smart process types the parameter does not affect the response: meta.total is returned even with withTotal=false

Fields available for filter and select are listed in Type fields.

For limit > 50, Vibecode automatically paginates the request on the server side. The maximum is 5000 records per call. If more records match the filter, meta.hasMore is true.

For several filter conditions at once, use Search types — a POST with a request body instead of a query string.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/smart-processes" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/smart-processes" \
  -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/smart-processes', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
for (const sp of data) {
  console.log(`${sp.title}: entityTypeId=${sp.entityTypeId}`)
}

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/smart-processes', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of smart process types. For the fields of each type, see Type fields
Fieldmeta.total Typenumber DescriptionTotal number of types matching the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether there are more records beyond limit

To open the item list of any type from the data array in Bitrix24, use its entityTypeId:

https://<portal>.bitrix24.com/crm/type/<entityTypeId>/list/category/0/

0 — the main funnel. <portal> — the Bitrix24 portal domain. Access is restricted by the employee's permissions in Bitrix24.

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3,
      "entityTypeId": 174,
      "title": "Contracts",
      "code": null,
      "customSectionId": null,
      "isCategoriesEnabled": true,
      "isStagesEnabled": true,
      "isClientEnabled": true,
      "isLinkWithProductsEnabled": true,
      "isObserversEnabled": true,
      "isSourceEnabled": true,
      "isAutomationEnabled": true,
      "isBizProcEnabled": true,
      "isDocumentsEnabled": true,
      "isRecyclebinEnabled": true,
      "isSetOpenPermissions": true,
      "isUseInUserfieldEnabled": true,
      "createdBy": 1,
      "updatedBy": 1,
      "createdTime": "2021-07-20T16:04:10+00:00",
      "updatedTime": "2024-07-19T14:27:27+00:00"
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

Error response example

403 — no scope:

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

Errors

HTTP Code Description
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not passed
HTTP401 CodeINVALID_API_KEY DescriptionThe key is not recognized — no such key exists on the platform
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP422 CodeBITRIX_ERROR DescriptionAn error from Bitrix24. The specific reason is in the message field
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 common API errors, see Errors.

Known specifics

entityTypeId — the key field. Save it and pass it to /v1/items/:entityTypeId to work with items of this type.

See also