List Shifts

get

https://api.getpinwheel.com/v1/accounts/{account_id}/shifts

The shifts endpoint allows you to query for ongoing and completed work performed by an end user. It includes details about shift dates, timestamps, the type of work, and associated earnings. Shifts are returned in reverse chronological order by end_date. This is a paginated endpoint; see how Pinwheel implements pagination here.

Path Params

account_id

uuid

required

UUID of the payroll account.

Query Params

from_start_date

date

Return shifts where the start_date field is on or after this date. ISO 8601 format.

to_start_date

date

Return shifts where the start_date field is on or before this date. ISO 8601 format.

from_end_date

date

Return shifts where the end_date field is on or after this date. ISO 8601 format.

to_end_date

date

Return shifts where the end_date field is on or before this date. ISO 8601 format.

limit

integer

1 to 100

The maximum number of results to return.

cursor

string

Cursor for the page you want to retrieve.

Headers

Pinwheel-Version

string

enum

required

Defaults to 2025-07-08

Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.

Allowed:

Response

Language

Credentials

Header

URL

Response

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

application/json

200OK