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

Get element

GET /v1/lists/:iblockId/elements/:elementId

Returns a single list element by its identifier.

Parameters

Parameter Type Required Default Description
ParameteriblockId (path) Typestring Requiredyes Default— DescriptionNumeric list identifier IBLOCK_ID or symbolic code IBLOCK_CODE
ParameterelementId (path) Typenumber Requiredyes Default— DescriptionElement identifier, a positive integer
ParameteriblockTypeId (query) Typestring Requiredno Defaultlists DescriptionInfoblock type. Values:
lists — regular lists, default
lists_socnet — workgroup lists
bitrix_processes — service workflows
structure — company structure type (holds the built-in absence chart iblock absence)
Parameterselect (query) Typestring Requiredno Default— DescriptionComma-separated list of returned fields. A custom property is requested as PROPERTY_<id>. Example: ?select=ID,NAME,PROPERTY_1149. A name the list does not return causes no error: that field is simply absent from the response. ID is always returned, even when it is not in select

Examples

curl — personal key

Terminal 
curl https://vibecode.bitrix24.com/v1/lists/121/elements/501 \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl https://vibecode.bitrix24.com/v1/lists/121/elements/501 \
  -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/lists/121/elements/501', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Element:', data)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/lists/121/elements/501', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Response fields

The observable fields are shown. The set of system fields is defined by Bitrix24, and custom properties arrive under PROPERTY_<id> keys. The set of fields is not fixed: some fields named in select may not come back, and different elements carry different sets of keys. A missing field does not mean an empty value or N. The activity flag ACTIVE is not returned, with or without select.

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.ID Typestring DescriptionElement identifier
Fielddata.IBLOCK_ID Typestring DescriptionList identifier
Fielddata.NAME Typestring DescriptionElement name
Fielddata.IBLOCK_SECTION_ID Typestring or null DescriptionSection identifier, null for an element not in any section
Fielddata.CODE Typestring or null DescriptionSymbolic code of the element, null if not set
Fielddata.BP_PUBLISHED Typestring DescriptionPublication flag: Y or N
Fielddata.CREATED_BY Typestring DescriptionCreator identifier. To look it up, use GET /v1/users
Fielddata.DATE_CREATE Typestring DescriptionCreation date and time
Fielddata.MODIFIED_BY Typestring DescriptionIdentifier of the user who last modified the element. To look it up, use GET /v1/users
Fielddata.USER_NAME Typestring DescriptionCreator display name
Fielddata.PROPERTY_<id> Typeobject DescriptionCustom property values as a mapping «value identifier — value». The property identifier is from List fields

Response example

JSON 
{
  "success": true,
  "data": {
    "ID": "501",
    "IBLOCK_ID": "121",
    "NAME": "Sample element",
    "IBLOCK_SECTION_ID": null,
    "CODE": null,
    "BP_PUBLISHED": "Y",
    "CREATED_BY": "17",
    "DATE_CREATE": "10/12/2025 12:53:50 pm",
    "MODIFIED_BY": "17",
    "USER_NAME": "John Smith",
    "PROPERTY_1149": { "3801": "78" }
  }
}

Error response example

404 — element not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ELEMENT_NOT_FOUND",
    "message": "Element not found"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionelementId is not a positive integer
HTTP400 CodeINVALID_IBLOCK_TYPE DescriptioniblockTypeId is not in the set lists, bitrix_processes, lists_socnet, structure
HTTP404 CodeELEMENT_NOT_FOUND DescriptionAn element with the given elementId was not found in the list
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionNo access to the list. As measured on 2026-09-02, a missing list at this address returns 404, but Bitrix24 also returns this code when access rights are genuinely missing
HTTP404 CodeLIST_NOT_FOUND DescriptionNo list with the given iblockId exists. Bitrix24 reports this with a machine code, so an absent list is distinguishable from a permission refusal
HTTP409 CodeLISTS_MODULE_NOT_ENABLED DescriptionThe «Lists» module is not enabled on the portal
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the lists scope
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no access tokens configured

The full list of common API errors — Errors.

Known specifics

A custom property value arrives not as a string but as a mapping «value identifier — value»: "PROPERTY_1149": { "3801": "78" }, where 3801 is the identifier of a specific value and 78 is the value itself. A property with multiple values has several pairs in the mapping.

See also