---
title: "Retrieve Payroll Period"
method: GET
path: "/v2/company/{company_id}/payroll_periods/{payroll_period_id}"
tags: ["Time Clocking"]
---

# Retrieve Payroll Period

`GET /v2/company/{company_id}/payroll_periods/{payroll_period_id}`

## Request

- Base URL: `https://api.7shifts.com`
- URL: `https://api.7shifts.com/v2/company/{company_id}/payroll_periods/{payroll_period_id}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://app.7shifts.com/oauth2/authorize`
    - Client credentials
    - Password
    - Token URL: `https://app.7shifts.com/oauth2/token`
  - API key in cookie `7session`

## Path parameters

- `company_id` integer, required
- `payroll_period_id` integer, required

## Headers

- `x-api-version` string: An API version
- `x-company-guid` string, uuid

## Response `200`

Payroll Period

- object
  - `object` 'payroll_period', required
  - `data` object, required
    - `id` integer, required: The id of the payroll period.
    - `company_id` integer, required: The id of the company for the payroll period.
    - `closed` boolean, required: Whether the payroll period has been finalized.
    - `start` string, required: The start date of the payroll period.
    - `end` string, required: The end date of the payroll period.
    - `states` object[], required
      - `id` integer, nullable, required: The id of the pay period state.
      - `location_id` integer, required: The location id of the company.
      - `closed` boolean, required: Whether or not the pay period is closed
      - `processed` string, date, nullable, required: The date the pay period was processed for an export.
      - `modified_by_user_id` integer, required: The user id of the user who modified the pay period. This may indicate an employee or a server process. Server processes will have a negative user id.
      - `closed_or_reopened_at` string, nullable, required: It is one representation of ISO8601/RFC3339 date time format

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `500`: Server Error

---

[API](https://skmtc.dev/7shifts/apis/7shifts-api.md) - [All operations](https://skmtc.dev/7shifts/apis/7shifts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/7shifts/apis/7shifts-api/revisions/40e0ef40dfcd?raw)