Skip to main content
GET
/
companies
/
{companyId}
/
payroll-cycles
Get the payroll cycles of a company. A null value on the end date means that the cycle is currently open.
curl --request GET \
  --url https://pre-public-api.cobee.io/api/v3/companies/{companyId}/payroll-cycles \
  --header 'Authorization: Bearer <token>'
{
  "payrollCycles": [
    {
      "id": "<string>",
      "start": 1672531200,
      "end": 1675123200,
      "fiscalYear": "2023",
      "payrollMonth": "03"
    }
  ],
  "page": {
    "size": 123,
    "totalElements": 123,
    "totalPages": 123,
    "number": 123
  }
}

​
Overview

Retrieve all payroll cycles for a specific company. Each payroll cycle represents a period during which employee benefits are tracked and managed.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
companyId
string<uuid>
required

The unique identifier of the company

Query Parameters

​
page
integer
default:1

Page number to retrieve. Defaults to 1.

Required range: x >= 1
​
limit
integer
default:250

Max number of items per page. Must be greater than 0. Defaults to 250.

Required range: x >= 1

Response

Payroll cycles successfully retrieved

​
payrollCycles
object[]

List of the company Payroll Cycles

​
page
object