v1

latestOpenAPI 3.0.22026-07-2441902.6 MB

Guardian API

Get user by id.

Returns an agent.

get/guardian/users/{id}

Path parameters

idstring required

Id of the user to fetch

Response

Requested user data

creation_timestring

The agent creation timestamp.

emailstring

The agent e-mail.

idstring

The agent id.

namestring

The agent name.

presencestring

The agent current connection presence.

presence_typestring

The agent current connection presence type.

ring_groupsstring[]

The agent ring groups.

risknumber double

The agent risk.

rolestring

The agent role.

status'ACTIVE' | 'INACTIVE' | 'PENDING'

The agent activation state.

Example response

{
  "_links": {
    "self": {
      "href": "schema://host:port/log/sessions?page=1&per_page=10"
    }
  },
  "creation_time": "2020-02-01T10:00:00.000Z",
  "email": "john.doe@somecompany.com",
  "id": "669d7b6a54dd4e73b219e48a56109cc5",
  "name": "John Doe",
  "presence": "Offline",
  "presence_type": "offline",
  "ring_groups": [
    "Agents"
  ],
  "risk": 91.5,
  "role": "Administrator",
  "status": "active",
  "call_quality": {
    "mos": {
      "avg": 1.2
    }
  }
}