Get a list of resource types booking.v1.resourceType.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
bookingWho 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 |
An object for filtering the list of resource types in the format
|
|
ORDER |
An object for sorting the list of resource types in the format
The sort direction can take the following values:
The default value is |
Filter Parameters
|
Name |
Description |
|
searchQuery |
Search query. Searches for a substring in the resource type name |
|
moduleId |
Resource type module |
|
name |
Resource type name |
|
code |
Resource type code |
Use either searchQuery for substring search or name for exact match search.
Order Parameters
|
Name |
Description |
|
id |
Sort by identifier |
|
name |
Sort by name |
|
code |
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
// 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 the payload returned in result (match the "response handling" section of the page)
type ResourceTypeResult = {
resource: ResourceType[]
}
type ResourceType = {
code: string
confirmationCounterDelay: number
confirmationNotificationDelay: number
confirmationNotificationRepetitions: number | null
confirmationNotificationRepetitionsInterval: number
delayedCounterDelay: number
delayedNotificationDelay: number
id: number
infoNotificationDelay: number | null
isConfirmationNotificationOn: string
isDelayedNotificationOn: string
isFeedbackNotificationOn: string
isReminderNotificationOn: string
name: string
reminderNotificationDelay: number
templateTypeConfirmation: string
templateTypeDelayed: string
templateTypeFeedback: string
templateTypeReminder: string
}
try {
// booking.v1.resourceType.list 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<ResourceTypeResult>({
method: 'booking.v1.resourceType.list',
params: {
filter: {
searchQuery: 'res',
moduleId: 'booking',
},
order: {
id: 'ASC',
name: 'DESC',
code: 'DESC',
},
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('Resource types:', result.resource.length, result.resource)
}
} 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 listResourceTypes() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// booking.v1.resourceType.list 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: 'booking.v1.resourceType.list',
params: {
filter: {
searchQuery: 'res',
moduleId: 'booking',
},
order: {
id: 'ASC',
name: 'DESC',
code: 'DESC',
},
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('Resource types:', result.resource.length, result.resource)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listResourceTypes)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.booking.v1.resource_type.list(
filter={
"searchQuery": "res",
"moduleId": "booking",
},
order={
"id": "ASC",
"name": "DESC",
"code": "DESC",
},
).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(
'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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "booking.v1.resourceType.list", b24.Params{
"FILTER": b24.Params{
"searchQuery": "res",
"moduleId": "booking",
},
"ORDER": b24.Params{
"id": "ASC",
"name": "DESC",
"code": "DESC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("booking.v1.resourceType.list: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)
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 |
Description |
|
result |
The root element of the response. Contains an array of objects with information about resource types. The structure is described below |
|
time |
Information about the request execution time |
Type
|
code |
Resource type code |
|
confirmationCounterDelay |
Time until the record is made in seconds, after which the unconfirmed record counter lights up |
|
confirmationDelay |
Time until the record in seconds when the client receives the first message for confirmation |
|
confirmationRepetitions |
Number of messages sent to the client for confirmation, excluding the first one |
|
confirmationRepetitionsInterval |
Interval between confirmation messages, in seconds |
|
delayedCounterDelay |
Time in seconds after which to turn on the counter in the calendar |
|
delayedDelay |
Time in seconds after which to send a message to the client about being late |
|
id |
Resource type identifier |
|
infoDelay |
Delay in seconds after which the client receives a message about the record |
|
isConfirmationNotificationOn |
Automatic confirmation of the record. Possible values:
|
|
isDelayedNotificationOn |
Reminder when the client is late. Possible values:
|
|
isFeedbackNotificationOn |
Feedback request. Possible values:
|
|
isReminderNotificationOn |
Reminder about the record. Possible values:
|
|
name |
Resource name |
|
reminderDelay |
Time until the record in seconds, for which the client receives a reminder about the record. |
|
templateTypeConfirmation |
Type of confirmation message template. Possible values:
|
|
templateTypeDelayed |
Type of delayed message template. Possible values:
|
|
templateTypeFeedback |
Type of feedback request message template. Possible values:
|
|
templateTypeReminder |
Type of reminder message template. Possible values: |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "Invalid value {ASC} to match with parameter {order}. Should be value of type array."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
|
The |
|
|
|
The |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |