Get a list of resource types booking.v1.resourceType.list

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: booking

Who can execute the method: any user

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

Method Parameters

FILTER
object

An object for filtering the list of resource types in the format {"field_1": "value_1", ... "field_N": "value_N"}, where

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

ORDER
object

An object for sorting the list of resource types in the format {"field_1": "value_1", ... "field_N": "value_N"}, where

  • field_N — field of the resource type for sorting
  • value_N — sort direction

The sort 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 for a substring in the resource type name

moduleId
string

Resource type module

name
string

Resource type name

code
string

Resource type code

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
string

Sort by code

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"searchQuery":"res","moduleId":"booking"},"order":{"id":"ASC","name":"DESC","code":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.resourceType.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"searchQuery":"res","moduleId":"booking"},"order":{"id":"ASC","name":"DESC","code":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/booking.v1.resourceType.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.resourceType.list',
            {
              filter: {
                "searchQuery": "res",
                "moduleId": "booking"
              },
              order: {
                id: "ASC",
                name: "DESC",
                code: "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.resourceType.list', {
            filter: {
              "searchQuery": "res",
              "moduleId": "booking"
            },
            order: {
              id: "ASC",
              name: "DESC",
              code: "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.resourceType.list', {
            filter: {
              "searchQuery": "res",
              "moduleId": "booking"
            },
            order: {
              id: "ASC",
              name: "DESC",
              code: "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.resourceType.list',
                    [
                        'filter' => [
                            'searchQuery' => 'res',
                            'moduleId'    => 'booking',
                        ],
                        'order'  => [
                            'id'   => 'ASC',
                            'name' => 'DESC',
                            'code' => '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 listing resource types: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "booking.v1.resourceType.list",
            {
                filter: {
                        "searchQuery": "res",
                        "moduleId": "booking"
            },
            order: {
                    id: "ASC",
                    name: "DESC",
                    code: "DESC"
                }
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'booking.v1.resourceType.list',
            [
                'filter' => [
                    'searchQuery' => 'res',
                    'moduleId' => 'booking'
                ],
                'order' => [
                    'id' => 'ASC',
                    'name' => 'DESC',
                    'code' => 'DESC'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "resource": [
                    {
                        "code": "equipment",
                        "confirmationCounterDelay": 10800,
                        "confirmationNotificationDelay": 86400,
                        "confirmationNotificationRepetitions": null,
                        "confirmationNotificationRepetitionsInterval": 10800,
                        "delayedCounterDelay": 300,
                        "delayedNotificationDelay": 300,
                        "id": 3,
                        "infoNotificationDelay": null,
                        "isConfirmationNotificationOn": "Y",
                        "isDelayedNotificationOn": "Y",
                        "isFeedbackNotificationOn": "N",
                        "isReminderNotificationOn": "Y",
                        "name": "resource",
                        "reminderNotificationDelay": -1,
                        "templateTypeConfirmation": "inanimate",
                        "templateTypeDelayed": "inanimate",
                        "templateTypeFeedback": "inanimate",
                        "templateTypeReminder": "base"
                    },
                    {
                        "code": "expert",
                        "confirmationCounterDelay": 10800,
                        "confirmationNotificationDelay": 86400,
                        "confirmationNotificationRepetitions": null,
                        "confirmationNotificationRepetitionsInterval": 10800,
                        "delayedCounterDelay": 300,
                        "delayedNotificationDelay": 300,
                        "id": 5,
                        "infoNotificationDelay": null,
                        "isConfirmationNotificationOn": "Y",
                        "isDelayedNotificationOn": "Y",
                        "isFeedbackNotificationOn": "N",
                        "isReminderNotificationOn": "Y",
                        "name": "resource 2",
                        "reminderNotificationDelay": -1,
                        "templateTypeConfirmation": "animate",
                        "templateTypeDelayed": "animate",
                        "templateTypeFeedback": "animate",
                        "templateTypeReminder": "base"
                    }
                ]
            },
            "time": {
                "start": 1746540063.20403,
                "finish": 1746540063.261006,
                "duration": 0.0569760799407959,
                "processing": 0.020888090133666992,
                "date_start": "2025-05-06T17:01:03+02:00",
                "date_finish": "2025-05-06T17:01:03+02:00",
                "operating_reset_at": 1746540663,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

The root element of the response.

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

time
time

Information about the request execution time

Type

code
string

Resource type code

confirmationCounterDelay
integer

Time until the record is made 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 sent to the client 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 being late

id
integer

Resource type identifier

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

Feedback request. Possible values:

  • Y — enabled
  • N — disabled

isReminderNotificationOn
string

Reminder about the record. Possible values:

  • Y — enabled
  • N — disabled

name
string

Resource name

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 confirmation message template. Possible values:

  • inanimate — template for booking equipment and rooms
  • animate — template for appointments with specialists

templateTypeDelayed
string

Type of delayed message template. Possible values:

  • inanimate — template for booking equipment and rooms
  • animate — template for appointments with specialists

templateTypeFeedback
string

Type of feedback request message template. Possible values:

  • inanimate — template for booking equipment and rooms
  • animate — template for appointments with specialists

templateTypeReminder
string

Type of reminder message template. Possible values: base

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 order parameter is not an object

100

Invalid value to match with parameter {filter}. Should be value of type array

The filter parameter 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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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 "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

Previous
Get Resource Type
Next
Delete Resource Type