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

9da73dd2f99e

presences

List all team presences

Retrieves presence information for all users in your team in a single request. Each entry includes the user's current availability state (available, on call, in snooze, offline), active snooze details, and connected device. This is the bulk equivalent of GET /users/{userId}/presences — ideal for building a team dashboard or monitoring panel.

Permission: No specific permission required. A valid API key is sufficient.

Monitoring: Required. This is a team-wide supervisory view. Returns 401 Unauthorized if Monitoring is OFF on your API key. For individual user presence without Monitoring, use GET /users/{userId}/presences instead.

get/presences

Response

Successful operation

list_countinteger

The size of the array <em>list</em>, corresponds to the number of presences retrieved

Example response

{
  "list_count": 1,
  "list": [
    {
      "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"
    }
  ]
}