List periods

GET 
/:customer_id/groups/:group_id/users/:uid/periods

List all periods for a user in a group

Request

Path Parameters

customer_id Customer Idrequired

Id of the tenant

group_id Group Idrequired

Id of the group

uid uuidrequired

Id of the user

Responses

200

application/json

Schema

Schema

periods object[]required
Array [
name Namerequired
Name of the active period.
group_id Group Idrequired
Id of the group.
start_time_local date-timerequired
Local start time of the active period.
end_time_local date-timenullablerequired
Local end time of the active period.
start_time_utc date-timerequired
Start time of the active period.
end_time_utc date-timerequired
End time of the active period.
tags string[]required
List of tags attached to the active period.
]

Example (from schema)

{
  "periods": [
    {
      "name": "string",
      "group_id": "string",
      "start_time_local": "2024-12-03T11:32:12.469Z",
      "end_time_local": "2024-12-03T11:32:12.469Z",
      "start_time_utc": "2024-12-03T11:32:12.469Z",
      "end_time_utc": "2024-12-03T11:32:12.469Z",
      "tags": [
        "string"
      ]
    }
  ]
}

400

Validation error

application/json

Schema

Schema

message Messagerequired
errors undefined[]nullablerequired

Example (from schema)

{
  "message": "string",
  "errors": [
    null
  ]
}

Loading...