User by ID

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

guardian-users:read

Body Response - Schema

200 (requested user data)

ParameterTypeDescriptionRequired
_linksobject"_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_timestringThe agent creation timestamp. Example:
2020-02-01T10:00:00.000Z
no
emailstringThe agent e-mail.
Example:
[email protected]
no
idstringThe agent ID.
Example:
669d7b6a54dd4e73b219e48a56109cc5
no
namestringThe agent name.
Example: John Doe
no
presencestringThe agent current connection presence.
Example: Offline
no
presence_typestringThe agent current connection presence type.
Example: offline
no
ring_groupsarray[string]The agent ring groups.
Example: ["Agents"]
no
risknumberThe agent risk.
Example: 91.5
no
rolestringThe agent role.
Example: Administrator
no
statusstringThe agent activation state.
Allowed values: "ACTIVE",
"INACTIVE", "PENDING".
Example: active
no
call_qualityobjectCall 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)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[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.

Language
Authorization
Header
Click Try It! to start a request and see the response here!