GET /api/public/high-five/

Get a list of high fives within the company.

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

Servers

Query parameters

Name Type Required Description
page Integer No

Results page

updated_after String No

Only include users with updated date greater than or equal to the value.

created_on_start String No

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

created_before String No

Only include users with creation date less than or equal to the value.

created_on_end String No

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

report_id Integer No

Include only high fives within the report with the specified ID.

In order to query for high fives given by multiple reports, specify report ids as a list of parameters, eg.: ?report_id=1&report_id=2

created_after String No

Only include users with creation date greater than or equal to the value.

updated_before String No

Only include users with updated date less than or equal to the value.

receiver_id Integer No

Include only high fives received by the provided user ID(s).

In order to query for high fives received by multiple IDs, specify receiver ids as a list of parameters, eg.: ?receiver_id=1&receiver_id=2

order_by String No

Available sorting fields (id, report, create_ts), defaults to "create_ts".

Add a "-" before the field name to reverse the order e.g. "-create_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.