GET
/api/departments
Get a list of departments for your account.
Scope:
client
or
operator
Request Parameters
Query
active
optional
Will allow you to optionally select only active or deactive departments
system (chat, ticket, callback)
optional
This will allow you to return the stats of a particular system
include_unassigned
optional
This will allow you include stats for unassigned chats, tickets, or callbacks
my_department_only
optional
This will allow you include stats for operators department only
include_operators
optional
This will provide a list of all operators associated with the departments
include_hours
optional
This will provide a list of working hours per department
Response
Schema
payload
The department data
department_description
The department description
department_email
The department email address
department_id
The department id
department_name
The department name
operators
The list of department operators
admin
True if operator is admin else false
description
The operator description
The operator email
enabled
True if operator is enabled else false
first_name
The operator first name
id
The operator id
last_name
The operator last name
online
True if the operator is online else false
picture
The operator picture
username
The operator username
hours
The list of working hours per day
day
Day of the week
start_time
Start time
end_time
End time
status
The system response status. Will be ok or error
curl
example request
1
curl -H "Authorization: Bearer {{Oauth Token}}"
2
https://developer.livehelpnow.net/api/departments
example response
1
{
2
"payload": [{
3
"department_description"
: "Non-technical customer support",
4
"department_email"
: "help@livehelpnow.com",
5
"department_id"
: 1234,
6
"department_name"
: "Customer Service",
7
"operators": [{
8
"admin"
: true,
9
"description"
: "Customer Service",
10
"email"
: "test@test.com",
11
"enabled"
: true,
12
"first_name"
: "John",
13
"id"
: 1234,
14
"last_name"
: "Doe",
15
"online"
: false,
16
"picture"
: "https://cdn.livehelpnow.net/operators/photos/1-E39ZS4.jpg",
17
"username"
: "jdoe"
18
}],
19
"hours": [{
20
"day"
: "Monday"
21
"start_time"
: "2023-03-24T10:00:00",
22
"end_time"
: "2023-03-24T20:00:00",
23
}]
24
}],
25
"status": "ok"
26
}