List Open Shifts

Lists the open shifts the authenticated employee could claim: published, claimable shifts on the employee's schedules that have not started, have a spot left, and are not already assigned to them. A shift the employee was previously declined for stays listed. Rows carry no evaluation; evaluate them with POST /api/v1/scheduling/shift-claims/evaluate. There is no employee parameter, and a caller without an employee record gets an empty list, as does every caller while Open Shifts is off. The filter must bound start or end from below and above, within 31 days.

OAuth Scopes: scheduling:shifts

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

OData v4 filter expression. Required: a date window on start or end, bounded below (ge, gt, eq) and above (le, lt, eq), at most 31 days wide. Allowed fields: id, scheduleId, name, start, end, claimsRequireApproval.

string

Sort expression on any filterable field (e.g. start desc). Defaults to start ascending.

integer
≥ 1
Defaults to 1

The starting page for pagination.

integer
1 to 100
Defaults to 100

The number of items to be returned. Maximum 100.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json