Plans

GET all plans in a workspace

Get all the plans in a specific workspace

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

Path Parameters

Name	Type	Description
:workspaceID*	String	Unique ID of the workspace

Request Body

Name	Type	Description
page	number	Identifier of the page results to fetch

200: OK OK

[
    {
        "id": "abcd1234-75d9-4010-bc25-e29f536289ea",
        "parent_id": null,
        "workspace_id": "abcd1234-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,
        "parent": null
    },
    {
        "id": "abcd1234-069a-4718-8139-306c01972b44",
        "parent_id": null,
        "workspace_id": "abcd1234-fa72-43d4-b398-db159ec6f8da",
        "nano_slug": "O-7xOV5nKdRy",
        "title": "Company Quarterly Goals 2023",
        "plan_icon": ":cityscape:",
        "start_at": "2023-10-12T00:00:00.000Z",
        "finish_at": "2024-01-04T00:00:00.000Z",
        "state": "published",
        "created_at": "2023-11-23T11:27:37.155Z",
        "updated_at": "2023-12-07T01:15:34.149Z",
        "outcome_progress_prct": 0.391111111111111,
        "initiative_progress_prct": 0.277777777777778,
        "red_outcomes_count": 2,
        "yellow_outcomes_count": 1,
        "green_outcomes_count": 2,
        "grey_outcomes_count": 0,
        "total_outcomes_count": 5,
        "ncs": 0.0,
        "total_initiatives_count": 18,
        "closed_initiatives_count": 5,
        "archived": false,
        "cached_tag_list": null,
        "reminders_hour": 8,
        "reminders_start_at": null,
        "reminders_interval": 1,
        "reminders_period": "week",
        "active": true,
        "expired": false,
        "parent": null
    }
]

GET a specific plan

Get the details for a specific plan

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

Path Parameters

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

200: OK OK

{
    "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,
    "parent": null
}