GET /api/public/review-cycle/{id}/participants/

Get a list of participants within a cycle.

Returns detailed information about all participants in a review cycle.

Response is paginated.

Servers

Path parameters

Name Type Required Description
cycle_id Integer Yes

Query parameters

Name Type Required Description
page Integer No

Results page

updated_after String No

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

Note: this parameter has an alias name "updated_on_start", which is deprecated.

hierarchy_updated_after String No

Only include participants 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.

created_before String No

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

Note: this parameter has an alias name "created_on_end", which is deprecated.

created_after String No

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

Note: this parameter has an alias name "created_on_start", which is deprecated.

updated_before String No

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

Note: this parameter has an alias name "updated_on_end", which is deprecated.

hierarchy_updated_before String No

Only include participants 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.

user_id Integer No

Filter participants by participant user's id.

group_id Integer No

Filter participants by user's group id.

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"
  • "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.