Get the List of Colleagues for the Current User im.department.colleagues.list

Scope: im

Who can execute the method: any intranet user, except bots

The method im.department.colleagues.list retrieves the list of colleagues for the current user. For a manager, the method will return a list of subordinates and all supervisors.

Method Parameters

Name `type`	Description
USER_DATA `string`	Return detailed user data. Possible values: `Y` — yes `N` — no
OFFSET `integer`	Offset for user selection
LIMIT `integer`	Number of items in the selection. Default is `10`. Maximum value is `50`

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 '{"USER_DATA":"Y","OFFSET":0,"LIMIT":5}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.department.colleagues.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"USER_DATA":"Y","OFFSET":0,"LIMIT":5,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.department.colleagues.list

try
        {
            const response = await $b24.callMethod(
                'im.department.colleagues.list',
                {
                    USER_DATA: 'Y',
                    OFFSET: 0,
                    LIMIT: 5,
                }
            );
        
            console.log(response.getData().result);
            console.log(response.getData().total);
            console.log(response.getData().next);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.department.colleagues.list',
                    [
                        'USER_DATA' => 'Y',
                        'OFFSET' => 0,
                        'LIMIT' => 5,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.department.colleagues.list',
            {
                USER_DATA: 'Y',
                OFFSET: 0,
                LIMIT: 5,
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                    console.log(result.total());
                    console.log(result.answer.next);
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.department.colleagues.list',
            [
                'USER_DATA' => 'Y',
                'OFFSET' => 0,
                'LIMIT' => 5,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

When USER_DATA = 'N':

{
            "result": [9,547,408,103,290],
            "next": 5,
            "total": 7,
            "time": {
                "start": 1772520802,
                "finish": 1772520802.36194,
                "duration": 0.3619399070739746,
                "processing": 0,
                "date_start": "2026-03-03T09:53:22+01:00",
                "date_finish": "2026-03-03T09:53:22+01:00",
                "operating_reset_at": 1772521402,
                "operating": 0
            }
        }

When USER_DATA = 'Y':

{
            "result": [
                {
                    "id": 9,
                    "active": true,
                    "name": "Anna Smith",
                    "first_name": "Anna",
                    "last_name": "Smith",
                    "work_position": "Project Manager",
                    "color": "#58cc47",
                    "avatar": "https://mysite.com/upload/avatars/anna-smith.jpg",
                    "avatar_hr": "https://mysite.com/upload/avatars/anna-smith.jpg",
                    "gender": "F",
                    "birthday": "",
                    "extranet": false,
                    "network": false,
                    "bot": false,
                    "connector": false,
                    "external_auth_id": "socservices",
                    "status": "online",
                    "idle": false,
                    "last_activity_date": "2023-03-10T17:16:44+01:00",
                    "mobile_last_date": false,
                    "desktop_last_date": false,
                    "absent": false,
                    "departments": [
                        1,
                        667
                    ],
                    "phones": false,
                    "bot_data": null,
                    "type": "user",
                    "website": "",
                    "email": "anna.smith@mysite.com"
                },
                ... // description for each user
            ],
            "next": 5,
            "total": 7,
            "time": {
                "start": 1772521273,
                "finish": 1772521273.83899,
                "duration": 0.8389899730682373,
                "processing": 0,
                "date_start": "2026-03-03T10:01:13+01:00",
                "date_finish": "2026-03-03T10:01:13+01:00",
                "operating_reset_at": 1772521873,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `array`	List of users. When `USER_DATA = 'N'`, contains user IDs When `USER_DATA = 'Y'`, contains user objects (detailed description)
total `integer`	Total number of users in the selection
next `integer`	Offset for retrieving the next page. This field is returned if there is a next page
time `time`	Information about the execution time of the request

User Object

Name `type`	Description
id `integer`	User identifier
active `boolean`	User activity status
name `string`	User's full name
first_name `string`	User's first name
last_name `string`	User's last name
work_position `string`	User's job title
color `string`	User's color in hex format
avatar `string`	Link to the avatar
avatar_hr `string`	Link to the high-resolution avatar
gender `string`	User's gender
birthday `string`	Birthday in `DD-MM` format or an empty string
extranet `boolean`	External user status
network `boolean`	Bitrix24 Network user status
bot `boolean`	Bot status
connector `boolean`	Open Channels user status
external_auth_id `string`	External authorization code
status `string`	User status
idle `datetime`	User's idle date or `false`
last_activity_date `datetime`	User's last activity date
mobile_last_date `datetime`	User's last activity date in the mobile app or `false`
desktop_last_date `datetime`	User's last activity date in the desktop app or `false`
absent `datetime`	User's absence end date or `false`
departments `array`	Array of department identifiers
phones `object`	User's phones or `false` (detailed description)
bot_data `object`	Bot data or `null`
type `string`	User type
website `string`	User's website
email `string`	User's email

Object phones

Name `type`	Description
personal_mobile `string`	Mobile phone
inner_phone `string`	Internal phone

Error Handling

HTTP Status: 403

{
            "error": "ACCESS_ERROR",
            "error_description": "Only intranet users have access to this method."
        }

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

Status	Code	Description	Value
`403`	`ACCESS_ERROR`	Only intranet users have access to this method	The method is not available for extranet users and bots

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

Get List of Department Employees

Get Counters

Get the List of Colleagues for the Current User im.department.colleagues.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

User ObjectUser Object

Object phonesObject phones

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning