Check Access to Task tasks.task.getaccess
Scope:
taskWho can execute the method: any user
The method tasks.task.getaccess checks the available actions for users on a task.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
taskId* |
Task identifier. The task identifier can be obtained when creating a new task or by using the get task list method |
|
users |
Array of user identifiers for which access needs to be checked. By default, the current user is used. The user identifier can be obtained using the get user list method |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"taskId":8017,"users":[503,547]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.task.getaccess
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"taskId":8017,"users":[503,547],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.task.getaccess
try
{
const response = await $b24.callMethod(
'tasks.task.getaccess',
{
taskId: 8017,
users: [503, 547],
}
);
const result = response.getData().result;
console.log('Access data:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'tasks.task.getaccess',
[
'taskId' => 8017,
'users' => [503, 547]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.task.getaccess',
{
'taskId': 8017,
'users': [503, 547]
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.task.getaccess',
[
'taskId' => 8017,
'users' => [503, 547]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"allowedActions": {
"503": {
"ACCEPT": false,
"DECLINE": false,
"COMPLETE": true,
"APPROVE": false,
"DISAPPROVE": false,
"START": false,
"PAUSE": true,
"DELEGATE": true,
"REMOVE": true,
"EDIT": true,
"DEFER": false,
"RENEW": false,
"CREATE": true,
"CHANGE_DEADLINE": true,
"CHECKLIST_ADD_ITEMS": true,
"ADD_FAVORITE": false,
"DELETE_FAVORITE": true,
"RATE": true,
"TAKE": false,
"EDIT.ORIGINATOR": false,
"CHECKLIST.REORDER": true,
"ELAPSEDTIME.ADD": true,
"DAYPLAN.TIMER.TOGGLE": true,
"EDIT.PLAN": true,
"CHECKLIST.ADD": true,
"FAVORITE.ADD": false,
"FAVORITE.DELETE": true
},
"547": {
"ACCEPT": false,
"DECLINE": false,
"COMPLETE": false,
"APPROVE": false,
"DISAPPROVE": false,
// ...
"FAVORITE.DELETE": false
}
}
},
"time": {
"start": 1758177122.815386,
"finish": 1758177122.911002,
"duration": 0.09561586380004883,
"processing": 0.054609060287475586,
"date_start": "2025-09-18T09:32:02+02:00",
"date_finish": "2025-09-18T09:32:02+02:00",
"operating_reset_at": 1758177722,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains an object with a description of available actions for each user |
|
allowedActions |
An object where the key is the If the user executing the method does not have access to the task, an empty array For non-existent users from the |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error":"100",
"error_description":"Invalid value {} to match with parameter {users}. Should be value of type array."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
wrong task id |
The value in the |
|
|
Invalid value {} to match with parameter {users}. Should be value of type array. |
An incorrect value was specified in the |
|
|
CTaskItem All parameters in the constructor must have real class type |
The required parameter |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |