GET
/
agent
/
agents
curl --request GET \
  --url https://chat.zoko.io/v2/agent/agents \
  --header 'apikey: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "role": "owner",
    "active": true,
    "available": true
  }
]

Authorizations

apikey
string
headerrequired

Authentication 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
id
string

agent id

firstName
string

first name of agent

lastName
string

last name of agent

email
string

email of agent

role
enum<string>

role of the agent

Available options:
owner,
admin,
salesman
active
boolean

is the agent active?

available
boolean
Update AgentGet Teams