7S7shifts
Time Clocking

Retrieve Payroll Period

get/v2/company/{company_id}/payroll_periods/{payroll_period_id}

Request

  • Base URL
    https://api.7shifts.com
  • Auth
    • OAuth 2
      Authorization codehttps://app.7shifts.com/oauth2/authorize
      Client credentials
      Password
      Token URLhttps://app.7shifts.com/oauth2/token
    • or API key in cookie 7session

Path parameters

company_idinteger required
Example:1234

Company Id

payroll_period_idinteger required
Example:1234

Payroll Period Id

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

Payroll Period

object'payroll_period' required

Example response

{
  "data": {
    "id": 1234,
    "company_id": 1234,
    "closed": true,
    "start": "2022-01-15",
    "end": "2022-01-30",
    "states": [
      {
        "processed": "2022-01-15",
        "closed_or_reopened_at": "2023-12-31T15:45:23-06:00"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.