Schedules

GET /external/v1/schedules

Returns shift schedule entries with comprehensive filtering options.

Query Parameters

Parameter	Type	Required	Description
`from`	string	No	Start date (ISO 8601). Defaults to the next calendar day at 00:00:00 UTC (i.e., tomorrow at 00:00Z) if omitted
`to`	string	No	End date (ISO 8601). Defaults to 30 days after `from` at 00:00:00 UTC (if `from` is omitted, use the default `from`)
`userId`	string	No	Comma-separated user IDs to filter
`branchId`	string	No	Filter by branch/location ID
`jobRoleId`	string	No	Filter by job role ID
`slotId`	string	No	Filter by shift slot ID
`page`	number	No	Page number for pagination (1-based)

Response

[
  {
    "id": "shift-uuid-1",
    "slotId": "slot-uuid-1",
    "branchId": "branch-uuid-1",
    "userId": "user-uuid-1",
    "status": "confirmed",
    "start": "2026-02-10T09:00:00.000Z",
    "end": "2026-02-10T17:00:00.000Z",
    "clockedIn": "2026-02-10T08:58:00.000Z",
    "clockedOut": "2026-02-10T17:02:00.000Z",
    "totalBreakTime": 30
  }
]

Response Fields

Field	Type	Description
`id`	string	Unique shift ID
`slotId`	string	The shift slot/template ID
`branchId`	string	The branch/location ID
`userId`	string	The assigned employee's user ID
`status`	string	Shift status (e.g., `confirmed`, `pending`, `cancelled`)
`start`	string	Scheduled start time (ISO 8601)
`end`	string	Scheduled end time (ISO 8601)
`clockedIn`	string \| null	Actual clock-in time, or null if not clocked in
`clockedOut`	string \| null	Actual clock-out time, or null if not clocked out
`totalBreakTime`	number	Total break time in minutes

Example

curl -X GET "https://api.suprsync.com/external/v1/schedules?from=2026-02-01&to=2026-02-28&branchId=branch-uuid" \
  -H "x-api-key: api_your_client_id" \
  -H "x-api-secret: sec_your_client_secret"

Notes

Results are paginated. Use the page parameter to retrieve subsequent pages.
Sensitive employee information (name, email, phone) is not included. Use the userId field to correlate with the Staff endpoint.
Times are returned in UTC.