Get User Task Counters tasks.task.counters.get
Scope:
taskWho can execute the method: any user
The method tasks.task.counters.get retrieves task counter values for the specified user.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
userId |
The identifier of the user for whom to retrieve counters. By default, the current user is used. The user identifier can be obtained using the get user list method. |
|
groupId |
The identifier of the group for which to retrieve task counters. Pass You can obtain the identifier using the create new group method or the get group list method. |
|
type |
The role for which to retrieve counters. Possible roles:
By default, the role |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"userId":547,"groupId":0,"type":"view_all"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.task.counters.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"userId":547,"groupId":0,"type":"view_all","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.task.counters.get
try
{
const response = await $b24.callMethod(
'tasks.task.counters.get',
{
userId: 547,
groupId: 0,
type: 'view_all',
}
);
const result = response.getData().result;
console.log('Task counters:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'tasks.task.counters.get',
[
'userId' => 547,
'groupId' => 0,
'type' => 'view_all'
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching task counters: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.task.counters.get',
{
userId: 547,
groupId: 0,
type: 'view_all'
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.task.counters.get',
[
'userId' => 547,
'groupId' => 0,
'type' => 'view_all'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"expired": {
"counter": 1,
"code": 6291456
},
"new_comments": {
"counter": 7,
"code": 12582912
}
},
"total": 1,
"time": {
"start": 1758868152,
"finish": 1758868152.929809,
"duration": 0.9298090934753418,
"processing": 0,
"date_start": "2025-09-26T09:29:12+02:00",
"date_finish": "2025-09-26T09:29:12+02:00",
"operating_reset_at": 1758868752,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An object where the key is the counter name and the value is an object with counter description. Counter values:
Returns an empty array |
|
total |
Currently not used. Always returns the value |
|
time |
Information about the request execution time. |
Counter Object
|
Name |
Description |
|
counter |
The count. |
|
code |
Internal counter code. |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "Group not found or access denied. (internal error)"
}
|
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 |
|
|
Invalid value {value} to match with parameter {userId}. Should be a value of type int. |
The value of incorrect type is specified in the |
|
|
Group not found or access denied. (internal error) |
The group does not exist or access is denied. |
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 |