GET
/
agent
/
{id}

Authorizations

​
apikey
string
headerrequired

Authentication is done via apikey provided for your account

Include the following in your request header

apikey: "your_apikey_here"

Path Parameters

​
id
string
required

ID or email of the agent

Query Parameters

​
includeTeams
boolean

should the response include teams where the agent is a member

Response

200 - application/json

Agent response model

​
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
Assign CustomerUpdate Agent