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

Get a pipeline

GET /v1/deal-categories/:id

Returns a sales pipeline by ID.

Path parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionPipeline ID. List: GET /v1/deal-categories

The main pipeline with id 0 is not available via this endpoint — use /v1/categories/2/0 for it.

Examples

curl — personal key

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

curl — OAuth application

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe pipeline with all fields
Fielddata.id Typenumber DescriptionPipeline ID
Fielddata.name Typestring DescriptionName
Fielddata.sort Typenumber DescriptionSort order
Fielddata.isLocked Typeboolean DescriptionWhether the pipeline is locked — unavailable on the current plan
Fielddata.createdAt Typedatetime DescriptionCreation date

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 3,
    "name": "Corporate sales",
    "sort": 200,
    "isLocked": false,
    "createdAt": "2025-06-01T14:00:00.000Z"
  }
}

Error response example

404 — no pipeline with this ID:

JSON 
{
  "success": false,
  "error": { "code": "ENTITY_NOT_FOUND", "message": "Not found" }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionPipeline not found
HTTP422 CodeBITRIX_ERROR DescriptionThe id of the main pipeline (0) was passed — message ID is not defined or invalid.
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the crm scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing

Full list of errors — Errors.

See also