Agents API allows you to get and unsubscribe your team members.
Here's the example response for the Agents API methods:
{
"data": [
{
"id": 2533,
"name": "Alex",
"email": "[email protected]",
"role": "admin"
},
{
"id": 4761,
"name": "Nick Grachesku",
"email": "[email protected]",
"role": "agent"
},
{
"id": 6694,
"name": "Lisa",
"email": "[email protected]",
"role": "agentChatOnly"
},
{
"id": 6679,
"name": "Les",
"email": "[email protected]",
"role": "superviser"
}
]
}
Below you can find details on each of the Agent Object fields.
Field | Type | Description |
id | Integer | Unique id of the agent provided by HelpCrunch |
name | String | Agent's name |
String | Agent's email address | |
role | String | Agent's role: "agentChatOnly", "agent", "superviser", "admin" |
If you have any questions regarding the REST API, feel free to chat us any time.
👩💻 Happy Coding! 👨💻