BAbamboohr
Scheduling
Public API

Get Schedule

Changed on

Retrieves a specific schedule by its UUID. Schedules organize shifts for employees.

OAuth Scopes: scheduling:schedules, time_tracking

get/api/v1/scheduling/schedules/{id}

Request

Path parameters

idstring uuid required

The ID of the schedule

Response

Schedule retrieved successfully

idstring uuid

The UUID of the schedule

namestring

The name of the schedule

locationIdinteger

The ID of the location the schedule belongs to

timezonestring

The timezone of the schedule, provide if location is missing timezone

startOfWeekstring

The starting day of the week for the schedule

earlyClockInThresholdinteger

The threshold (in minutes) that an employee is allowed to clock in early to a shift on this schedule

lateClockInThresholdinteger

The threshold (in minutes) after a shift starts before an employee is considered late clocking in

earlyClockOutThresholdinteger

The threshold (in minutes) before a shift ends within which an employee is considered to have clocked out early

lateClockOutThresholdinteger

The threshold (in minutes) after a shift ends before an employee is considered to have clocked out late

claimsRequireApprovalDefaultboolean

Whether a claim on a shift created under this schedule requires manager approval by default. Only applies at shift creation time; changing this value never affects existing shifts.

managerUserIdsinteger[]

What users manage this schedule

employeeIdsinteger[]

What employees are assigned to this schedule

createdAtstring date-time

UTC timestamp when the schedule was created

updatedAtstring date-time nullable

UTC timestamp when the schedule was last updated

deletedAtstring date-time nullable

UTC timestamp when the schedule was deleted

autoPublishLeadTimeUnit'weeks' | 'days' nullable

The unit of the auto-publish lead time. Null when auto-publish is not enabled for this schedule.

autoPublishLeadTimeQuantityinteger nullable

The quantity of the auto-publish lead time. Null when auto-publish is not enabled for this schedule.

nextAutoPublishAtstring date-time nullable

UTC timestamp of the next scheduled auto-publish run. Null when auto-publish is not enabled for this schedule.

lastAutoPublishAtstring date-time nullable

UTC timestamp of the most recent successful auto-publish run. May be set even when auto-publish is not currently enabled.

Example response

{
  "id": "0199de9b-6bcb-77e7-941d-3caf74b9a372",
  "name": "Main Schedule",
  "locationId": 123,
  "timezone": "America/Denver",
  "startOfWeek": "Monday",
  "earlyClockInThreshold": 10,
  "lateClockInThreshold": 10,
  "earlyClockOutThreshold": 5,
  "lateClockOutThreshold": 15,
  "claimsRequireApprovalDefault": true,
  "managerUserIds": [
    1,
    2
  ],
  "employeeIds": [
    10,
    20
  ],
  "createdAt": "2025-01-01T06:00:00Z",
  "updatedAt": "2025-01-01T06:00:00Z",
  "deletedAt": "2025-01-01T06:00:00Z",
  "autoPublishLeadTimeUnit": "weeks",
  "autoPublishLeadTimeQuantity": 2,
  "nextAutoPublishAt": "2026-07-05T06:00:00Z",
  "lastAutoPublishAt": "2026-06-28T06:00:00Z"
}

Changes

  • 922fc15f43a7Revision changes
    • info

      the security scope scheduling:schedules was added to the endpoint's security scheme oauth

    • info

      the security scope time_tracking was removed from the endpoint's security scheme oauth

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status