Get User Availability from calendar.accessibility.get
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:
calendarWho can execute the method: any user
This method retrieves the availability of users from the list.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
users* |
Array of user IDs |
|
from* |
Start date of the period for determining availability in the format For example, |
|
to* |
End date of the period for determining availability in the format For example, |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"from":"2024-06-20","to":"2024-12-20","users":[1,2,34]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.accessibility.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"from":"2024-06-20","to":"2024-12-20","users":[1,2,34],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.accessibility.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
type CalendarEventItem = {
ID: string
NAME: string
DATE_FROM: string
DATE_TO: string
DATE_FROM_TS_UTC: string
DATE_TO_TS_UTC: string
'~USER_OFFSET_FROM': number
'~USER_OFFSET_TO': number
DT_SKIP_TIME: 'Y' | 'N'
TZ_FROM: string
TZ_TO: string
ACCESSIBILITY: 'busy' | 'absent' | 'quest' | 'free'
IMPORTANCE: 'high' | 'normal' | 'low'
EVENT_TYPE: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type AccessibilityGetResult = Record<string, CalendarEventItem[]>
try {
const response = await $b24.actions.v2.call.make<AccessibilityGetResult>({
method: 'calendar.accessibility.get',
params: {
from: '2024-06-20',
to: '2024-12-20',
users: [1, 2, 34],
},
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
for (const [userId, events] of Object.entries(result)) {
console.info(`User ${userId}:`, events.map(e => `${e.NAME} (${e.ACCESSIBILITY})`))
}
}
} 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 getAccessibility() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'calendar.accessibility.get',
params: {
from: '2024-06-20',
to: '2024-12-20',
users: [1, 2, 34],
},
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
for (const [userId, events] of Object.entries(result)) {
console.info(`User ${userId}:`, events.map(e => `${e.NAME} (${e.ACCESSIBILITY})`))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getAccessibility)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.calendar.accessibility.get(
users=[
1,
2,
34,
],
from_date="2024-06-20",
to="2024-12-20",
).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(
'calendar.accessibility.get',
[
'from' => '2024-06-20',
'to' => '2024-12-20',
'users' => [1, 2, 34]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting calendar accessibility: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.accessibility.get',
{
from: '2024-06-20',
to: '2024-12-20',
users: [1, 2, 34]
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.accessibility.get',
[
'from' => '2024-06-20',
'to' => '2024-12-20',
'users' => [1, 2, 34]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "calendar.accessibility.get", b24.Params{
"from": "2024-06-20",
"to": "2024-12-20",
"users": []int{1, 2, 34},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("calendar.accessibility.get: %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": {
"1": [
{
"ID": "1213",
"NAME": "Event name",
"DATE_FROM": "02.12.2024 11:00:00",
"DATE_TO": "02.12.2024 12:00:00",
"DATE_FROM_TS_UTC": "1733158800",
"DATE_TO_TS_UTC": "1733162400",
"~USER_OFFSET_FROM": -21600,
"~USER_OFFSET_TO": -21600,
"DT_SKIP_TIME": "N",
"TZ_FROM": "America/Managua",
"TZ_TO": "America/Managua",
"ACCESSIBILITY": "busy",
"IMPORTANCE": "normal",
"EVENT_TYPE": "#collab#"
},
{
"ID": "1216",
...
}
],
"2": [
{
"ID": 1,
...
},
{
"ID": 2,
...
}
],
"34": []
}
}
Returned Data
|
Name |
Description |
|
result |
The result contains an object. The key of the object is the user ID from the request. The value is an array of objects, each describing an event in which the user is busy during the specified period |
Event Object
|
Name |
Description |
|
ID |
Event ID |
|
NAME |
Event name |
|
DATE_FROM |
Start date and time of the event |
|
DATE_TO |
End date and time of the event |
|
DATE_FROM_TS_UTC |
Start date and time of the event in UTC in timestamp format |
|
DATE_TO_TS_UTC |
End date and time of the event in UTC in timestamp format |
|
~USER_OFFSET_FROM |
Time offset of the start of the event relative to UTC in seconds |
|
~USER_OFFSET_TO |
Time offset of the end of the event relative to UTC in seconds |
|
DT_SKIP_TIME |
Flag indicating that the event lasts all day. Possible values:
|
|
TZ_FROM |
Time zone of the event start date |
|
TZ_TO |
Time zone of the event end date |
|
ACCESSIBILITY |
Availability of event participants. Possible values:
|
|
IMPORTANCE |
Importance of the event. Possible values:
|
|
EVENT_TYPE |
Some events contain information about how they were created. An event can be created through:
|
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "The required parameter \"from\" for the method \"calendar.accessibility.get\" is not set."
}
|
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 |
Error Message |
Description |
|
Empty value |
The required parameter "from" for the method "calendar.accessibility.get" is not set. |
The required parameter |
|
Empty value |
The required parameter "to" for the method "calendar.accessibility.get" is not set. |
The required parameter |
|
Empty value |
The required parameter "users" for the method "calendar.accessibility.get" is not set. |
The required parameter |
|
Empty value |
Access denied |
Access to the method is prohibited for external users |
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 |