v1

latestOpenAPI 3.0.22026-07-24154101.1 MB

Time Clocking

List Payroll Periods

get/v2/time_clocking/payroll_periods

Query parameters

cursorstring

Cursor for the next or previous page of results.

limitinteger

The number of results desired per page.

company_idinteger required

Company Id

include_punches_statusboolean

Whether to include the status of the punches that the request user can see

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

Paginated payroll periods

Example response

{
  "data": [
    {
      "start": "2023-12-31",
      "end": "2023-12-31",
      "states": [
        {
          "processed": "2022-01-15",
          "closed_or_reopened_at": "2023-12-31T15:45:23-06:00"
        }
      ],
      "created": "2023-12-31T15:45:23-06:00",
      "modified": "2023-12-31T15:45:23-06:00"
    }
  ]
}