---
title: "Reads all Supplements"
method: GET
path: "/api/2026-10-01/resources/payroll/supplements"
tags: ["Payroll > Supplement"]
---

# Reads all Supplements

`GET /api/2026-10-01/resources/payroll/supplements`

## Request

- Base URL: `https://api.factorialhr.com`
- URL: `https://api.factorialhr.com/api/2026-10-01/resources/payroll/supplements`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://id.factorialhr.com/oauth/authorize`
    - Token URL: `https://id.factorialhr.com/api/oauth/token` scopes: `payroll_supplements`
  - API key in header `x-api-key`

Reads all Supplements

## Query parameters

- `from` string: Valid date following the format YYYY-MM-DD
- `to` string: Valid date following the format YYYY-MM-DD
- `employee_ids[]` string[]: The employee ids to retrieve
- `policy_period_ids[]` string[], required: The policy period ids to retrieve
- `compensation_id` string: The compensation id to retrieve
- `ids[]` string[]: ids
- `legal_entity_ids[]` string[]: The legal entities id to retrieve

## Response `200`

OK

- object
  - `data` PayrollSupplement[]
    - `id` string, required: The identifier of the supplement
    - `employee_id` string, required: The identifier of the employee associated with the supplement
    - `company_id` string, required: The identifier of the company associated with the supplement
    - `contracts_compensation_id` string: The contract compensation identifier associated with the supplement
    - `contracts_taxonomy_id` string: The taxonomy identifier associated with the supplement
    - `amount_in_cents` integer: The amount of the supplement in cents
    - `unit` 'money' | 'units' | 'time', required: The unit of the supplement
    - `effective_on` string: The date on which the supplement becomes effective
    - `created_at` string: The created at date when the supplement was created
    - `updated_at` string: The last updated at date when the supplement was last updated
    - `description` string: The description of the supplement
    - `payroll_policy_period_id` string: The payroll policy period identifier associated with the supplement
    - `employee_observations` string[]: Observations on the employee made by the admin or manager
    - `raw_minutes_in_cents` integer: The raw value of minutes in cents associated with the supplement
    - `minutes_in_cents` integer: The value of minutes in cents after adjustments
    - `equivalent_minutes_in_cents` integer: The equivalent value of minutes in cents for payroll processing
    - `currency` string: The currency used for the supplement, typically in ISO 4217 format
    - `legal_entity_id` string: The legal entity identifier associated with the supplement
  - `meta` PagedIndexMeta
    - `start_cursor` string
    - `end_cursor` string
    - `has_previous_page` boolean, required
    - `has_next_page` boolean, required
    - `limit` integer, required
    - `total` integer, required

## Changes

- **2026-11-03** `83ac9aa1de50`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/factorialhr/apis/factorial-api/changes/api/2026-10-01/resources/payroll/supplements/get.md)

---

[API](https://skmtc.dev/factorialhr/apis/factorial-api.md) - [All operations](https://skmtc.dev/factorialhr/apis/factorial-api/llms.txt) - [OpenAPI document](https://skmtc.dev/factorialhr/apis/factorial-api/revisions/83ac9aa1de50?raw)