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

Funnel fields

GET /v1/deal-categories/fields

Returns a description of all funnel fields with their types and attributes.

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/deal-categories/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/deal-categories/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()

JavaScript — OAuth application

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

Response fields

The data object contains a fields map and a batch list with the operations available in batch mode. Every field in the map is described by its type, the readonly flag, a label and a description.

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

Field Type RO Description
Fieldid Typenumber ROyes DescriptionFunnel ID
Fieldname Typestring RO DescriptionName
Fieldsort Typenumber RO DescriptionSort order
FieldisLocked Typeboolean ROyes DescriptionWhether the funnel is locked — unavailable on the current plan
FieldcreatedAt Typedatetime ROyes DescriptionCreation date

Response example

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true,
        "label": "ID",
        "description": "Unique identifier of the deal pipeline (category)."
      },
      "name": {
        "type": "string",
        "readonly": false,
        "label": "Name",
        "description": "Display name of the pipeline."
      },
      "sort": {
        "type": "number",
        "readonly": false,
        "label": "Sort",
        "description": "Sort order among pipelines."
      },
      "isLocked": {
        "type": "boolean",
        "readonly": true,
        "label": "Locked",
        "description": "Whether the pipeline is locked (unavailable on the current plan)."
      },
      "createdAt": {
        "type": "datetime",
        "readonly": true,
        "label": "Created at",
        "description": "When the pipeline was created."
      }
    },
    "batch": ["create", "update", "delete"]
  }
}

Error response example

403 — no scope:

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

Errors

HTTP Code Description
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the crm scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
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 errors, see Errors.

See also