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"}
postCreate Objective
post
https://api.simpleokr.com/v1/objectives
Create a new Objective.
Request
Response
Request
Body Parameters
parent_objective_id
optional
string
Existing Objective ID. Indicates parent objective.
cycle_id
required
string
Cycle ID.
is_company
optional
boolean
When true, mark objective as company objective.
is_personal
optional
boolean
When true, mark objective as personal objective.
description
optional
string
Short objective description.
assignee_id
optional
string
User ID. Indicates the user assigned to the objective.
team_id
optional
string
Team ID. Indicates the team assigned to the objective.
name
required
string
Name of the objective.
Response
200: OK
{"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"}
postUpdate Objective
post
https://api.simpleokr.com/v1/objectives/:id
Update an existing new Objective.
Request
Response
Request
Path Parameters
id
required
string
ID of the objective that you want to update.
Body Parameters
parent_objective_id
optional
string
Existing Objective ID. Indicates parent objective.
cycle_id
required
string
Cycle ID.
is_company
optional
boolean
When true, mark objective as company objective.
is_personal
optional
boolean
When true, mark objective as personal objective.
description
optional
string
Short objective description.
assignee_id
optional
string
User ID. Indicates the user assigned to the objective.
team_id
optional
string
Team ID. Indicates the team assigned to the objective.
name
required
string
Name of the objective.
Response
200: OK
{"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"}
getList Objectives
get
https://api.simpleokr.com/v1/objectives
Returns a list of available objectives.
Request
Response
Request
Query Parameters
page_token
optional
string
Page identifier
cycle_id
required
string
Cycle ID for which to return Objectives
Response
200: OK
{"next_page_token": null,"objectives": [{"name": "Become best at OKRs","cycle_id": "12345678-f25d-4df2-9f51-3c38298996b8","description": null,"team_id": null,"assignee_id": null,"parent_objective_id": null,"is_company": true,"is_personal": false},{...},{...}]}
getRetrieve Objective
get
https://api.simpleokr.com/v1/objectives/:id
Retrieve details about the existing objective.
Request
Response
Request
Path Parameters
id
required
string
Objective ID
Response
200: OK
{"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"}
deleteDelete Objective
delete
https://api.simpleokr.com/v1/objectives/:id
Delete an existing Objective and all data associated with it.
Request
Response
Request
Response
200: OK
getList Key Results
get
https://api.simpleokr.com/v1/objectives/:id/keyresults
List Key Results for an existing objective.
Request
Response
Request
Path Parameters
id
required
string
Objective ID
Response
200: OK
postCreate Key Result
post
https://api.simpleokr.com/v1/objectives/:id/keyresults
Add a new Key Result to an existing Objective
Request
Response
Request
Path Parameters
id
required
string
Objective ID
Body Parameters
confidence
required
string
Decimal string value between 0 and 1.
target_value_max
optional
string
Maximum target value where applicable.
target_value_min
optional
string
Minimum target value where applicable.
current_value
required
string
Decimal string representing starting value.
type
required
string
Key Result type.
name
required
string
Key Result name.
Response
200: OK
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "$40K in revenue from subscription sales","created_at": "2018-02-20T12:32:56Z","modified_at": "2018-02-20T12:32:56Z","objective_id": "12345678-f25d-4df2-9f51-3c38298996b8","type": "positive","confidence": "0.50","current_value": "10000.00","target_value_min": "40000.00","target_value_max": null}
Last updated 7 months ago