GET
/
users
/
{user}
/
quiet-hours
curl --request GET \
  --url https://cloud.local.wirtual.dev/api/v2/users/{user}/quiet-hours \
  --header 'Wirtual-Session-Token: <api-key>'
[
  {
    "next": "2023-11-07T05:31:56Z",
    "raw_schedule": "<string>",
    "time": "<string>",
    "timezone": "<string>",
    "user_can_set": true,
    "user_set": true
  }
]

Authorizations

​
Wirtual-Session-Token
string
header
required

Path Parameters

​
user
string
required

User ID

Response

200 - application/json
OK
​
next
string

Next is the next time that the quiet hours window will start.

​
raw_schedule
string
​
time
string

Time is the time of day that the quiet hours window starts in the given Timezone each day.

​
timezone
string

raw format from the cron expression, UTC if unspecified

​
user_can_set
boolean

UserCanSet is true if the user is allowed to set their own quiet hours schedule. If false, the user cannot set a custom schedule and the default schedule will always be used.

​
user_set
boolean

UserSet is true if the user has set their own quiet hours schedule. If false, the user is using the default schedule.