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.

Use the entityTypeId field from GET /v1/smart-processes in the /v1/items/:entityTypeId path. The type record's internal id is a different identifier. For example, if a type is returned as { "id": 3, "entityTypeId": 174 }, the path starts with /v1/items/174. Use the returned value rather than assuming all type IDs start at 1030.

Request parameters

Parameter Type Required Description
ParameterentityTypeId (path) Typenumber Requiredyes DescriptionSmart process type ID. List: GET /v1/smart-processes, the entityTypeId field
Parameterid (path) Typenumber Requiredyes DescriptionItem ID. List: GET /v1/items/:entityTypeId
Parameterselect (query) Typestring Requiredno DescriptionComma-separated response fields, for example id,title,stageId. Without it, every field is returned. Names come from Item fields. An unknown name does not cause an error: the field is absent from the response, and meta.warnings carries an UNKNOWN_SELECT_FIELD warning

Examples

The examples use entityTypeId = 156 and id = 783; replace them 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
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata Typeobject DescriptionThe smart process item. Full list of fields — Item fields
Fielddata.id Typenumber DescriptionItem ID
Fielddata.title Typestring DescriptionName
Fielddata.xmlId Typestring DescriptionExternal code
Fielddata.stageId Typestring DescriptionStage
Fielddata.categoryId Typenumber DescriptionPipeline ID
Fielddata.companyId Typenumber DescriptionCompany ID
Fielddata.contactId Typenumber DescriptionContact ID
Fielddata.contactIds Typearray DescriptionLinked contacts
Fielddata.opportunity Typenumber DescriptionAmount
Fielddata.currencyId Typestring DescriptionCurrency
Fielddata.opened Typeboolean DescriptionAvailable to everyone
Fielddata.assignedById Typenumber DescriptionResponsible person
Fielddata.createdBy Typenumber DescriptionCreator
Fielddata.updatedBy Typenumber DescriptionLast editor
Fielddata.movedBy Typenumber DescriptionWho moved the item to its current stage
Fielddata.createdTime Typedatetime DescriptionCreation date
Fielddata.updatedTime Typedatetime DescriptionModification date
Fielddata.movedTime Typedatetime DescriptionStage change date
Fielddata.observers Typearray DescriptionObservers
Fieldmeta.warnings Typearray DescriptionWarnings about unknown names in select, one per name: code is UNKNOWN_SELECT_FIELD, message is the text, field is the name. Present only when such names exist

Without select, 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
HTTP400 CodeINVALID_DYNAMIC_PARAM DescriptionentityTypeId is not a positive integer or is reserved (1, 2, 3, 4, 7, 31)
HTTP404 CodeENTITY_NOT_FOUND DescriptionAn item with the specified ID was not found
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

See also