Get goals and OKRs via the Perform & Engage 365 API

The Perform & Engage 365 API enables you to:

• Get a list of goals and OKRs.
• Get the details of a particular goal or OKR by its ID.

Get a list of goals and OKRs

GET /api/v2/goals/

This request enables you to get a list of goals, sub-goals, OKRs, and OKR key results.

Optional query parameters

• limit (integer). The maximum number of goals, sub-goals, OKRs, and OKR key results in the response.
• offset (integer). The initial index from which the results are returned in the response.

Request example

GET /api/v2/goals/

Response body parameters

The response body includes:

• count (integer). The number of the results.
• next and previous (strings). URLs to the next and previous pages (if you used pagination in the original request).
• results (array). This array includes a list of goals, sub-goals, OKRs, and OKR key results. Each item has these parameters:
  • api_id (string). The goal or OKR ID. You can use this ID to get more details about the goal or OKR.
  • title_name (string). The goal or OKR title.
  • description (string). The goal or OKR description.
  • department (string). The department to which the goal or OKR is set.
  • team_manager_name (string). The full name of the manager of the team to which the goal or OKR is set.
  • person_name (string). The full name of the employee to whom the goal or OKR is set.
  • person_group_name (string). The name of the employee group to which the goal or OKR is set.
  • responsible_person_name (string). The full name of the person who is responsible for updating the goal or OKR progress.
  • unit (string). The metric used for the goal or OKR. The possible metrics are:
    • perc (percentage).
    • number.
    • bin (binary) means the goal is either completed or not.
    • ISO 4217 currency codes, such as usd or eur.
• baseline_value (string). The number from which the goal progress starts.
• target_value (string). The number reaching which completes the goal.
• current_value (string). The current goal progress.
• start_date (string). The goal or OKR start date.
• target_date (string). The date until which the goal or OKR is planned to be achieved.
• is_complete (boolean). States whether the goal or OKR is completed (true) or not (false).
• rag_status (string). The current goal or OKR status in the RAG (red, amber, green) progress calculation.  
• auto_calculated (boolean). States whether the goal or OKR progress calculates automatically (true) or manually (false).
• is_okr (boolean). States whether the item is an OKR (true) or a goal (false).
• goal_weight (integer). The weight of the goal, sub-goal, OKR, or OKR key result. For example, if the sub-goal A has 3 as its weight, and the sub-goal B has 1, completing the sub-goal A updates the progress of the whole goal to 75%.
• goal_visibility (string). There are two visibility options, public and lineofsight. Lineofsight means the goal or OKR is visible according to the hierarchy, for example, a team goal is visible only to employees from the team. Public means the goal or OKR is visible to everyone in the organization, if they filter and search for this goal or OKR.
• rag_target_based (boolean). States whether the RAG (red, amber, green) progress calculation is based on target (true) or time (false).

Response body example

The successful 200 response returns the body similar to this:

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "api_id": "580:fef0d7fb-c87a-4607-936f-7a87f9bad6d6",
     "title": "Increase sales by 20%",
     "description": "",
     "department": null,
     "team_manager_name": null,
     "person_name": "Joanne Stefani",
     "person_group_name": null,
     "responsible_person_name": null,
     "unit": "perc",
     "baseline_value": "0.0000",
     "target_value": "100.0000",
     "current_value": "20.0000",
     "start_date": "2025-01-01",
     "target_date": "2025-12-31",
     "is_complete": false,
     "rag_status": "RED",
     "auto_calculated": false,
     "is_okr": false,
     "goal_weight": 1,
     "goal_visibility": "lineofsight",
     "rag_target_based": false
   }
]
}

Get the details of a particular goal or OKR by its ID

GET api/v2/goals/{api_id}/

After getting the goal or OKR api_id in the response to the previous request, you can use this ID to get more information about the goal or OKR.

Required path parameter

• api_id (string). The goal, sub-goal, OKR, or OKR key result ID you can get by sending the GET /api/v2/goals/ request.

Request example

GET /api/v2/goals/580%3Afef0d7fb-c87a-4607-936f-7a87f9bad6d6

Response body parameters

The GET api/v2/goals/{api_id}/ response includes the same parameters as the results array in the GET /api/v2/goals/ response.

Response body example

The successful 200 response returns the body similar to this:

{
 "api_id": "580:fef0d7fb-c87a-4607-936f-7a87f9bad6d6",
 "title": "Increase sales by 20%",
 "description": "",
 "department": null,
 "team_manager_name": null,
 "person_name": "Joanne Stefani",
 "person_group_name": null,
 "responsible_person_name": null,
 "unit": "perc",
 "baseline_value": "0.0000",
 "target_value": "100.0000",
 "current_value": "20.0000",
 "start_date": "2025-01-01",
 "target_date": "2025-12-31",
 "is_complete": false,
 "rag_status": "RED",
 "auto_calculated": false,
 "is_okr": false,
 "goal_weight": 1,
 "goal_visibility": "lineofsight",
 "rag_target_based": false
}