YZ ajanları için: bu sayfanın markdown'ı — /docs-content-en/sign-b2e/get-template-folder.md dokümantasyon dizini — /llms.txt

Dokümantasyon makaleleri şu anda İngilizce olarak mevcuttur.

Get a template bundle

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.

GET /v1/sign-b2e/template-folders/:id

Returns a bundle available for sending, together with its templates. Requires permission to read documents. A bundle that is missing, inaccessible or unavailable for sending returns the same error.

Scopes: sign.b2e, crm.

Path parameters

Parameter Type Required Description
Parameterid Typestring Requiredyes DescriptionBundle ID from List template bundles.

Examples

curl — personal key

Terminal
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/template-folders/7' \
  -H 'X-Api-Key: YOUR_API_KEY'

curl — OAuth application

Terminal
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/template-folders/7' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN'

JavaScript — personal key

javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/template-folders/7', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY"
  }
});
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/7', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN"
  }
});
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 Typeobject 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.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": {
    "id": 7,
    "title": "VIBE-PROBE",
    "companyId": 7,
    "companyName": "Example Company",
    "templateCount": 0,
    "templates": []
  }
}

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.
HTTP404 CodeSIGN_B2E_TEMPLATE_FOLDER_NOT_FOUND ReasonThe bundle is missing or unavailable for sending. The native code is preserved in error.code and error.b24Code.
HTTP404 CodeENTITY_NOT_FOUND ReasonBitrix24 returned a generic NOT_FOUND refusal. The native code is in error.b24Code.

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