List users statuses

Request

GET /v2/users/status?page=1 HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter Type Examples Description
page     Page number (optional)

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
  "_embedded" : {
    "userStatuses" : [ {
      "userId" : 4,
      "email" : {
        "status" : "active",
        "updatedAt" : "2026-01-15T10:30:00Z",
        "performedBy" : 4,
        "source" : "api"
      },
      "chat" : {
        "status" : "custom",
        "mailboxStatuses" : {
          "100" : "assign",
          "101" : "unavailable"
        }
      }
    }, {
      "userId" : 5,
      "email" : {
        "status" : "away",
        "updatedAt" : "2026-01-15T11:00:00Z",
        "performedBy" : 5,
        "source" : "ui"
      },
      "chat" : {
        "status" : "unavailable",
        "mailboxStatuses" : { }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "..."
    },
    "first" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "page" : {
      "href" : "..."
    }
  },
  "page" : {
    "size" : 50,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 1
  }
}

Response fields

Path Type Description
_embedded.userStatuses Array List of user statuses

Response fields

Path Type Description
userId Number User identifier
email Object Email/availability status information
email.status String User email status, one of active or away
email.updatedAt String Timestamp when the status was last updated
email.performedBy Number User ID who performed the status change
email.source String Source of the status change, one of ui, api or presence_detection
chat Object Chat status information
chat.status String Overall chat status, one of unavailable, available, assign or custom
chat.mailboxStatuses Object Map of mailbox IDs to their chat statuses (values follow chat.status definition), exposed when overall status is custom
↑Back to top