Objectives
Objectives let you capture company, team or personal goals as part of the OKR process.
Attribute | Type | Description |
id | string | Unique objective identifier |
name | string | Name of the objective |
created_at | string | Time when the objective was created. RFC 3339 format |
modified_at | string | Time when the objective was last updated. RFC 3339 format |
team_id | string, nullable | Unique team identifier. Indicates the team assigned to the objective |
assignee_id | string, nullable | Unique user identifier. Indicates the user assigned to the objective |
description | string, nullable | Description of the objective |
is_personal | bool | Flag indicating whether this is a personal objective |
is_company | bool | Flag indicating whether this is a company objective |
parent_objective_id | string, nullable | Unique objective identifier. Indicates objective alignment |
cycle_id | string | Unique delivery cycle identifier. Indicates the delivery cycle this objective belongs to |
Example:
{
"id": "16682617-f25d-4df2-9f51-3c38298996b8",
"name": "Become best at OKRs",
"created_at": "2018-02-20T12:32:56Z",
"modified_at": "2018-02-20T12:32:56Z",
"team_id": null,
"assignee_id": null,
"description": null,
"is_personal": false,
"is_company": true,
"parent_objective_id": null,
"cycle_id": "12345678-f25d-4df2-9f51-3c38298996b8"
}
post
https://api.simpleokr.com
/v1/objectives
Create Objective
post
https://api.simpleokr.com
/v1/objectives/:id
Update Objective
get
https://api.simpleokr.com
/v1/objectives
List Objectives
get
https://api.simpleokr.com
/v1/objectives/:id
Retrieve Objective
delete
https://api.simpleokr.com
/v1/objectives/:id
Delete Objective
get
https://api.simpleokr.com
/v1/objectives/:id/keyresults
List Key Results
post
https://api.simpleokr.com
/v1/objectives/:id/keyresults
Create Key Result
Last modified 3yr ago