For AI agents: markdown of this page — /docs-content-en/entities/smart-processes/fields.md documentation index — /llms.txt

Smart process type fields

GET /v1/smart-processes/fields

Returns the field schema of a smart process type: which fields can be passed on create and update, and which are read-only.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/smart-processes/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

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

const { success, data } = await res.json()
console.log('Fields:', Object.keys(data.fields).length)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/smart-processes/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

The label and description values are returned in English. Request headers do not switch the language.

Field Type RO Description
Fieldid Typenumber ROyes DescriptionInternal ID of the type record
FieldentityTypeId Typenumber RO DescriptionEntity type ID. Passed to /v1/items/:entityTypeId to work with items. If not passed on create, Bitrix24 assigns an available value automatically
Fieldtitle Typestring RO DescriptionSmart process type name
Fieldcode Typestring | null RO DescriptionSymbolic code of the type (for programmatic identification). null if not set
FieldcustomSectionId Typenumber | null RO DescriptionDeprecated. ID of the digital workspace the type is attached to. null if not attached. Accepted on creation only: a PATCH request containing this field is rejected with 400 READONLY_FIELD. The value is not fixed after creation — it changes when the attachment is changed from the workspace side through PATCH /v1/automated-solutions/:id with the full typeIds set
FieldisCategoriesEnabled Typeboolean RO DescriptionUse custom pipelines and sales tunnels in the smart process
FieldisStagesEnabled Typeboolean RO DescriptionUse custom stages and kanban in the smart process
FieldisBeginCloseDatesEnabled Typeboolean RO Description"Start date" and "End date" fields
FieldisClientEnabled Typeboolean RO Description"Client" field linked to contacts and companies
FieldisLinkWithProductsEnabled Typeboolean RO DescriptionCatalog product linking
FieldisMycompanyEnabled Typeboolean RO Description"Your company details" field
FieldisObserversEnabled Typeboolean RO Description"Observers" field
FieldisSourceEnabled Typeboolean RO Description"Source" and "Source details" fields
FieldisAutomationEnabled Typeboolean RO DescriptionAutomation rules and triggers
FieldisBizProcEnabled Typeboolean RO DescriptionBusiness process designer
FieldisDocumentsEnabled Typeboolean RO DescriptionDocument printing
FieldisRecyclebinEnabled Typeboolean RO DescriptionRecycle bin usage
FieldisSetOpenPermissions Typeboolean RO DescriptionMake new pipelines available to everyone
FieldisUseInUserfieldEnabled Typeboolean RO DescriptionUse the smart process in a user field
FieldisRecurringEnabled Typeboolean RO Description"Recurrence" field
FieldisPaymentsEnabled Typeboolean RO DescriptionOnline payment
FieldisCountersEnabled Typeboolean RO DescriptionCounters (notifications and badges)
FieldisInitialized Typeboolean ROyes DescriptionType fully initialized in the Bitrix24 account
FieldcreatedBy Typenumber ROyes DescriptionCreator. Lookup: GET /v1/users
FieldupdatedBy Typenumber ROyes DescriptionModified by. Lookup: GET /v1/users
FieldcreatedTime Typedatetime ROyes DescriptionCreation date
FieldupdatedTime Typedatetime ROyes DescriptionModification date

The response also contains an aggregatable array — the fields that support grouping in aggregation — and a batch array listing the operations available for batch processing: create, update, delete.

Datetime format. createdTime/updatedTime arrive in ISO 8601, but the exact representation (with a +03:00 offset or UTC …Z with milliseconds) depends on the Bitrix24 account — parse as ISO 8601, do not compare strings byte by byte.

Response example

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "Internal ID", "description": "Internal numeric identifier of the smart process type record." },
      "entityTypeId": { "type": "number", "readonly": false, "label": "Entity Type ID", "description": "Identifier of the smart process type used in /v1/items/:entityTypeId; assigned automatically if not provided on creation." },
      "title": { "type": "string", "readonly": false, "label": "Title", "description": "Title of the smart process type as displayed in the Bitrix24 interface." },
      "isCategoriesEnabled": { "type": "boolean", "readonly": false, "label": "Custom Pipelines", "description": "Enables custom pipelines and sales tunnels." },
      "isStagesEnabled": { "type": "boolean", "readonly": false, "label": "Custom Stages and Kanban", "description": "Enables custom stages and the kanban board." },
      "isLinkWithProductsEnabled": { "type": "boolean", "readonly": false, "label": "Product Linking", "description": "Enables linking catalog products to items." },
      "code": { "type": "string", "readonly": false, "label": "Symbolic Code", "description": "Symbolic code of the smart process type; may be absent (null)." },
      "createdBy": { "type": "number", "readonly": true, "label": "Created By", "description": "ID of the user who created the smart process type." },
      "customSectionId": { "type": "number", "readonly": false, "readonlyOnUpdate": true, "label": "Workspace (deprecated)", "description": "DEPRECATED. ID of an ALREADY EXISTING digital workspace to attach the type to. Bitrix24 honours it on creation only and silently ignores it on update, so PATCH refuses it with 400 READONLY_FIELD. The value is not fixed after creation: it changes when the type is re-attached through the workspace. Attach and detach smart process types there: PATCH /v1/automated-solutions/:id with the full typeIds set." },
      "createdTime": { "type": "datetime", "readonly": true, "label": "Created Date", "description": "Date and time when the smart process type was created." }
    },
    "aggregatable": ["customSectionId", "createdBy", "updatedBy", "isCategoriesEnabled", "isStagesEnabled", "isAutomationEnabled", "isBizProcEnabled", "isPaymentsEnabled", "isCountersEnabled", "isLinkWithProductsEnabled"],
    "batch": ["create", "update", "delete"]
  }
}

10 of 27 fields are shown. The full list is in the table above.

Error response example

401 — key not passed:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Errors

HTTP Code Description
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not passed
HTTP401 CodeINVALID_API_KEY DescriptionThe key is not recognized — no such key exists on the platform
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
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 general API errors, see Errors.

Known specifics

Nested structures. On create and update you can also pass relations (links to other CRM types) and linkedUserFields (linked user fields). They are not described in the /fields response, but Bitrix24 accepts and stores them unchanged. For more details, see Create a type.

Difference from GET /v1/{entity}/fields for standard entities. This endpoint describes the fields of the smart process type (crm.type.*), not of the items inside it. For item fields use GET /v1/items/:entityTypeId/fields.

See also