If you need to retrieve information about all users in your organization using DailyBot, you can use the following API endpoint:
Endpoint: GET /users/
Query String Parameters:
- None
Example Response:
"count":4,
"next":null,
"previous":null,
"results": [
{
"uuid":"5945bf0g2-66f5-4b29-bbd6-07421dfga87",
"is_active": true,
"bot_enabled": true,
"full_name":"John Wick",
"role": "ADMIN"
"timezone": "America/Bogota"
"image":"https://secure.gavatar.com/avatar/ima.png",
"username":"Wick10",
"occupation":"Teammate",
"birth_date":"05-12",
"chat_platform_data": {
"user_external_id":"Z32HVBCQ98D"
},
"work_start_time": "09:00:00",
"work_days": [1,2,3,4,5],
"timeoff_start": "06/01/2022",
"timeoff_end": "16/01/2022",
"organization": {
"uuid":"4e322341-1262-42fa3-942a-0341d90883f6",
"name":"Alexa OC"
}
},
]
}
-
uuid
: [String] Current user UUID. -
is_active
: [Boolean] Determines whether the user is active in the organization. -
bot_enabled
: [Boolean] Determines whether the user has enabled the bot on the chat. -
full_name
: [String] User's full name. -
role
: [String] User’s role description. -
timezone
: [String] User’s time zone. -
image
(optional): [String] User’s avatar image URL. -
username
: [String] Username. -
occupation
: [String] User’s job title in the organization. -
birth_date
: [String] User’s birth date (formatted as MM-DD). -
chat_platform_data
: [String] Includes the user external ID that identifies the user on each platform. -
work_start_time
: [String] Start time of the shift. -
work_days
: [Numeric list] Workdays in the organization. -
timeoff_start
: [String] Start date of time off. -
timeoff_end
: [String] End date of time off. -
organization
:-
uuid
: [String] Current organization UUID. -
name
: [String] Organization name.
-
How to Use:
-
Access the Users Information Endpoint: Utilize the
GET
method on/users/
to retrieve information about all users in your organization. -
Retrieve User Data: The response provides details about each user in your organization, including their UUID, activity status, bot-enabled status, full name, role, timezone, image URL, username, occupation, birth date, chat platform data, work details, time-off details, and organization information.
Feel free to use this API endpoint to obtain a comprehensive list of user information for your integration or application. If you have further questions or require assistance, don't hesitate to contact our support team at support@dailybot.com.
Comments
0 comments
Article is closed for comments.