FAfactorialhr
Compensations > PayrollRun

Reads all Payroll runs

Changed on

Retrieves payroll runs

get/api/2026-10-01/resources/compensations/payroll_runs

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/compensations/payroll_runs
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: compensations
    • or API key in header x-api-key

Query parameters

ids[]string[]

Filter by payroll run ids

[
  "1"
]
fromstring

Lower bound for the run end date (ends_on >= from)

Example:2026-01-01
tostring

Upper bound for the run start date (starts_on <= to)

Example:2026-12-31
company_idstring

Filter by company id (single)

Example:1
cycle_ids[]string[]

Filter by parent cycle ids

[
  "1"
]
statuses[]string[]

Filter by run statuses

[
  "open"
]
payment_types[]string[]

Filter by payment types (regular, extra_pay)

[
  "regular"
]
include_hiddenboolean

Include hidden cycles' runs in the response

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "label": "Enero 2026",
      "starts_on": "2026-01-01",
      "ends_on": "2026-01-31",
      "status": "open",
      "cycle_id": "1",
      "company_id": "1",
      "payment_type": "regular",
      "closure_date": "2026-01-25",
      "alerts_date": "2026-01-20",
      "created_at": "2026-01-01T08:00:00.000+00:00",
      "updated_at": "2026-01-01T08:00:00.000+00:00"
    }
  ]
}

Changes