Retrieve list of shifts

get

https://{subdomain}.{region}.deputy.com/api/management/v2/shifts

Retrieve list of shifts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

string

Filters shifts starting at or after this time. Format: ISO8601 datetime (e.g., "2023-03-11T13:45:00+11:00"). Default: 7 days ago from today.

end

string

Filters shifts starting before this time (exclusive). Format: ISO8601 datetime (e.g., "2023-03-11T18:45:00+11:00"). Default: today at 00:00:00.

employee

string

Mandatory field. Filters shifts for a specific employee ID.

timesheet

string

Not implemented.

published

string

enum

Defaults to NOT_SPECIFIED

Filters shifts by published status (PUBLISHED, UNPUBLISHED, etc.).

Allowed:

cursor

string

Pagination cursor from a previous response. Used to fetch the next page of results.

limit

int32

Maximum number of shifts to return in a single response. Used for pagination.

expandMetadata

boolean

If true, includes additional metadata such as custom field definitions.

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.