Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Scheduling
Public API

List Schedules

Retrieves a paginated list of all schedules for the company. Supports optional OData-style filtering and sorting.

OAuth Scopes: scheduling:schedules, time_tracking

get/api/v1/scheduling/schedules

Query parameters

filterstring

OData filter expression applied to schedules. Supported operators: eq (equals, use eq null to match NULL), ne (not equals, use ne null to match NOT NULL), lt (less than), le (less than or equal), gt (greater than), ge (greater than or equal), in (value in list), and (combine clauses). Not supported: or, not, parenthesized grouping. Filterable fields: id, name, locationId, timezone, startOfWeek, earlyClockInThreshold, lateClockInThreshold, earlyClockOutThreshold, lateClockOutThreshold, createdAt, updatedAt, deletedAt. Examples: name eq 'Default Schedule', deletedAt eq null, name eq 'Default Schedule' and locationId in (1, 2).

sortstring

Sorting options. Supported sorts are: name, locationId, timezone, startOfWeek, earlyClockInThreshold, lateClockInThreshold, earlyClockOutThreshold, lateClockOutThreshold, createdAt, updatedAt, deletedAt

pageinteger

The starting page for pagination

pageSizeinteger

The number of items to be returned

Response

A list of schedules

Example response

{
  "data": [
    {
      "id": "0199de9b-6bcb-77e7-941d-3caf74b9a372",
      "name": "Main Schedule",
      "locationId": 123,
      "timezone": "America/Denver",
      "startOfWeek": "Monday",
      "earlyClockInThreshold": 10,
      "lateClockInThreshold": 10,
      "earlyClockOutThreshold": 5,
      "lateClockOutThreshold": 15,
      "managerUserIds": [
        1,
        2
      ],
      "employeeIds": [
        10,
        20
      ],
      "createdAt": "2025-01-01T06:00:00Z",
      "updatedAt": "2025-01-01T06:00:00Z",
      "deletedAt": "2025-01-01T06:00:00Z"
    }
  ]
}