Get agents list
Get agents list of an account.
Settings:
URL | |
Method | JSON via POST |
Header | Authorization: Bearer {{access_token}} *The access_token can be received from settings->get access token API. |
Body:
Parameter | Description / Example |
|---|---|
accountID | The accountID you wish to get the agents list |
server | server subdomain hosting the account (default is: online) if not set, "online" will be used. |
Response:
{
"status": "OK",
"reason": 1,
"accountID": 1,
"server": 1,
"totalagents": 2,
"list": [
{
"id": 1,
"create_time": 1748168139,
"email": "emailone@business.com",
"agent_name": "agent name",
"role": "Admin",
"two_factor_type": "sms",
"two_factor_phone": "+972501234567",
"two_factor_email": null
},
{
"id": 2,
"create_time": 1748168139,
"email": "emailtwo@business.com",
"agent_name": "agent name 2",
"role": "Marketing",
"two_factor_type": "email",
"two_factor_phone": null,
"two_factor_email": "my@example.com"
}
]
}
Response-Explain:
Parameter | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | OK or FAIL "OK" means the request was successful. "Fail" means error. | ||||||||||||||||||
totalAgents | The total number of agents in the selected account | ||||||||||||||||||
list | array of the following table []:
| ||||||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|