FAfactorialhr
Contracts > Compensation

Reads all Compensations

Changed on

Reads all Compensations

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

Request

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

Query parameters

ids[]string[]

Return only the compensations with these ids.

[
  "1"
]
contract_version_ids[]string[]

Return only the compensations belonging to these contract versions.

[
  "1"
]

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "contract_version_id": "1",
      "contracts_taxonomy_id": "1",
      "description": "Yearly variable",
      "compensation_type": "fixed",
      "unit": "Money",
      "starts_on": "2026-01-01",
      "currency": "EUR"
    }
  ]
}

Changes