Sign in

v4

OpenAPI 3.1.02026-08-034697208.8 KB
Income and Employment

List 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 <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>.

get/accounts/{account_id}/shifts

Path parameters

account_idstring uuid required

UUID of the payroll account.

UUID of the payroll account.

Query parameters

from_start_datestring date

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

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

to_start_datestring date

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

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

from_end_datestring date

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

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

to_end_datestring date

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

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

limitinteger

The maximum number of results to return.

The maximum number of results to return.

cursorstring

Cursor for the page you want to retrieve.

Cursor for the page you want to retrieve.

Headers

Pinwheel-Version'2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02' required

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

Response

OK