latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

presences
users

Get a user's presence status

Retrieves the current presence status for a specific user — whether they are available, on a call, in snooze mode, or offline. The presence data includes the user's current availability state, active snooze information (if any), and the device they are connected from.

Permission: Users Read required.

Monitoring impact:

  • OFF: Returns presence only if userId matches your own user ID. Requesting another user's presence returns 404.
  • ON: Returns any user's presence in the team. For a bulk view of all team presences, use GET /presences instead (also requires Monitoring ON).
get/users/{userId}/presences

Path parameters

userIdinteger required

The identifier of the user

Response

Successful operation

team_idinteger

The user's team id

user_idinteger

The user's id

in_callinteger

Number of current calls (it can be more than 1)

connected_devicesinteger

Number of devices connected to myringover

planning_enableboolean

True if the user have the planning option activated on myringover

is_planningboolean

True if the user is currently in his planning schedule

is_planned_snoozeboolean

False if the user is currently in his planning schedule

is_snoozedboolean

True if the user is currently in snooze

snooze_typestring

The type of snooze currently used. Null if is_snoozed is false

snooze_endstring

End date/time of the snooze

Example response

{
  "team_id": 123456,
  "user_id": 123456,
  "in_call": 1,
  "connected_devices": 3,
  "planning_enable": true,
  "is_planning": true,
  "is_snoozed": true,
  "snooze_type": "meeting",
  "snooze_end": "2020-07-17 10:14:24"
}