Agent Management
Get Agents
Retrieve agents list
GET
/
agent
/
agents
Authorization
Query
curl --request GET \
--url https://chat.zoko.io/v2/agent/agents \
--header 'apikey: <apikey>'
[
{
"active": true,
"available": true,
"email": "<string>",
"firstName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastName": "<string>",
"role": "owner"
}
]
Authorizations
apikey
string
headerrequiredAuthentication is done via apikey
provided for your account
Include the following in your request header
apikey: "your_apikey_here"
Query Parameters
includeTeams
boolean
should the response include teams where the agent is a member
Response
200 - application/json
active
boolean
is the agent active?
available
boolean
email
string
email of agent
firstName
string
first name of agent
id
string
agent id
lastName
string
last name of agent
role
enum<string>
role of the agent
Available options:
owner
, admin
, salesman
curl --request GET \
--url https://chat.zoko.io/v2/agent/agents \
--header 'apikey: <apikey>'
[
{
"active": true,
"available": true,
"email": "<string>",
"firstName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastName": "<string>",
"role": "owner"
}
]