Dành cho AI agent: markdown của trang này — /docs-content-en/sign-b2e/tail-template-folders.md chỉ mục tài liệu — /llms.txt

Hiện tại, các bài viết trong tài liệu chỉ có bằng tiếng Anh.

List template bundles

Available starting with the sign 26.1300.0 module. On older self-hosted installations the method may be unavailable: the platform returns 422 METHOD_NOT_YET_AVAILABLE with error.release.

POST /v1/sign-b2e/template-folders/tail

Returns bundles whose templates are all available to the key owner for sending. Requires permission to read documents. Keep paginating until hasMore=false, even when intermediate pages are empty.

Scopes: sign.b2e, crm.

Request body fields

Parameter Type Required Description
Parametercursor Typeobject | null Requiredno DescriptionThe entire cursor from meta.cursor of the previous response. Omit it in the first request; null is allowed.
Parametercursor.field Typestring Requiredno DescriptionCursor field: id.
Parametercursor.value Typeinteger | string Requiredno DescriptionLast seen ID; 0 at the start of pagination.
Parametercursor.order Typestring Requiredno DescriptionSort direction: ASC, case-insensitive.
Parametercursor.limit Typeinteger | string Requiredno DescriptionDefaults to 50; minimum 1. The core reduces values above 50 to 50.

Examples

curl — personal key

Terminal
curl -X POST 'https://vibecode.bitrix24.com/v1/sign-b2e/template-folders/tail' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

curl — OAuth application

Terminal
curl -X POST 'https://vibecode.bitrix24.com/v1/sign-b2e/template-folders/tail' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

JavaScript — personal key

javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/template-folders/tail', {
  "method": "POST",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

JavaScript — OAuth application

javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/template-folders/tail', {
  "method": "POST",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionWhether the request succeeded.
Fielddata Typearray DescriptionOperation data.
Fielddata[].id Typeinteger DescriptionObject ID.
Fielddata[].title Typestring DescriptionObject name.
Fielddata[].companyId Typeinteger DescriptionCRM company ID.
Fielddata[].companyName Typestring DescriptionCompany name.
Fielddata[].templateCount Typeinteger DescriptionNumber of templates.
Fielddata[].templates Typearray DescriptionBundle templates.
Fielddata[].templates[].uid Typestring DescriptionTemplate UID.
Fielddata[].templates[].title Typestring DescriptionObject name.
Fielddata[].templates[].companyId Typeinteger | null DescriptionCRM company ID.
Fielddata[].templates[].companyName Typestring | null DescriptionCompany name.
Fielddata[].templates[].regionDocumentType Typestring | null DescriptionRegional document type.
Fielddata[].templates[].providerCode Typestring | null DescriptionStored provider code; null if unknown.
Fieldmeta.cursor Typeobject DescriptionCursor for the next request.
Fieldmeta.hasMore Typeboolean DescriptionWhether there is a next page; can be true even when data is empty.
Fieldmeta.redacted Typearray DescriptionPresent when credentials are hidden; contains the paths of the replaced values.

Response example

Shape of a successful response; the data depends on the Bitrix24 account and the request.

JSON
{
  "success": true,
  "data": [],
  "meta": {
    "cursor": {
      "field": "id",
      "value": "7",
      "order": "ASC",
      "limit": 50
    },
    "hasMore": false
  }
}

Error response example

403 — the key lacks a required scope:

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

Errors

HTTP Code Reason
HTTP400 CodeINVALID_PARAMS ReasonInvalid request shape: types, required fields or an unknown query string parameter.
HTTP401 CodeTOKEN_MISSING ReasonNo credentials for the Bitrix24 connection.
HTTP403 CodeSCOPE_DENIED ReasonOne of the required scopes is not granted.
HTTP422 CodeBITRIX_ERROR ReasonBitrix24 rejected the operation; the code is in error.b24Code, the text in error.message.
HTTP422 CodeMETHOD_NOT_YET_AVAILABLE ReasonThe method is not yet available on the Bitrix24 account; the release is in error.release.

Common API errors.

Known specifics

Bitrix24 checks user permissions, HR e-signature availability, business rules, page sizes and field contents. Values are passed through without local correction. Response text is JSON-encoded; credential-bearing links are hidden.

See also