GET /api/public/objective/

Get a list of objectives within the company.

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

Servers

Query parameters

Name Type Required Description
updated_after String No

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

parent_id Integer No

Include only objectives of a parent with the specified ID.

created_before String No

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

scope String No

Include only objectives with the specified scope type: string enum:

  • company-wide
  • group-type
  • individual
  • self-development
state String No

Include only objectives with the specified state; deprecated values: 'past', 'current', 'deactivated'

Possible values:

  • "active"
  • "future"
  • "archived"
  • "closed"
order_by String No

Order results by the specified field. The default ordering is: "end_ts,sort_order,id". Add "-" prefix to the field name to reverse the order.

Possible values:

  • "-end_ts"
  • "create_ts"
  • "id"
  • "-update_ts"
  • "-create_ts"
  • "-id"
  • "-sort_order"
  • "end_ts"
  • "update_ts"
  • "sort_order"
department_id Integer No

Include only objectives for a department/departments with the specified ID. In order to query for multiple departments, specify departments' ids as a list of parameters, eg.: ?department_id=1&department_id=2

page Integer No

Results page

start_after String No

Only include objectives with start date greater than or equal to the date specified in the YYYY-MM-DD format.

end_before String No

Only include objectives with end date less than or equal to the date specified in the YYYY-MM-DD format.

created_after String No

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

updated_before String No

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

user_id Integer No

Include only person-specific objectives for a user with the specified ID.

color String No

Include only objectives with the specified current status

Possible values:

  • "yellow"
  • "red"
  • "undefined"
  • "green"

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.