PeopleForce
Perform

Early access

Company API v4 is the next-generation API and is under active development. Endpoints and fields may still change.

List all review cycles

Returns a list of review cycles

GET
/api/v4/perform/review_cycles

Returns a list of review cycles

Query Parameters

page?integer

Page offset to fetch.

Formatint32
Default1
per_page?integer

Number of results to return per page.

Formatint32
Default50
offset?integer

Pad a number of results.

Formatint32
Default0
review_cycle_type?string

Filter by review cycle type. Allowed values: manual, lifecycle

Value in

  • "manual"
  • "lifecycle"
starts_on[gte]?string
Formatdate
starts_on[lte]?string
Formatdate
ends_on[gte]?string
Formatdate
ends_on[lte]?string
Formatdate

Response Body

application/json

curl -X GET "https://example.com/api/v4/perform/review_cycles"
{  "data": [    {      "id": 0,      "name": "string",      "review_cycle_type": "manual",      "description": "string",      "status": "string",      "starts_on": "2019-08-24",      "ends_on": "2019-08-24",      "deadline_on": "2019-08-24",      "review_period_starts_on": "2019-08-24",      "review_period_ends_on": "2019-08-24",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "metadata": {    "page": 0,    "per_page": 0,    "total_pages": 0,    "total_count": 0  }}