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

Get a smart process item

GET /v1/items/:entityTypeId/:id

Returns a smart process item by ID.

Request parameters

Parameter Type Description
entityTypeId number Smart process type ID (in URL)
id number Item ID (in URL)

Examples

In the examples entityTypeId = 156, id = 783 — replace with your values.

curl — personal key

Terminal 
curl -X GET https://vibecode.bitrix24.com/v1/items/156/783 \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET https://vibecode.bitrix24.com/v1/items/156/783 \
  -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/items/156/783', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data } = await res.json()
console.log('Item:', data.title)

JavaScript — OAuth application

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

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

Response fields

Field Type Description
id number Item ID
title string Name
xmlId string External code
stageId string Stage
categoryId number Pipeline ID
companyId number Company ID
contactId number Contact ID
contactIds array Linked contacts
opportunity number Amount
currencyId string Currency
opened boolean Available to everyone
assignedById number Responsible person
createdBy number Creator
updatedBy number Last editor
movedBy number Moved the stage
createdTime datetime Creation date
updatedTime datetime Modification date
movedTime datetime Stage change date
observers array Observers

The response contains all item fields, including user fields (ufCrmN_*) and parent references (parentIdN).

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 783,
    "title": "Supply contract",
    "xmlId": null,
    "stageId": "DT156_41:NEW",
    "categoryId": 41,
    "companyId": 15,
    "contactId": 42,
    "contactIds": [42],
    "opportunity": 500000,
    "currencyId": "USD",
    "opened": true,
    "assignedById": 1,
    "createdBy": 1,
    "updatedBy": 1,
    "movedBy": 1,
    "createdTime": "2026-04-15T14:30:00+00:00",
    "updatedTime": "2026-04-15T14:30:00+00:00",
    "movedTime": "2026-04-15T14:30:00+00:00",
    "observers": [1, 5],
    "mycompanyId": 0
  }
}

Error response example

404 — item not found:

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

Errors

HTTP Code Description
400 INVALID_DYNAMIC_PARAM entityTypeId is not a positive integer or is reserved (1, 2, 3, 4, 7, 31)
404 ENTITY_NOT_FOUND Item with the given ID not found
403 SCOPE_DENIED API key does not have the crm scope
401 TOKEN_MISSING API key has no configured tokens

Full list of common API errors — Errors.

See also