Sign in
Allocation Windows

Retrieve an Allocation Window

OAuth Scope

This endpoint requires the following OAuth scope read_schedule.

get/allocationwindow/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Allocation Window

Response

Allocation Window record retrieved successfully

namestring

Name of the allocation window that defines a time period for job scheduling. Common examples include 'Morning', 'Afternoon', 'Business Hours', etc.

start_timeinteger

Start time of the allocation window measured in minutes from midnight. For example, 800 AM would be represented as 480 (8 hours × 60 minutes).

end_timeinteger

End time of the allocation window measured in minutes from midnight. For example, 1700 (500 PM) would be represented as 1020 (17 hours × 60 minutes).

sort_priorityinteger

Numeric value determining the display order of allocation windows. Lower values indicate higher priority. System automatically sets this to match the start_time in minutes, unless it's an urgent priority window which gets priority 0.

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

Example response

{
  "uuid": "123e4567-e8d2-4499-b2ee-234d58389bab",
  "edit_date": "2025-09-01 12:00:00"
}

Changes