Get the list of resources booking.v1.resource.list

Scope: booking

Who can execute the method: any user

The method booking.v1.resource.list returns a list of resources based on a filter. It is an implementation of the listing method for resources.

Method Parameters

FILTER
object

Object for filtering the list of resources in the format {"field_1": "value_1", ... "field_N": "value_N"}, where

field_N — field of the resource for filtering
value_N — value of the field

ORDER
object

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

field_N — field of the resource for sorting
value_N — sorting direction

The sorting direction can take the following values:

asc — ascending
desc — descending

The default value is {ID: 'ASC'}

Filter Parameters

Name `type`	Description
searchQuery `string`	Search query. Searches by substring in the resource name
isMain `string`	Filter by resource display setting. Possible values: `Y` — in schedule columns `N` — when resources overlap
typeId `integer`	Identifier of the resource type. The list of available types can be obtained using the method booking.v1.resourceType.list
name `string`	Name of the resource
description `string`	Description of the resource

Use either searchQuery for substring search or name for exact match search.

Order Parameters

Name `type`	Description
id `string`	Sort by identifier
name `string`	Sort by name

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"searchQuery":"car","isMain":"Y","typeId":1},"order":{"id":"ASC","name":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.resource.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"searchQuery":"car","isMain":"Y","typeId":1},"order":{"id":"ASC","name":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/booking.v1.resource.list

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'booking.v1.resource.list',
            {
              filter: {
                "searchQuery": "car",
                "isMain": "Y",
                "typeId": 1
              },
              order: {
                id: "ASC",
                name: "DESC"
              }
            },
            (progress) => { console.log('Progress:', progress) }
          );
          const items = response.getData() || [];
          for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('booking.v1.resource.list', {
            filter: {
              "searchQuery": "car",
              "isMain": "Y",
              "typeId": 1
            },
            order: {
              id: "ASC",
              name: "DESC"
            }
          }, 'ID');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('booking.v1.resource.list', {
            filter: {
              "searchQuery": "car",
              "isMain": "Y",
              "typeId": 1
            },
            order: {
              id: "ASC",
              name: "DESC"
            }
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'booking.v1.resource.list',
                    [
                        'filter' => [
                            'searchQuery' => 'car',
                            'isMain'      => 'Y',
                            'typeId'      => 1,
                        ],
                        'order' => [
                            'id'   => 'ASC',
                            'name' => 'DESC',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error calling booking.v1.resource.list: ' . $e->getMessage();
        }

BX24.callMethod(
            "booking.v1.resource.list",
            {
                filter: {
                    "searchQuery": "car",
                    "isMain": "Y",
                    "typeId": 1
                },
                order: {
                    id: "ASC",
                    name: "DESC"
                }
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'booking.v1.resource.list',
            [
                'filter' => [
                    'searchQuery' => 'car',
                    'isMain' => 'Y',
                    'typeId' => 1
                ],
                'order' => [
                    'id' => 'ASC',
                    'name' => 'DESC'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "resource": [
                    {
                        "confirmationCounterDelay": 10800,
                        "confirmationNotificationDelay": 86400,
                        "confirmationNotificationRepetitions": null,
                        "confirmationNotificationRepetitionsInterval": 10800,
                        "delayedCounterDelay": 300,
                        "delayedNotificationDelay": 300,
                        "description": null,
                        "id": 5,
                        "infoNotificationDelay": null,
                        "isConfirmationNotificationOn": "Y",
                        "isDelayedNotificationOn": "Y",
                        "isFeedbackNotificationOn": "N",
                        "isInfoNotificationOn": "Y",
                        "isMain": "Y",
                        "isReminderNotificationOn": "Y",
                        "name": "Sedan 1",
                        "reminderNotificationDelay": -1,
                        "templateTypeConfirmation": "inanimate",
                        "templateTypeDelayed": "inanimate",
                        "templateTypeFeedback": "inanimate",
                        "templateTypeInfo": "inanimate",
                        "templateTypeReminder": "base",
                        "typeId": 1
                    },
                    {
                        "confirmationCounterDelay": 10800,
                        "confirmationNotificationDelay": 86400,
                        "confirmationNotificationRepetitions": null,
                        "confirmationNotificationRepetitionsInterval": 10800,
                        "delayedCounterDelay": 300,
                        "delayedNotificationDelay": 300,
                        "description": null,
                        "id": 7,
                        "infoNotificationDelay": null,
                        "isConfirmationNotificationOn": "Y",
                        "isDelayedNotificationOn": "Y",
                        "isFeedbackNotificationOn": "N",
                        "isInfoNotificationOn": "Y",
                        "isMain": "Y",
                        "isReminderNotificationOn": "Y",
                        "name": "Sedan 2",
                        "reminderNotificationDelay": -1,
                        "templateTypeConfirmation": "inanimate",
                        "templateTypeDelayed": "inanimate",
                        "templateTypeFeedback": "inanimate",
                        "templateTypeInfo": "inanimate",
                        "templateTypeReminder": "base",
                        "typeId": 1
                    }
                ]
            },
            "time": {
                "start": 1746540454.261779,
                "finish": 1746540454.303483,
                "duration": 0.04170393943786621,
                "processing": 0.009412050247192383,
                "date_start": "2025-05-06T17:07:34+02:00",
                "date_finish": "2025-05-06T17:07:34+02:00",
                "operating_reset_at": 1746541054,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

Root element of the response.

Contains an array of objects with information about resources. The structure is described below

time
time

Information about the execution time of the request

Resource

confirmationCounterDelay `integer`	Time until the record in seconds, after which the unconfirmed record counter lights up
confirmationDelay `integer`	Time until the record in seconds, when the client receives the first message for confirmation
confirmationRepetitions `integer`	Number of messages that the client receives for confirmation, excluding the first one
confirmationRepetitionsInterval `integer`	Interval between confirmation messages, in seconds
delayedCounterDelay `integer`	Time in seconds after which to turn on the counter in the calendar
delayedDelay `integer`	Time in seconds after which to send a message to the client about the delay
description `string`	Description of the resource
id `integer`	Identifier of the resource
infoDelay `integer`	Delay in seconds after which the client receives a message about the record
isConfirmationNotificationOn `string`	Automatic confirmation of the record. Possible values: `Y` — enabled `N` — disabled
isDelayedNotificationOn `string`	Reminder when the client is late. Possible values: `Y` — enabled `N` — disabled
isFeedbackNotificationOn `string`	Request for feedback. Possible values: `Y` — enabled `N` — disabled
isInfoNotificationOn `string`	Message to the client about the record. Possible values: `Y` — enabled `N` — disabled
isMain `string`	How to display the resource. Possible values: `Y` — in schedule columns `N` — when resources overlap
isReminderNotificationOn `string`	Reminder about the record. Possible values: `Y` — enabled `N` — disabled
name `string`	Name of the resource
reminderDelay `integer`	Time until the record in seconds, for which the client receives a reminder about the record. Value `-1` — in the morning on the day of the record
templateTypeConfirmation `string`	Type of the confirmation message template. Possible values: `inanimate` — template for booking equipment and premises `animate` — template for appointments with specialists
templateTypeDelayed `string`	Type of the delay message template. Possible values: `inanimate` — template for booking equipment and premises `animate` — template for appointments with specialists
templateTypeFeedback `string`	Type of the feedback request message template. Possible values: `inanimate` — template for booking equipment and premises `animate` — template for appointments with specialists
templateTypeInfo `string`	Type of the record message template. Possible values: `inanimate` — template for booking equipment and premises `animate` — template for appointments with specialists
templateTypeReminder `string`	Type of the reminder message template. Possible values: `base`
typeId `integer`	Identifier of the resource type. Information about the type can be obtained using the method booking.v1.resourceType.get

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Invalid value {ASC} to match with parameter {order}. Should be value of type array."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`100`	`Invalid value to match with parameter {order}. Should be value of type array`	The parameter `order` is not an object
`100`	`Invalid value to match with parameter {filter}. Should be value of type array`	The parameter `filter` is not an object

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get resource

Delete resource

Get the list of resources booking.v1.resource.list

Method ParametersMethod Parameters

Filter ParametersFilter Parameters

Order ParametersOrder Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

ResourceResource

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning