GET /api/public/review-cycle/

Get a list of review cycles.

Returns review cycles within the company.

Response is paginated, with a default page size of 50 objects.

Servers

Query parameters

Name Type Required Description
ended_on_end String No

Only include review cycles having end date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

page Integer No

Results page

created_on_start String No

Only include review cycles having creation date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

ended_on_start String No

Only include review cycles having end date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

hierarchy_updated_after String No

Only include review cycles having hierarchy update date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

Note: this filter is currently in testing phase. Please contact support if you plan to use it.

started_on_end String No

Only include review cycles having actual start date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

updated_on_end String No

Only include review cycles having update date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

created_on_end String No

Only include review cycles having creation date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

hierarchy_updated_before String No

Only include review cycles having hierarchy update date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

Note: this filter is currently in testing phase. Please contact support if you plan to use it.

updated_on_start String No

Only include review cycles having update date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

started_on_start String No

Only include review cycles having actual start date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

order_by String No

Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".

Possible values:

  • "create_ts"
  • "id"
  • "name"
  • "hierarchy_update_ts"
  • "update_ts"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.