get https://api.talkdeskapp.com/guardian/users
Scope
guardian-users:read
Body Response - Schema
200 (paginated list of users)
| Parameter | Type | Description | Required |
|---|---|---|---|
| _embedded | array[object] | "_embedded" subdivides into: 1 - "creation_time" (string) - the agent creation timestamp. Example: 2020-02-01T10:00:00.000Z 2 - "email" (string) - the agent's e-mail. Example: [email protected] 3 - "id" (string) - the agent's name. Example: John Doe 4 - "presence" (string) - the agent current connection presence. Example: Offline 5 - "presence_type" (string) - the agent current connection presence type. Example: offline 6 - "ring_groups" (array[string]) - the agent ring groups. Example: ["Agents"] 7 - "risk" (number ) - the agent risk. Example: 91.5 8 - "role" (string) - the agent role. Example: Administrator 9 - "status" (string) - the agent activation state. Allowed values: "ACTIVE", "INACTIVE", "PENDING" Example: active 10 - "call_quality" (object) - call quality data. 10.1 - "avg_affected_calls" (boolean) - the average affected call status. Example: false 10.2 - "mos" (object) - MOS data. 10.2.1 - "avg" (number) - the average MOS. Example: 1.2 | no |
| _links | object | "_links" subdivides into: 1 - "first" (object) - the first page link. 1.1 - "href" (string) - the hypertext reference describing this link. Example: schema://host:port/log/sessions?page=1&per_page=10. Required. 2 - "last" (object) - the last page link. 2.1 - "href" (string) - the hypertext reference describing this link. Example: schema://host:port/log/sessions?page=1&per_page=10. Required. 3 - "next" (object) - the next page link. 3.1 - "href" (string) - the hypertext reference describing this link. Example: schema://host:port/log/sessions?page=1&per_page=10. Required. 4 - "prev" (object) - the previous page link. 4.1 - "href" (string) - the hypertext reference describing this link. Example: schema://host:port/log/sessions?page=1&per_page=10. Required. 5 - "self" (object) - the current page link. 5.1 - "href" (string) - the hypertext reference describing this link. Example: schema://host:port/log/sessions?page=1&per_page=10. Required. 6 - "show" (object) - show alarms link. 6.1 - "href" (string) - the hypertext reference describing this link. Example: schema://host:port/log/sessions?page=1&per_page=10. Required. | no |
| count | integer | The number of results in the current page. Example: 10 | no |
| page | integer | The current page. Example: 10 | no |
| per_page | integer | The number of results per page. Example: 10 | no |
| total | integer | The total number of results. Example: 10 | no |
| total_pages | integer | The total number of pages. Example: 5 | no |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 406 (not acceptable)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| description | string | n/a | yes |
| message | 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.