Retrieve Data from Universal List or Array of Lists: lists.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: lists

Who can execute the method: a user with "Read" access permission for lists

The lists.get method returns a universal list or an array of lists.

Method Parameters

Required parameters are marked with *

Name
type

Description

IBLOCK_TYPE_ID*
string

Information block type ID.

Standard types:

  • lists — universal lists
  • bitrix_processes — processes
  • lists_socnet — group lists

In the on-premise version, you can also specify the ID of any existing custom information block type. IBLOCK_ID or IBLOCK_CODE must point to an information block of this type. Access to the operation is determined by the user's standard permissions for the information block, section, or element

A custom type is supported only when IBLOCK_ID or IBLOCK_CODE is provided. Without these parameters, the method returns lists only for types that are supported or registered in the Universal Lists module

The identifier can be obtained using the lists.get.iblock.type.id method

IBLOCK_ID
integer

Identifier of the information block

IBLOCK_CODE
string

Symbolic code of the information block

When requesting without IBLOCK_ID or IBLOCK_CODE, all lists of the specified type available to the user will be returned.

SOCNET_GROUP_ID
integer

Group identifier. Required for group lists; otherwise, an access error will occur.

The identifier can be obtained using the socialnetwork.api.workgroup.list, sonet_group.get, and sonet_group.user.groups methods

IBLOCK_ORDER
object

Object for sorting list fields in the format {"field_1": "value_1", ... "field_N": "value_N"}.

The sorting direction can take the following values:

  • asc — ascending
  • desc — descending

Allowed fields:

  • ID - list identifier
  • IBLOCK_TYPE - information block type
  • NAME - list name
  • CODE - symbolic code of the list
  • SORT - sorting
  • TIMESTAMP_X - last modification time

Default value — decs

start
integer

Parameter used for pagination control.

The result page size is always static — 50 records.

To select the second page of results, you need to pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N - 1) * 50, where N is the desired page number

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists_socnet","SOCNET_GROUP_ID":33,"IBLOCK_ORDER":{"SORT":"asc","NAME":"asc"},"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists_socnet","SOCNET_GROUP_ID":33,"IBLOCK_ORDER":{"SORT":"asc","NAME":"asc"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/lists.get
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each list item returned in result[]
        type ListItem = {
          ID: string
          TIMESTAMP_X: string
          IBLOCK_TYPE_ID: string
          LID: string
          CODE: string | null
          API_CODE: string | null
          NAME: string
          ACTIVE: string
          SORT: string
          SOCNET_GROUP_ID: string | null
        }
        
        try {
          // lists.get returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<ListItem[]>({
            method: 'lists.get',
            params: {
              IBLOCK_TYPE_ID: 'lists_socnet',
              SOCNET_GROUP_ID: 33,
              IBLOCK_ORDER: {
                SORT: 'asc',
                NAME: 'asc',
              },
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Fetched lists:', result.length, result[0]?.NAME)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function fetchLists() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // lists.get returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'lists.get',
                params: {
                  IBLOCK_TYPE_ID: 'lists_socnet',
                  SOCNET_GROUP_ID: 33,
                  IBLOCK_ORDER: {
                    SORT: 'asc',
                    NAME: 'asc',
                  },
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Fetched lists:', result.length, result[0]?.NAME)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchLists)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.lists.get(
                iblock_type_id="lists_socnet",
                socnet_group_id=33,
                iblock_order={
                    "SORT": "asc",
                    "NAME": "asc",
                },
                start=0,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'lists.get',
                    [
                        'IBLOCK_TYPE_ID' => 'lists_socnet',
                        'SOCNET_GROUP_ID' => 33,
                        'IBLOCK_ORDER' => [
                            'SORT' => 'asc',
                            'NAME' => 'asc'
                        ],
                        'start' => 0
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching lists: ' . $e->getMessage();
        }
        
BX24.callMethod(
          'lists.get',
          {
             IBLOCK_TYPE_ID: 'lists_socnet',
             SOCNET_GROUP_ID: 33,
             IBLOCK_ORDER: {
               SORT: 'asc',
               NAME: 'asc'
             }
          },
             function(result) {
                 if (result.error()) {
                    console.error(result.error());
                 } else {
                    console.log(result.data());
        
                    if (result.more()) {
                       result.next();
                    }
                 }
             }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'lists.get',
            [
                'IBLOCK_TYPE_ID' => 'lists_socnet',
                'SOCNET_GROUP_ID' => 33,
                'IBLOCK_ORDER' => [
                    'SORT' => 'asc',
                    'NAME' => 'asc'
                ],
                'start' => 0
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "lists.get", b24.Params{
        	"IBLOCK_TYPE_ID":  "lists_socnet",
        	"SOCNET_GROUP_ID": 33,
        	"IBLOCK_ORDER": b24.Params{
        		"SORT": "asc",
        		"NAME": "asc",
        	},
        	"start": 0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("lists.get: %w", err)
        }
        
        var items []struct {
        	ID           b24.ID `json:"ID"`
        	TimestampX   string `json:"TIMESTAMP_X"`
        	IblockTypeID string `json:"IBLOCK_TYPE_ID"`
        	Lid          string `json:"LID"`
        	Name         string `json:"NAME"`
        	Active       string `json:"ACTIVE"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID, it.TimestampX)
        }
        

Response Handling

HTTP Status: 200

{
            "result": [
                {
                "ID": "89",
                "TIMESTAMP_X": "05/17/2023 04:09:23 pm",
                "IBLOCK_TYPE_ID": "lists_socnet",
                "LID": "s1",
                "CODE": null,
                "API_CODE": null,
                "NAME": "Group List",
                "ACTIVE": "Y",
                "SORT": "500",
                "LIST_PAGE_URL": null,
                "DETAIL_PAGE_URL": null,
                "SECTION_PAGE_URL": null,
                "CANONICAL_PAGE_URL": null,
                "PICTURE": null,
                "DESCRIPTION": "",
                "DESCRIPTION_TYPE": "text",
                "RSS_TTL": "24",
                "RSS_ACTIVE": "Y",
                "RSS_FILE_ACTIVE": "N",
                "RSS_FILE_LIMIT": null,
                "RSS_FILE_DAYS": null,
                "RSS_YANDEX_ACTIVE": "N",
                "XML_ID": null,
                "TMP_ID": null,
                "INDEX_ELEMENT": "Y",
                "INDEX_SECTION": "N",
                "WORKFLOW": "N",
                "BIZPROC": "Y",
                "SECTION_CHOOSER": "L",
                "LIST_MODE": null,
                "RIGHTS_MODE": "E",
                "SECTION_PROPERTY": null,
                "PROPERTY_INDEX": null,
                "VERSION": "1",
                "LAST_CONV_ELEMENT": "0",
                "SOCNET_GROUP_ID": "33",
                "EDIT_FILE_BEFORE": null,
                "EDIT_FILE_AFTER": null,
                "SECTIONS_NAME": "Sections",
                "SECTION_NAME": "Section",
                "ELEMENTS_NAME": "Elements",
                "ELEMENT_NAME": "Element",
                "REST_ON": "N",
                "FULLTEXT_INDEX": "N",
                "EXTERNAL_ID": null,
                "LANG_DIR": "/",
                "SERVER_NAME": null
                }
            ],
            "total": 1,
            "time": {
                "start": 1764694297,
                "finish": 1764694298.018582,
                "duration": 1.0185821056365967,
                "processing": 1,
                "date_start": "2025-12-02T15:51:37+01:00",
                "date_finish": "2025-12-02T15:51:38+01:00",
                "operating_reset_at": 1764694897,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
array

Data of the list or array of lists.

An empty array means that no lists were found

total
integer

Total number of lists

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error":"ERROR_REQUIRED_PARAMETERS_MISSING",
            "error_description":"Required parameter `X` is missing"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

ERROR_REQUIRED_PARAMETERS_MISSING

Required parameter X is missing

Required parameter is missing

ACCESS_DENIED

Access denied

Insufficient rights to read the list

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

The REST API is available only on commercial plans. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning