API ReferenceSalaries

Retrieve the current salary record

Retrieves the salary record currently in effect for an employee — the one with the latest effective_from date on or before today.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

employee_idstringRequiredformat: "ee_.+"

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK
idstringformat: "sal_.+"
Unique identifier for the salary record
employee_idstringformat: "ee_.+"
Unique identifier for the employee this salary belongs to
amountdouble
Salary amount, in the given currency and pay frequency
currencyenum
ISO currency code the amount is denominated in
pay_frequencyenum

The period this amount represents (e.g. annual, monthly)

effective_fromdate
Date from which this salary is effective
objectstringOptionalRead-only
The object type

Errors

404
Not Found Error