API Reference

Retrieve a list of Compensation Cycles

get
https://api.talent.performyard.com/v1/compensation-cycles

Retrieves a list of all available compensation cycles created in your PerformYard instance. Please note, this endpoint requires the Compensation feature to be enabled for your company. Requests from a company without Compensation enabled are rejected with a 403.

Query Params
string
^[0-9]+$

The number of records to be returned in a single API Request.

string
^[0-9]+$

Used to paginate through a list of records. Can be combined with limit. Increment the value by one to fetch subsequent pages (1 for the second page, 2 for the third, etc.).

string

Order in which to return the records. Allowed Values: asc(FIELD_NAME), desc(FIELD_NAME).

string
enum

Filters the returned compensation cycles by a specific cycle status.

Allowed:
string

Filter the returned compensation cycles by a specific name. Accepts only a single string value. Case-insensitive.

Responses

Updated 27 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago

Did this page help you?