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

9da73dd2f99e

users

Get a user's weekly planning

Retrieves a user's weekly availability planning — the time slots during which the user is reachable via Ringover. The response contains a planning for each day of the week with start/end time ranges. If planning is not enabled in the user's settings, the is_planning field will be false and the time ranges will be empty.

Permission: Users Read required.

Monitoring impact:

  • OFF: Returns planning only if userId matches your own user ID. Requesting another user's planning returns 404.
  • ON: Returns any user's planning in the team.
get/users/{userId}/plannings

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

tz_identifierstring

The user's timezone

tz_nowstring

Current timestamp of the user's timezone

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_snoozedboolean

True if the user is currently in snooze

Example response

{
  "team_id": 123456,
  "user_id": 123456,
  "tz_identifier": "Europe/Paris",
  "tz_now": "2020-04-08T10:34:28+02:00",
  "planning_enable": true,
  "is_planning": true,
  "time_ranges": [
    {
      "end": 1440
    }
  ]
}