Get a form

GET /v1/crm-forms/:id

Bitrix24 method: crm.form.get (REST v3).

Scope: crm. READONLY keys are supported.

Behavior and parameters

Reads the form directly; an absent form returns 404. The selected blocks are appearance, crm, fields, responsible, agreements, submission, callback, payment, booking, presetFields and dependencies. Analytics, integrations and spam protection are excluded even if the upstream response contains them.

Legacy aliases remain: title/description/buttonCaption from appearance, result.successText/failureText from submission, responsible.userIds, fields and agreements. The raw agreement block is available as agreementsSettings. Agreement name is AGREEMENT_<id>; label is null. The separate consent API requires an additional scope and is not called. Person-name field type is now string; visible is true. Hidden-field equivalence is not established.

List/checkbox/radio fields receive items through one additional entity-field dictionary call; forms without such fields need one Bitrix24 call.

Examples

curl 'https://vibecode.bitrix24.com/v1/crm-forms/37' \
  -H 'X-Api-Key: YOUR_API_KEY'

const response = await fetch('https://vibecode.bitrix24.com/v1/crm-forms/37', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await response.json()

For an OAuth application, use its key and add Authorization: Bearer USER_SESSION_TOKEN.

Response fields

Errors

Common API errors.

See also

• CRM forms
• API reference