Get user status

Request

GET /v2/users/4/status HTTP/1.1
Authorization: Bearer oauth_token

Path Parameters

/v2/users/{userId}/status

Response

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

{
  "userId" : 4,
  "email" : {
    "status" : "active",
    "updatedAt" : "2026-01-15T10:30:00Z",
    "performedBy" : 4,
    "source" : "api",
    "customStatus" : {
      "text" : "On a coffee break",
      "emoji" : "☕",
      "emojiName" : ":coffee:"
    }
  },
  "chat" : {
    "status" : "custom",
    "mailboxStatuses" : {
      "100" : "assign",
      "101" : "unavailable"
    }
  },
  "_links" : {
    "self" : {
      "href" : "..."
    }
  }
}

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
email.customStatus Object Custom status information
email.customStatus.text String Custom status text set by the user
email.customStatus.emoji String Emoji associated with the custom status
email.customStatus.emojiName String Name of the emoji associated with the custom status
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