GET/desk/api/v2/users.json

List users for current installation.

The following values are allowed in the filter query parameter:

  • id
  • email
  • firstName
  • lastName
  • avatarURL
  • editMethod
  • isPartTime
  • ticketReplyRedirect
  • reviewer
  • trainingWheelsEnrollment
  • role
  • sendPushNotifications
  • sendWebNotifications
  • autoFollowOnCC
  • createdAt
  • updatedAt
  • createdBy
  • updatedBy
  • state
  • triggers.id
  • inboxes.id
  • firstname
  • lastname
  • users.ontraining

The following values are allowed in the orderBy query parameter:

  • id
  • email
  • firstName
  • lastName
  • avatarURL
  • editMethod
  • isPartTime
  • ticketReplyRedirect
  • reviewer
  • trainingWheelsEnrollment
  • role
  • sendPushNotifications
  • sendWebNotifications
  • autoFollowOnCC
  • createdAt
  • updatedAt
  • createdBy
  • updatedBy
  • state
  • firstname
  • lastname
  • email
  • isPartTime
  • role

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    UsersAPIBody handles request/response for user listing
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

UsersAPIBody
{  "included": {    "inboxes": [      {        "autoReplyEnabled": true,        "autoReplyFromUserId": 0,        "autoReplyMessage": "string",        "autoReplySubject": "string",        "createdAt": "2024-04-16T16:34:46.738Z",        "createdBy": {          "delete": true,          "id": 0,          "meta": {},          "type": 0        },        "deletedAt": "2024-04-16T16:34:46.738Z",        "deletedBy": {          "delete": true,