YZ ajanları için: bu sayfanın markdown'ı — /docs-content-en/sign-b2e/list-legal-fields.md dokümantasyon dizini — /llms.txt
Dokümantasyon makaleleri şu anda İngilizce olarak mevcuttur.
List legal fields
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_AVAILABLEwitherror.release.
GET /v1/sign-b2e/legal-fields
Returns the codes, formats, captions, writability and placeholders of legal fields. The key owner needs permission to view employee legal data.
Scopes: sign.b2e.
Examples
curl — personal key
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/legal-fields' \
-H 'X-Api-Key: YOUR_API_KEY'
curl — OAuth application
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/legal-fields' \
-H 'X-Api-Key: YOUR_APP_KEY' \
-H 'Authorization: Bearer USER_SESSION_TOKEN'
JavaScript — personal key
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/legal-fields', {
"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
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/legal-fields', {
"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 |
Typearray | DescriptionOperation data. |
Fielddata[].code |
Typestring | DescriptionMachine-readable code. |
Fielddata[].type |
Typestring | DescriptionValue format: string, snils, inn, date, address, url, enumeration, fullname. Treat an unknown format as not writable. |
Fielddata[].caption |
Typestring | DescriptionField caption in the Bitrix24 account language. |
Fielddata[].writable |
Typeboolean | DescriptionWhether the field value can be written. |
Fielddata[].signerPlaceholder |
Typestring | null | DescriptionEmployee placeholder in DOCX; null if none. |
Fielddata[].assigneePlaceholder |
Typestring | null | DescriptionCompany representative placeholder in DOCX; null if none. |
Fielddata[].options |
Typearray | null | DescriptionList options; null for other formats. |
Fielddata[].options[].id |
Typeinteger | string | DescriptionObject ID. |
Fielddata[].options[].value |
Typestring | DescriptionList option name. |
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.
{
"success": true,
"data": []
}
Error response example
403 — the key lacks a required scope:
{
"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. |
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.