Skip to main content
GET
List all compensations

Authorizations

Authorization
string
header
required

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

Query Parameters

name
string

Filter by name (contains)

compensationType
enum<string>

Filter by compensation type

Available options:
fixed,
variable,
additional
period
enum<string>

Filter by payment period

Available options:
weekly,
biweekly,
fortnightly,
monthly
status
enum<string>

Filter by status

Available options:
active,
inactive
currency
string

Filter by currency (ISO 4217)

page
integer
default:1

Page number

limit
integer
default:50

Items per page (max 500)

Required range: x <= 500

Response

Successful response

data
object[]
meta
object