Get User Availability from calendar.accessibility.get

Scope: calendar

Who can execute the method: any user

This method retrieves the availability of users from the list.

Method Parameters

Required parameters are marked with *

Name `type`	Description
users* `array`	Array of user IDs
from* `date`	Start date of the period for determining availability in the format `YYYY-MM-DD`. For example, `2024-06-20`
to* `date`	End date of the period for determining availability in the format `YYYY-MM-DD`. For example, `2024-12-20`

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

try
        {
        	const response = await $b24.callMethod(
        		'calendar.accessibility.get',
        		{
        			from: '2024-06-20',
        			to: '2024-12-20',
        			users: [1, 2, 34]
        		}
        	);
        	
        	const result = response.getData().result;
        	// Your logic for processing data
        	processResult(result);
        }
        catch( error )
        {
        	console.error('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>';

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
type

Description

result
object

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 `type`	Description
ID `string`	Event ID
NAME `string`	Event name
DATE_FROM `datetime`	Start date and time of the event
DATE_TO `datetime`	End date and time of the event
DATE_FROM_TS_UTC `string`	Start date and time of the event in UTC in timestamp format
DATE_TO_TS_UTC `string`	End date and time of the event in UTC in timestamp format
~USER_OFFSET_FROM `integer`	Time offset of the start of the event relative to UTC in seconds
~USER_OFFSET_TO `integer`	Time offset of the end of the event relative to UTC in seconds
DT_SKIP_TIME `integer`	Flag indicating that the event lasts all day. Possible values: `Y` — all day `N` — not all day
TZ_FROM `integer`	Time zone of the event start date
TZ_TO `integer`	Time zone of the event end date
ACCESSIBILITY `integer`	Availability of event participants. Possible values: `busy` — busy `absent` — absent `quest` — tentative `free` — free
IMPORTANCE `string`	Importance of the event. Possible values: `high` — high `normal` — medium `low` — low
EVENT_TYPE `string`	Some events contain information about how they were created. An event can be created through: `#shared#` — calendar slots `#shared_crm#` — CRM slots `#collab#` — collaboration `#shared_collab#` — collaboration slots

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "The required parameter "from" for the method "calendar.accessibility.get" is not set."
        }

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	Error Message	Description
Empty string	The required parameter "from" for the method "calendar.accessibility.get" is not set.	The required parameter `from` is missing
Empty string	The required parameter "to" for the method "calendar.accessibility.get" is not set.	The required parameter `to` is missing
Empty string	The required parameter "users" for the method "calendar.accessibility.get" is not set.	The required parameter `users` is missing
Empty string	Access denied	Access to the method is prohibited for external users

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

Set Participation Status in Event for Current User

Overview of Events

Get User Availability from calendar.accessibility.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Event ObjectEvent Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning