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

List forms

GET /v1/crm-forms

Finds CRM forms in the Bitrix24 account by activity, name, code, CRM scheme, responsible user or dates, so you can get the ID of the form you need.

Parameters

Parameter	Type	Default	Description
Parameter`id` (query)	Typeinteger \| integer[]	Default—	DescriptionForm IDs. Repeat the parameter: `?id=1&id=3`. IDs come from this list
Parameter`active` (query)	Typeboolean	Default—	DescriptionForm activity. Omit to return both active and inactive forms
Parameter`name` (query)	Typestring	Default—	DescriptionExact form name, including commas. Repeat the parameter for several names
Parameter`code` (query)	Typestring	Default—	DescriptionExact symbolic code. Repeat the parameter for several codes
Parameter`entityScheme` (query)	Typenumber	Default—	DescriptionAlias for `crm.entityScheme`. Values: `entitySchemes` in builder configuration. Several values may be comma-separated
Parameter`responsibleUserId` (query)	Typenumber	Default—	DescriptionAlias for `responsible.userIds`. IDs: List employees. Several IDs may be comma-separated
Parameter`filter` (query)	Typeobject	Default—	DescriptionFilter by form properties. Top-level metadata: Form contract fields. Filtering syntax. Example: `?filter[id][$in]=1,3`, date range: `?filter[updatedTime][$gte]=2023-01-01T00:00:00Z`. Property names and operators are validated by Bitrix24
Parameter`select` (query)	Typestring	Default—	DescriptionComma-separated properties and nested paths, such as `id,name,active,templateId,crm.entityScheme,responsible.userIds,updatedTime`
Parameter`order` (query)	Typeobject	Default—	DescriptionSort: `?order[name]=desc`. Use either `order[...]` or `sort`. Using both returns `400 INVALID_PARAMS`
Parameter`sort` (query)	Typestring	Default—	DescriptionSort shorthand: `?sort=-name`; a leading minus means descending order. Bitrix24 validates sort properties and directions
Parameter`limit` (query)	Typenumber	Default—	DescriptionPage size. Bitrix24 validates the value
Parameter`offset` (query)	Typenumber	Default—	DescriptionNumber of forms to skip. Bitrix24 validates the value

Pagination. One request reads one page. Without limit and offset, Bitrix24 uses its own pagination defaults. Pagination metadata is included only when returned by Bitrix24. To request the next page, pass limit and increase offset by that value.

Examples

curl — personal key

Terminal

curl "https://vibecode.bitrix24.com/v1/crm-forms?limit=2" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal

curl "https://vibecode.bitrix24.com/v1/crm-forms?limit=2" \
  -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/crm-forms?limit=2', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { data, meta } = await res.json()
for (const form of data) console.log(form.id, form.name)
const mayHaveNextPage = data.length === 2

JavaScript — OAuth application

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/crm-forms?limit=2', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Field	Type	Description
Field`success`	Typeboolean	Description`true` on success
Field`data`	Typearray	DescriptionForms on the page, preserving their properties. Top-level property metadata: Form contract fields
Field`meta`	Typeobject	DescriptionOptional pagination metadata returned by Bitrix24
Field`meta.redacted`	Typestring[]	DescriptionPresent only when the current connection's credentials are found in the content. `JSON Pointer` paths identify replaced values

Without select, each form has 11 scalar properties: id, code, name, active, system, languageId, templateId, createdTime, updatedTime, activeChangedById, activeChangedTime. Target entities and responsible users require an explicit select. activeChangedById identifies the author of the activity change, not the responsible user.

Response example

JSON

{
  "success": true,
  "data": [
    {
      "id": 1,
      "code": "1_kontaktnye_dannye",
      "name": "Contact details",
      "active": true,
      "system": true,
      "languageId": "ru",
      "templateId": "light",
      "createdTime": "2020-04-22T06:13:05Z",
      "updatedTime": "2020-04-22T06:13:05Z",
      "activeChangedById": 1,
      "activeChangedTime": "2020-04-22T06:13:05Z"
    },
    {
      "id": 3,
      "code": "3_obratnaya_svyaz",
      "name": "Feedback form",
      "active": true,
      "system": true,
      "languageId": "ru",
      "templateId": "light",
      "createdTime": "2020-04-22T06:13:05Z",
      "updatedTime": "2020-04-22T06:13:05Z",
      "activeChangedById": 1,
      "activeChangedTime": "2020-04-22T06:13:05Z"
    }
  ]
}

Live response from a Russian-language portal: code and languageId are portal values returned as stored. code is the exact value for the ?code= filter, and another portal has its own codes. Only the display name appears here in English.

Error response example

400 — invalid limit, here ?limit=abc: