Retrieve All Scheduled Windows

Retrieves scheduled windows for a given org and optionally for a given group

Scheduled Windows - Fields & Syntax
SecuritybearerAuth
Request
path Parameters
org_UUID
required
string <uuid>

Organization UUID

Example: 9c333e0d-7c2a-4231-bf9b-011951176c78
query Parameters
group_UUID
Array of strings <uuid>

Group UUID

Example: group_UUID=46275174-8e42-47d2-b0ef-a816be39cd63
status
string

Window status

Enum: "active" "inactive"
recurrence
string
Enum: "RECURRING" "ONCE"
page
integer <int32> >= 0
Default: 0

The page of policy windows to retrieve. Uses an offset value, for example requesting page 1 and size of 1 would retrieve the second item, as paging is zero-based.

size
integer <int32> [ 1 .. 100 ]
Default: 20

The number of elements to return per page.

sort
string
Default: "createdAt"

The field to sort by. This can be any field that is returned on the PolicyWindow object. Default = CreatedAt.

direction
string
Default: "desc"
Enum: "asc" "desc"
Responses
200

OK

4XX

Invalid Request

get/policy-windows/org/{org_UUID}
Request samples 
Response samples 
application/json
{
  • "total_elements": 100,
  • "total_pages": 10,
  • "size": 1,
  • "content": [
    • {
      • "window_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      • "window_type": "exclusion",
      • "window_name": "My Test Window",
      • "window_description": "generic window description",
      • "org_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      • "rrule": "FREQ=YEARLY;BYMONTH=1;BYDAY=+1MO",
      • "duration_minutes": 90,
      • "dtstart": "2025-10-30T16:45:21.065Z",
      • "use_local_tz": false,
      • "created_at": "2025-10-30T16:45:21.065Z",
      • "updated_at": "2025-10-30T16:45:21.065Z",
      • "status": "active",
      • "recurrence": "RECURRING",
      • "group_uuids": [
        • "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ]
      }
    ],
  • "number": 0,
  • "sort": {
    • "empty": false,
    • "sorted": true,
    • "unsorted": false
    },
  • "first": true,
  • "last": true,
  • "number_of_elements": 10,
  • "pageable": {
    • "offset": 0,
    • "sort": {
      • "empty": false,
      • "sorted": true,
      • "unsorted": false
      },
    • "paged": true,
    • "page_size": 1,
    • "page_number": 0,
    • "unpaged": true
    },
  • "empty": false
}