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

List requisite presets

GET /v1/requisite-presets

Returns a list of requisite presets with support for filtering, sorting, and auto-pagination. Used to retrieve the available field-set presets before creating a requisite.

Parameters

Parameter Type Default Description
Parameterlimit Typenumber Default50 DescriptionNumber of records (up to 5000). When limit > 50, Vibecode automatically requests multiple pages from Bitrix24
Parameteroffset Typenumber Default0 DescriptionSkip N records. When offset > 0, limit ≤ 500 is recommended
Parameterselect Typestring Default— DescriptionField selection: ?select=id,name,active
Parametersort Typestring Default— DescriptionSorting via the short syntax: ?sort=-sort, the minus means descending. For the identifier, use ?sort=-id; the ID form is accepted too
Parameterorder Typeobject Default— DescriptionSorting: ?order[sort]=asc, ?order[name]=desc. For the identifier, use ?order[id]=desc; the ?order[ID]=desc form is accepted too
Parameterfilter Typeobject Default— DescriptionFiltering by the fields from GET /v1/requisite-presets/fields.
Filtering syntax. Example: ?filter[active]=true&filter[countryId]=122

Pagination

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

Examples

curl — personal key

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

curl — OAuth application

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

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

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets', {
  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 presets (all fields — see Requisite preset fields)
Fieldmeta.total Typenumber DescriptionTotal number of records matching the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether there are more records beyond limit

Response example

The list may include account-defined presets alongside the built-in international presets Company and Person.

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "entityTypeId": 8,
      "countryId": 122,
      "name": "Company",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-08-13T14:34:26.000Z",
      "createdBy": 0,
      "modifyBy": 1,
      "active": true,
      "sort": 510,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_COMPANY#"
    },
    {
      "id": 3,
      "entityTypeId": 8,
      "countryId": 122,
      "name": "Sole proprietor",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-07-20T14:39:09.000Z",
      "createdBy": 0,
      "modifyBy": 1,
      "active": false,
      "sort": 520,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_INDIVIDUAL#"
    },
    {
      "id": 5,
      "entityTypeId": 8,
      "countryId": 122,
      "name": "Person",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-08-13T14:34:34.000Z",
      "createdBy": 0,
      "modifyBy": null,
      "active": true,
      "sort": 530,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_PERSON#"
    }
  ],
  "meta": {
    "total": 14,
    "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
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens
HTTP400 CodeINVALID_FILTER DescriptionFilter syntax error
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

The entityTypeId field is always 8. All presets belong to the "requisite" entity type — entityTypeId: 8. The value never changes, so it is not useful as a filter criterion.

The countryId field. The value depends on the country of the Bitrix24 account: on an international account the built-in presets Company and Person have countryId: 122. An account set up for another country returns presets with different countryId values. The xmlId values of the built-in presets depend on the account country in the same way.

Inactive presets are included in the list. A preset with active: false is returned in the list by default. To retrieve only active presets, pass filter[active]=true.

See also