Initiatives

GET all initiatives for a plan

Get all initiatives for a specific plan

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

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": "53e8fb8a-3aaf-4f79-bf6c-62be4e10fac7",
        "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
        "nano_slug": "Dw4DBcMrBJPM",
        "outcome_id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
        "title": "Sales team all walks through competitor set up change for x",
        "rank": "~f",
        "column_rank": "~n",
        "state": "open",
        "created_at": "2023-11-23T11:27:37.638Z",
        "updated_at": "2023-12-05T21:49:49.871Z",
        "membership_id": "4ecd99c0-9224-40df-b05a-5a4f19f93473",
        "work_state": "planned",
        "roadmap_state": "later",
        "roadmap_now_at": null,
        "closed_at": null,
        "archived": false,
        "due_at": "2023-12-07T00:00:00.000Z",
        "body": "",
        "cached_tag_list": null,
        "membership": {
            "id": "4ecd99c0-9224-40df-b05a-5a4f19f93473",
            "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
            "user_id": "39464ead-d2d9-4a2a-bc6f-0f99eb858c7c",
            "role": "user",
            "created_at": "2023-11-23T11:27:37.135Z",
            "updated_at": "2023-11-23T11:27:38.016Z",
            "cached_email": "[email protected]",
            "cached_firstname": "Lucy",
            "cached_lastname": "Dang (sample)",
            "cached_avatar_url": "https://res.cloudinary.com/tability/image/upload/v1625719560/dummy_data/persona_lucy_dang_oktlbx.png"
        }
    },
    {
        "id": "8cafd11b-9d0a-433f-a13c-a78b669c9839",
        "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
        "nano_slug": "cbMLpzE-0Jj2",
        "outcome_id": "561a1404-ae77-40a3-86be-a255ed0b77f4",
        "title": "Roll out gifts for existing customers",
        "rank": "~f",
        "column_rank": "~n",
        "state": "open",
        "created_at": "2023-11-23T11:27:38.306Z",
        "updated_at": "2023-11-23T11:27:38.306Z",
        "membership_id": "1392bc60-06b6-452c-ba75-16e2b4a7232e",
        "work_state": "backlog",
        "roadmap_state": "later",
        "roadmap_now_at": null,
        "closed_at": null,
        "archived": false,
        "due_at": "2023-12-21T00:00:00.000Z",
        "body": "",
        "cached_tag_list": null,
        "membership": {
            "id": "1392bc60-06b6-452c-ba75-16e2b4a7232e",
            "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
            "user_id": "1826b2bd-ee8d-42ac-9a04-2ece80233f33",
            "role": "user",
            "created_at": "2023-11-23T11:27:36.114Z",
            "updated_at": "2023-11-23T11:27:38.419Z",
            "cached_email": "[email protected]",
            "cached_firstname": "Kiran",
            "cached_lastname": "Richardson (sample)",
            "cached_avatar_url": "https://res.cloudinary.com/tability/image/upload/v1625719560/dummy_data/persona_kiran_richardson_i6k7ey.png"
        }
    }
]

GET all initiatives for a specific outcome

Get all outcomes for a specific objective

GET https://api.tability.dev:3001/v2/workspaces/:workspaceID/outcomes/:outcomeID/initiatives

Path Parameters

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

200: OK OK

[
    {
        "id": "53e8fb8a-3aaf-4f79-bf6c-62be4e10fac7",
        "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
        "nano_slug": "Dw4DBcMrBJPM",
        "outcome_id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
        "title": "Sales team all walks through competitor set up change for x",
        "rank": "~f",
        "column_rank": "~n",
        "state": "open",
        "created_at": "2023-11-23T11:27:37.638Z",
        "updated_at": "2023-12-05T21:49:49.871Z",
        "membership_id": "4ecd99c0-9224-40df-b05a-5a4f19f93473",
        "work_state": "planned",
        "roadmap_state": "later",
        "roadmap_now_at": null,
        "closed_at": null,
        "archived": false,
        "due_at": "2023-12-07T00:00:00.000Z",
        "body": "",
        "cached_tag_list": null,
        "membership": {
            "id": "4ecd99c0-9224-40df-b05a-5a4f19f93473",
            "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
            "user_id": "39464ead-d2d9-4a2a-bc6f-0f99eb858c7c",
            "role": "user",
            "created_at": "2023-11-23T11:27:37.135Z",
            "updated_at": "2023-11-23T11:27:38.016Z",
            "cached_email": "[email protected]",
            "cached_firstname": "Lucy",
            "cached_lastname": "Dang (sample)",
            "cached_avatar_url": "https://res.cloudinary.com/tability/image/upload/v1625719560/dummy_data/persona_lucy_dang_oktlbx.png"
        }
    },
    {
        "id": "4308c5c8-2cdb-4b89-bf0c-48caba258e76",
        "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
        "nano_slug": "KgnImT5a7LFR",
        "outcome_id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
        "title": "Roll out gift basket gift for high priority leads",
        "rank": "~g",
        "column_rank": "~n",
        "state": "open",
        "created_at": "2023-11-23T11:27:37.574Z",
        "updated_at": "2023-11-23T11:27:37.574Z",
        "membership_id": "784506bf-d098-42e9-b3c9-64b45bcf8683",
        "work_state": "in_progress",
        "roadmap_state": "later",
        "roadmap_now_at": null,
        "closed_at": null,
        "archived": false,
        "due_at": "2023-11-30T00:00:00.000Z",
        "body": "",
        "cached_tag_list": null,
        "membership": {
            "id": "784506bf-d098-42e9-b3c9-64b45bcf8683",
            "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
            "user_id": "3661d1d7-5343-4932-9e98-dd167b4594bd",
            "role": "user",
            "created_at": "2023-11-23T11:27:34.984Z",
            "updated_at": "2023-11-23T11:27:37.797Z",
            "cached_email": "[email protected]",
            "cached_firstname": "Seiji",
            "cached_lastname": "Ono (sample)",
            "cached_avatar_url": "https://res.cloudinary.com/tability/image/upload/v1625719561/dummy_data/persona_seiji_ono_sxzlrn.png"
        }
    }
]

GET a specific initiative

Get the details of a specific initiative

GET https://api.tability.app/v2/workspaces/:workspaceID/initiatives/:initiativeID

Path Parameters

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

200: OK OK

{
    "id": "53e8fb8a-3aaf-4f79-bf6c-62be4e10fac7",
    "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
    "nano_slug": "Dw4DBcMrBJPM",
    "outcome_id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
    "title": "Sales team all walks through competitor set up change for x",
    "rank": "~f",
    "column_rank": "~n",
    "state": "open",
    "created_at": "2023-11-23T11:27:37.638Z",
    "updated_at": "2023-12-05T21:49:49.871Z",
    "membership_id": "4ecd99c0-9224-40df-b05a-5a4f19f93473",
    "work_state": "planned",
    "roadmap_state": "later",
    "roadmap_now_at": null,
    "closed_at": null,
    "archived": false,
    "body": "",
    "due_at": "2023-12-07T00:00:00.000Z",
    "cached_tag_list": null,
    "membership": {
        "id": "4ecd99c0-9224-40df-b05a-5a4f19f93473",
        "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
        "user_id": "39464ead-d2d9-4a2a-bc6f-0f99eb858c7c",
        "role": "user",
        "created_at": "2023-11-23T11:27:37.135Z",
        "updated_at": "2023-11-23T11:27:38.016Z",
        "cached_email": "[email protected]",
        "cached_firstname": "Lucy",
        "cached_lastname": "Dang (sample)",
        "cached_avatar_url": "https://res.cloudinary.com/tability/image/upload/v1625719560/dummy_data/persona_lucy_dang_oktlbx.png"
    },
    "plan": {
        "id": "0044993f-069a-4718-8139-306c01972b44",
        "parent_id": null,
        "workspace_id": "f709df85-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",
        "archived": false,
        "cached_tag_list": null,
        "active": true,
        "expired": false
    },
    "outcome": {
        "id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
        "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
        "nano_slug": "j4Jlkboa7H3g",
        "objective_id": "9baab5b7-5ebb-4261-81e1-5ec0a9d2d860",
        "rank": "~nb",
        "title": "Increase Quarterly Sales Revenue from $1 million to $1.3 million",
        "description": "",
        "from": 1000000.0,
        "to": 1300000.0,
        "score_format": "$_number_w",
        "created_at": "2023-11-23T11:27:37.206Z",
        "updated_at": "2023-12-07T01:15:34.078Z",
        "archived": false,
        "completed": false,
        "is_dummy": true,
        "outcome_type": "improve_metric",
        "weight": 1,
        "membership": {
            "id": "784506bf-d098-42e9-b3c9-64b45bcf8683",
            "workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
            "user_id": "3661d1d7-5343-4932-9e98-dd167b4594bd",
            "role": "user",
            "created_at": "2023-11-23T11:27:34.984Z",
            "updated_at": "2023-11-23T11:27:37.797Z",
            "cached_email": "[email protected]",
            "cached_firstname": "Seiji",
            "cached_lastname": "Ono (sample)",
            "cached_avatar_url": "https://res.cloudinary.com/tability/image/upload/v1625719561/dummy_data/persona_seiji_ono_sxzlrn.png"
        }
    }
}