Objectives

GET all objectives for a plan

Get all objectives in a specific plan

GET https://api.tability.app/v2/workspaces/:workspaceID/plans/:planID/objectives

Path Parameters

Name	Type	Description
:workspaceID*	String	Unique ID of the workspace
:planID*	String	Unique ID of the plan (UUID or Nano ID)

200: OK OK

[
    {
        "id": "2655f287-b980-49e8-9d43-8e2fb79467ef",
        "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
        "nano_slug": "7hDaOLMcvHqg",
        "plan_id": "b82dc810-75d9-4010-bc25-e29f536289ea",
        "rank": "~na",
        "title": "Grow our existing business revenue to become market leader",
        "created_at": "2023-11-23T12:41:13.658Z",
        "updated_at": "2023-11-29T05:55:15.811Z",
        "archived": false,
        "outcome_progress_prct": 0.310344827586207,
        "initiative_progress_prct": 0.0,
        "total_initiatives_count": 0,
        "closed_initiatives_count": 0,
        "grey_outcomes_count": 0,
        "red_outcomes_count": 0,
        "yellow_outcomes_count": 0,
        "green_outcomes_count": 1,
        "total_outcomes_count": 1,
        "ncs": 100.0,
        "description": "",
        "cached_tag_list": "Raise Visibility"
    },
    {
        "id": "7f3edcbf-b20b-4dac-ae5f-53e391a0d46a",
        "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
        "nano_slug": "FbQJ30iXi_gU",
        "plan_id": "b82dc810-75d9-4010-bc25-e29f536289ea",
        "rank": "~nb",
        "title": "Launch new Products and Services to get recurring revenue",
        "created_at": "2023-11-23T12:41:13.860Z",
        "updated_at": "2023-11-23T12:41:13.860Z",
        "archived": false,
        "outcome_progress_prct": 0.0,
        "initiative_progress_prct": 0.0,
        "total_initiatives_count": 0,
        "closed_initiatives_count": 0,
        "grey_outcomes_count": 1,
        "red_outcomes_count": 0,
        "yellow_outcomes_count": 0,
        "green_outcomes_count": 0,
        "total_outcomes_count": 1,
        "ncs": 0.0,
        "description": null,
        "cached_tag_list": null
    }
]

GET a specific objective

Get the details for a specific objective

GET https://api.tability.app/v2/workspaces/:workspaceID/objectives/:objectiveID

Path Parameters

Name	Type	Description
:workspaceID*	String	Unique ID of the workspace
:objectiveId*	String	Unique ID of the objective (UUID or Nano ID)

200: OK OK

{
    "id": "2655f287-b980-49e8-9d43-8e2fb79467ef",
    "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
    "nano_slug": "7hDaOLMcvHqg",
    "plan_id": "b82dc810-75d9-4010-bc25-e29f536289ea",
    "rank": "~na",
    "title": "Grow our existing business revenue to become market leader",
    "created_at": "2023-11-23T12:41:13.658Z",
    "updated_at": "2023-11-29T05:55:15.811Z",
    "archived": false,
    "outcome_progress_prct": 0.310344827586207,
    "initiative_progress_prct": 0.0,
    "total_initiatives_count": 0,
    "closed_initiatives_count": 0,
    "grey_outcomes_count": 0,
    "red_outcomes_count": 0,
    "yellow_outcomes_count": 0,
    "green_outcomes_count": 1,
    "total_outcomes_count": 1,
    "ncs": 100.0,
    "description": "",
    "cached_tag_list": "Raise Visibility",
    "plan": {
        "id": "b82dc810-75d9-4010-bc25-e29f536289ea",
        "parent_id": null,
        "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
        "nano_slug": "kHmU5VuMY0Tl",
        "title": "Company OKRs 2023 Q4",
        "plan_icon": "",
        "start_at": "2023-10-01T00:00:00.000Z",
        "finish_at": "2023-12-31T00:00:00.000Z",
        "state": "published",
        "created_at": "2023-11-23T12:41:13.597Z",
        "updated_at": "2023-11-29T05:55:20.712Z",
        "outcome_progress_prct": 0.133004926108374,
        "initiative_progress_prct": 0.0,
        "red_outcomes_count": 0,
        "yellow_outcomes_count": 0,
        "green_outcomes_count": 1,
        "grey_outcomes_count": 4,
        "total_outcomes_count": 5,
        "ncs": 20.0,
        "total_initiatives_count": 0,
        "closed_initiatives_count": 0,
        "archived": false,
        "cached_tag_list": null,
        "reminders_hour": 8,
        "reminders_start_at": null,
        "reminders_interval": 1,
        "reminders_period": "week",
        "active": true,
        "expired": false
    }
}