get https://api.talkdeskapp.com/guardian/users/
Scope
guardian-users:read
Body Response - Schema
200 (requested user data)
| Parameter | Type | Description | Required |
|---|---|---|---|
| _links | object | "_links" subdivides into: 1 - "self" (object) 1.1 - "href" (string) - the hypertext reference describing this link. Example: schema://host:port/log/sessions?page=1&per_page=10. Required. | no |
| creation_time | string | The agent creation timestamp. Example: 2020-02-01T10:00:00.000Z | no |
| string | The agent e-mail. Example: [email protected] | no | |
| id | string | The agent ID. Example: 669d7b6a54dd4e73b219e48a56109cc5 | no |
| name | string | The agent name. Example: John Doe | no |
| presence | string | The agent current connection presence. Example: Offline | no |
| presence_type | string | The agent current connection presence type. Example: offline | no |
| ring_groups | array[string] | The agent ring groups. Example: ["Agents"] | no |
| risk | number | The agent risk. Example: 91.5 | no |
| role | string | The agent role. Example: Administrator | no |
| status | string | The agent activation state. Allowed values: "ACTIVE", "INACTIVE", "PENDING". Example: active | no |
| call_quality | object | Call quality data. "call_quality" subdivides into: 1 - "avg_affected_calls" (boolean) - the average affected call status. Example: false 2 - "mos" (object) - MOS data. 2.1 - "avg" (number) - the average MOS. Example: 1.2 | no |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 406 (not acceptable)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.