Views: 5206
Last Modified: 17.10.2024
The method gets list of users in your department
Revision: 19
Get information on the current API revision (platform version) – im.revision.get.
Parameters
Parameter |
Example |
Req. |
Description |
Revision |
USER_DATA |
N |
No |
Download user data |
19 |
OFFSET |
0 |
No |
Offset selection of users |
19 |
LIMIT |
10 |
No |
User selection limit |
19 |
|
- If the
USER_DATA = Y
parameter is passed, the array of objects with the specific user data is passed instead of IDs array.
- The method supports standard Bitrix24 REST API pagewise navigation. Additionally it can build navigation via
OFFSET
and LIMIT
parameters.
Method call
JavaScript
BX24.callMethod('im.department.colleagues.list', {USER_DATA: 'Y'}, function(result){
if(result.error())
{
console.error(result.error().ex);
}
else
{
console.log('users', result.data());
console.log('total', result.total());
}
});
PHP
$result = restCommand('im.department.colleagues.list', Array(
'USER_DATA' => 'Y'
), $_REQUEST["auth"]);
Example of response
With the option USER_DATA = N
:
{
"result": [1],
"total": 1
}
With the option USER_DATA = Y
:
{
"result": [
{
"id": 1,
"name": "John Harrington",
"first_name": "John",
"last_name": "Harrington",
"work_position": "",
"color": "#df532d",
"avatar": "http://192.168.2.232/upload/resize_cache/main/1d3/100_100_2/Harrington.png",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "default",
"status": "online",
"idle": false,
"last_activity_date": "2018-01-29T17:35:31+03:00",
"desktop_last_date": false,
"mobile_last_date": false,
"departments": [
50
],
"absent": false,
"phones": {
"work_phone": "",
"personal_mobile": "",
"personal_phone": ""
}
}
],
"total": 1
}
Description of keys:
id
– user ID
name
– user first and last name
first_name
– user name
last_name
– user last name
work_position
– position
color
– user color in 'hex' format
avatar
– link to avatar (if empty, avatar is not specified)
gender
– user gender
birthday
– user birthday in the DD-MM format, if empty – not specified
extranet
– extranet user attribute (true/false
)
network
– Bitrix24.Network user attribute (true/false
)
bot
– bot attribute (true/false
)
connector
– Open Channel user attribute (true/false
)
external_auth_id
– external authorization code
status
– user status. Always displayed as Online, even if user has set it as "Do not disturb". The "Do not disturb" status affects reception of notifications and isn't visible to other users
idle
– date, when user is not using his/her PC, in ATOM format (if not specified, false
)
last_activity_date
– date of the last user action, in ATOM format
mobile_last_date
– date of the last action inside mobile app, in ATOM format (if not specified, false
)
desktop_last_date
– date of the action in the desktop app, in ATOM format (if not specified, false
)
absent
– date, to which the user has a leave of absence, in ATOM format (if not specified, false
)
phones
– array of phone numbers: work_phone
– work phone, personal_mobile
– mobile phone, personal_phone
– personal phone number
Attention:
restCommand function is used here for illustration purposes only. It is taken from the
EchoBot example. You can send a REST command with your own function, or use the
BX24.callMethod or
bitrix24-php-sdk methods.