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
iblockId (path) string yes — Numeric list identifier IBLOCK_ID or symbolic code IBLOCK_CODE
elementId (path) number yes — Element identifier, a positive integer
iblockTypeId (query) string no lists Infoblock type. Values:
lists — regular lists, default
lists_socnet — workgroup lists
bitrix_processes — service workflows
select (query) string no — Comma-separated list of returned fields. A custom property is requested as PROPERTY_<id>. Example: ?select=ID,NAME,PROPERTY_1149

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.

Field Type Description
success boolean Always true on success
data.ID string Element identifier
data.IBLOCK_ID string List identifier
data.NAME string Element name
data.IBLOCK_SECTION_ID string or null Section identifier, null for an element outside sections
data.CODE string or null Symbolic code of the element, null if not set
data.BP_PUBLISHED string Publication flag: Y or N
data.CREATED_BY string Creator identifier. Look up — GET /v1/users
data.DATE_CREATE string Creation date and time
data.MODIFIED_BY string Identifier of the author of the last change. Look up — GET /v1/users
data.USER_NAME string Creator display name
data.PROPERTY_<id> object Custom 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
400 INVALID_PARAMS elementId is not a positive integer
400 INVALID_IBLOCK_TYPE iblockTypeId is not in the set lists, bitrix_processes, lists_socnet
404 ELEMENT_NOT_FOUND An element with the given elementId was not found in the list
403 BITRIX_ACCESS_DENIED No access to the list, or the list does not exist
409 LISTS_MODULE_NOT_ENABLED The «Lists» module is not enabled on the portal
403 SCOPE_DENIED The key lacks the lists scope
401 TOKEN_MISSING The 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