FAfactorialhr
Compensations > Cycle

Reads all Cycles

Changed on

Retrieves compensation cycles

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

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/compensations/cycles
  • 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[]

Compensation cycle ids

[
  "1"
]
company_idstring

Filter by single company id

Example:1
company_ids[]string[]

Filter by company ids

[
  "1"
]
recurrencestring

Cycle recurrence (e.g. monthly)

Example:monthly
currencystring

Cycle currency (ISO-4217)

Example:EUR
countrystring

Cycle country (ISO-3166 alpha-2 lowercase)

Example:es
include_archivedboolean

Include archived cycles in the response

include_hiddenboolean

Include hidden cycles in the response

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "company_id": "1",
      "recurrence": "monthly",
      "first_payment": "2026-01-01",
      "currency": "EUR",
      "country": "es",
      "closure_day": 25,
      "alerts_day": 20,
      "created_at": "2026-01-01T08:00:00.000+00:00",
      "updated_at": "2026-01-01T08:00:00.000+00:00"
    }
  ]
}

Changes