Initiatives API


POST /api/v1/products/:product_id/initiatives

Create an initiative

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the initiative in
name * Name of the initiative
workflow_status * Status of the initiative.
description Description of the initiative and it can include HTML formatting.
effort Effort required for the initiative
value Value the initiative brings to the business
parent_id ID of an initiative to roll up to in the product line, Roll up an initiative to a product line initiative by 1) creating an initiative for the product line 2) choosing that initiative in this control. You can then visualize how releases relate to your strategic initiatives throughout Aha!
presented Whether this initiative is shown on charts
start_date Start date for the initiative in format YYYY-MM-DD
end_date Start date for the initiative in format YYYY-MM-DD

POST /api/v1/products/PRJ1/initiatives

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/initiatives" -d '{"initiative":{"name":"Initiative 3","workflow_status":{"name":"Not Started"},"description":"Our first big initiative","time_frame":{"id":813624702},"effort":15,"value":5,"presented":true}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "initiative": {
    "name": "Initiative 3",
    "workflow_status": {
      "name": "Not Started"
    },
    "description": "Our first big initiative",
    "time_frame": {
      "id": 813624702
    },
    "effort": 15,
    "value": 5,
    "presented": true
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "initiative": {
    "id": "6548778336715823089",
    "name": "Initiative 3",
    "status": "not_started",
    "effort": 15,
    "value": 5,
    "presented": true,
    "start_date": null,
    "end_date": null,
    "position": 3,
    "created_at": "2018-04-26T15:24:35.281Z",
    "updated_at": "2018-04-26T15:24:35.281Z",
    "url": "http://account1.example.org/initiatives/6548778336715823089",
    "resource": "http://account1.example.org/api/v1/initiatives/6548778336715823089",
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-04-26T15:23:54.000Z"
    },
    "workflow_status": {
      "id": "53968949",
      "name": "Not Started",
      "position": 1,
      "complete": false
    },
    "description": {
      "id": "6548778336725236498",
      "body": "Our first big initiative",
      "created_at": "2018-04-26T15:24:35.286Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "time_frame": {
      "id": 813624702,
      "name": "2015"
    },
    "comments_count": 0,
    "goals": [

    ],
    "features": [

    ],
    "master_features": [

    ],
    "releases": [

    ],
    "integration_fields": [

    ],
    "custom_fields": [

    ],
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z"
    }
  }
}

GET /api/v1/initiatives

Get all initiatives

GET /api/v1/initiatives

Example CURL command

curl -g "https://account1.aha.io/api/v1/initiatives" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "initiatives": [
    {
      "id": "423077122",
      "name": "Initiative 1",
      "status": "not_started",
      "effort": 10,
      "value": 70,
      "presented": true,
      "start_date": "2018-03-26",
      "end_date": "2018-05-10",
      "position": 1,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 1,
      "goals": [
        {
          "id": "602095703",
          "name": "Goal 1",
          "url": "http://account1.example.org/strategic_imperatives/602095703",
          "resource": "http://account1.example.org/api/v1/goals/602095703",
          "created_at": "2018-04-26T15:23:53.000Z",
          "description": {
            "id": "166463080",
            "body": "Description of goal 1",
            "created_at": "2018-04-26T15:23:54.000Z",
            "attachments": [

            ]
          }
        }
      ],
      "features": [
        {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-04-26T15:23:54.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1"
        }
      ],
      "master_features": [
        {
          "id": "362457003",
          "reference_num": "PRJ1-E-3",
          "name": "And a third",
          "created_at": "2018-04-26T15:23:53.000Z",
          "url": "http://account1.example.org/epics/PRJ1-E-3",
          "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-3"
        },
        {
          "id": "580753216",
          "reference_num": "PRJ1-E-2",
          "name": "Here's another epic",
          "created_at": "2018-04-26T15:23:53.000Z",
          "url": "http://account1.example.org/epics/PRJ1-E-2",
          "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-2"
        },
        {
          "id": "999605892",
          "reference_num": "PRJ1-E-1",
          "name": "Epic 1",
          "created_at": "2018-04-26T15:23:53.000Z",
          "url": "http://account1.example.org/epics/PRJ1-E-1",
          "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
        }
      ],
      "releases": [
        {
          "id": "278327321",
          "reference_num": "PRJ1-R-1",
          "name": "Release 1",
          "start_date": "2018-05-03",
          "release_date": "2018-05-03",
          "parking_lot": false,
          "created_at": "2018-04-26T15:23:53.000Z",
          "integration_fields": [
            {
              "id": "68217473",
              "name": "id",
              "value": "777",
              "integration_id": 204584239,
              "service_name": "jira",
              "created_at": "2018-04-26T15:23:53.000Z"
            }
          ],
          "url": "http://account1.example.org/releases/PRJ1-R-1",
          "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
          "owner": {
            "id": "16338845",
            "name": "John Smith",
            "email": "john.smith@account1.com",
            "created_at": "2018-04-26T15:23:53.000Z",
            "updated_at": "2018-04-26T15:23:53.000Z"
          },
          "project": {
            "id": "131414752",
            "reference_prefix": "PRJ1",
            "name": "Project 1",
            "product_line": false,
            "created_at": "2018-04-26T15:23:54.000Z"
          }
        },
        {
          "id": "161456549",
          "reference_num": "PRJ1-R-2",
          "name": "Release 2",
          "start_date": "2018-03-26",
          "release_date": "2018-05-10",
          "parking_lot": false,
          "created_at": "2018-04-26T15:23:53.000Z",
          "integration_fields": [

          ],
          "url": "http://account1.example.org/releases/PRJ1-R-2",
          "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-2",
          "owner": {
            "id": "16338845",
            "name": "John Smith",
            "email": "john.smith@account1.com",
            "created_at": "2018-04-26T15:23:53.000Z",
            "updated_at": "2018-04-26T15:23:53.000Z"
          },
          "project": {
            "id": "131414752",
            "reference_prefix": "PRJ1",
            "name": "Project 1",
            "product_line": false,
            "created_at": "2018-04-26T15:23:54.000Z"
          }
        }
      ],
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-04-26T15:23:53.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-04-26T15:23:53.000Z"
        }
      ],
      "custom_fields": [

      ]
    },
    {
      "id": "4125886",
      "name": "Initiative 2",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/4125886",
      "resource": "http://account1.example.org/api/v1/initiatives/4125886",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "824706757",
        "body": "Description of initiative 2",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "219956332",
      "name": "Initiative 3",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/219956332",
      "resource": "http://account1.example.org/api/v1/initiatives/219956332",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "338250583",
        "body": "Description of project1_initiative3_no_epoch",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "1042392694",
      "name": "Initiative 3",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 1,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/1042392694",
      "resource": "http://account1.example.org/api/v1/initiatives/1042392694",
      "project": {
        "id": "610602692",
        "reference_prefix": "PL1",
        "name": "Product Line 1",
        "product_line": true,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "133079347",
        "body": "Description of product_line1_initiative1",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "330016191",
      "name": "Initiative 4",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/330016191",
      "resource": "http://account1.example.org/api/v1/initiatives/330016191",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "999437064",
        "body": "Description of project1_initiative4_active_epoch",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "time_frame": {
        "id": 273422810,
        "name": "2017"
      },
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "259736534",
      "name": "Initiative 5",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/259736534",
      "resource": "http://account1.example.org/api/v1/initiatives/259736534",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "1040636124",
        "body": "Description of project1_initiative5_archived_epoch",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "time_frame": {
        "id": 834757622,
        "name": "2018"
      },
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "595848429",
      "name": "Initiative complete",
      "status": "done",
      "effort": 10,
      "value": 70,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 1,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/595848429",
      "resource": "http://account1.example.org/api/v1/initiatives/595848429",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "509459046",
        "name": "Done",
        "position": 4,
        "complete": true
      },
      "description": {
        "id": "6548778339358010571",
        "body": "",
        "created_at": "2018-04-26T15:24:35.897Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    }
  ],
  "pagination": {
    "total_records": 7,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/goals/:goal_id/initiatives

Get all initiatives associated with a goal

Parameters

Name Description
goal_id * Numeric ID of the goal to get initiatives for

GET /api/v1/goals/602095703/initiatives

Example CURL command

curl -g "https://account1.aha.io/api/v1/goals/602095703/initiatives" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "initiatives": [
    {
      "id": "423077122",
      "name": "Initiative 1",
      "status": "not_started",
      "effort": 10,
      "value": 70,
      "presented": true,
      "start_date": "2018-03-26",
      "end_date": "2018-05-10",
      "position": 1,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 1,
      "goals": [
        {
          "id": "602095703",
          "name": "Goal 1",
          "url": "http://account1.example.org/strategic_imperatives/602095703",
          "resource": "http://account1.example.org/api/v1/goals/602095703",
          "created_at": "2018-04-26T15:23:53.000Z",
          "description": {
            "id": "166463080",
            "body": "Description of goal 1",
            "created_at": "2018-04-26T15:23:54.000Z",
            "attachments": [

            ]
          }
        }
      ],
      "features": [
        {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-04-26T15:23:54.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1"
        }
      ],
      "master_features": [
        {
          "id": "362457003",
          "reference_num": "PRJ1-E-3",
          "name": "And a third",
          "created_at": "2018-04-26T15:23:53.000Z",
          "url": "http://account1.example.org/epics/PRJ1-E-3",
          "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-3"
        },
        {
          "id": "580753216",
          "reference_num": "PRJ1-E-2",
          "name": "Here's another epic",
          "created_at": "2018-04-26T15:23:53.000Z",
          "url": "http://account1.example.org/epics/PRJ1-E-2",
          "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-2"
        },
        {
          "id": "999605892",
          "reference_num": "PRJ1-E-1",
          "name": "Epic 1",
          "created_at": "2018-04-26T15:23:53.000Z",
          "url": "http://account1.example.org/epics/PRJ1-E-1",
          "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
        }
      ],
      "releases": [
        {
          "id": "278327321",
          "reference_num": "PRJ1-R-1",
          "name": "Release 1",
          "start_date": "2018-05-03",
          "release_date": "2018-05-03",
          "parking_lot": false,
          "created_at": "2018-04-26T15:23:53.000Z",
          "integration_fields": [
            {
              "id": "68217473",
              "name": "id",
              "value": "777",
              "integration_id": 204584239,
              "service_name": "jira",
              "created_at": "2018-04-26T15:23:53.000Z"
            }
          ],
          "url": "http://account1.example.org/releases/PRJ1-R-1",
          "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
          "owner": {
            "id": "16338845",
            "name": "John Smith",
            "email": "john.smith@account1.com",
            "created_at": "2018-04-26T15:23:53.000Z",
            "updated_at": "2018-04-26T15:23:53.000Z"
          },
          "project": {
            "id": "131414752",
            "reference_prefix": "PRJ1",
            "name": "Project 1",
            "product_line": false,
            "created_at": "2018-04-26T15:23:54.000Z"
          }
        },
        {
          "id": "161456549",
          "reference_num": "PRJ1-R-2",
          "name": "Release 2",
          "start_date": "2018-03-26",
          "release_date": "2018-05-10",
          "parking_lot": false,
          "created_at": "2018-04-26T15:23:53.000Z",
          "integration_fields": [

          ],
          "url": "http://account1.example.org/releases/PRJ1-R-2",
          "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-2",
          "owner": {
            "id": "16338845",
            "name": "John Smith",
            "email": "john.smith@account1.com",
            "created_at": "2018-04-26T15:23:53.000Z",
            "updated_at": "2018-04-26T15:23:53.000Z"
          },
          "project": {
            "id": "131414752",
            "reference_prefix": "PRJ1",
            "name": "Project 1",
            "product_line": false,
            "created_at": "2018-04-26T15:23:54.000Z"
          }
        }
      ],
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-04-26T15:23:53.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-04-26T15:23:53.000Z"
        }
      ],
      "custom_fields": [

      ]
    },
    {
      "id": "4125886",
      "name": "Initiative 2",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/4125886",
      "resource": "http://account1.example.org/api/v1/initiatives/4125886",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "824706757",
        "body": "Description of initiative 2",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "219956332",
      "name": "Initiative 3",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/219956332",
      "resource": "http://account1.example.org/api/v1/initiatives/219956332",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "338250583",
        "body": "Description of project1_initiative3_no_epoch",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "1042392694",
      "name": "Initiative 3",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 1,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/1042392694",
      "resource": "http://account1.example.org/api/v1/initiatives/1042392694",
      "project": {
        "id": "610602692",
        "reference_prefix": "PL1",
        "name": "Product Line 1",
        "product_line": true,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "133079347",
        "body": "Description of product_line1_initiative1",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "330016191",
      "name": "Initiative 4",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/330016191",
      "resource": "http://account1.example.org/api/v1/initiatives/330016191",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "999437064",
        "body": "Description of project1_initiative4_active_epoch",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "time_frame": {
        "id": 273422810,
        "name": "2017"
      },
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "259736534",
      "name": "Initiative 5",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/259736534",
      "resource": "http://account1.example.org/api/v1/initiatives/259736534",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "1040636124",
        "body": "Description of project1_initiative5_archived_epoch",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "time_frame": {
        "id": 834757622,
        "name": "2018"
      },
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "595848429",
      "name": "Initiative complete",
      "status": "done",
      "effort": 10,
      "value": 70,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 1,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/595848429",
      "resource": "http://account1.example.org/api/v1/initiatives/595848429",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "509459046",
        "name": "Done",
        "position": 4,
        "complete": true
      },
      "description": {
        "id": "6548778341400823395",
        "body": "",
        "created_at": "2018-04-26T15:24:36.370Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    }
  ],
  "pagination": {
    "total_records": 7,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/products/:product_id/initiatives

Get all initiatives for a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to get initiatives for

GET /api/v1/products/PRJ1/initiatives

Example CURL command

curl -g "https://account1.aha.io/api/v1/products/PRJ1/initiatives" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "initiatives": [
    {
      "id": "423077122",
      "name": "Initiative 1",
      "status": "not_started",
      "effort": 10,
      "value": 70,
      "presented": true,
      "start_date": "2018-03-26",
      "end_date": "2018-05-10",
      "position": 1,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 1,
      "goals": [
        {
          "id": "602095703",
          "name": "Goal 1",
          "url": "http://account1.example.org/strategic_imperatives/602095703",
          "resource": "http://account1.example.org/api/v1/goals/602095703",
          "created_at": "2018-04-26T15:23:53.000Z",
          "description": {
            "id": "166463080",
            "body": "Description of goal 1",
            "created_at": "2018-04-26T15:23:54.000Z",
            "attachments": [

            ]
          }
        }
      ],
      "features": [
        {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-04-26T15:23:54.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1"
        }
      ],
      "master_features": [
        {
          "id": "362457003",
          "reference_num": "PRJ1-E-3",
          "name": "And a third",
          "created_at": "2018-04-26T15:23:53.000Z",
          "url": "http://account1.example.org/epics/PRJ1-E-3",
          "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-3"
        },
        {
          "id": "580753216",
          "reference_num": "PRJ1-E-2",
          "name": "Here's another epic",
          "created_at": "2018-04-26T15:23:53.000Z",
          "url": "http://account1.example.org/epics/PRJ1-E-2",
          "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-2"
        },
        {
          "id": "999605892",
          "reference_num": "PRJ1-E-1",
          "name": "Epic 1",
          "created_at": "2018-04-26T15:23:53.000Z",
          "url": "http://account1.example.org/epics/PRJ1-E-1",
          "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
        }
      ],
      "releases": [
        {
          "id": "278327321",
          "reference_num": "PRJ1-R-1",
          "name": "Release 1",
          "start_date": "2018-05-03",
          "release_date": "2018-05-03",
          "parking_lot": false,
          "created_at": "2018-04-26T15:23:53.000Z",
          "integration_fields": [
            {
              "id": "68217473",
              "name": "id",
              "value": "777",
              "integration_id": 204584239,
              "service_name": "jira",
              "created_at": "2018-04-26T15:23:53.000Z"
            }
          ],
          "url": "http://account1.example.org/releases/PRJ1-R-1",
          "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
          "owner": {
            "id": "16338845",
            "name": "John Smith",
            "email": "john.smith@account1.com",
            "created_at": "2018-04-26T15:23:53.000Z",
            "updated_at": "2018-04-26T15:23:53.000Z"
          },
          "project": {
            "id": "131414752",
            "reference_prefix": "PRJ1",
            "name": "Project 1",
            "product_line": false,
            "created_at": "2018-04-26T15:23:54.000Z"
          }
        },
        {
          "id": "161456549",
          "reference_num": "PRJ1-R-2",
          "name": "Release 2",
          "start_date": "2018-03-26",
          "release_date": "2018-05-10",
          "parking_lot": false,
          "created_at": "2018-04-26T15:23:53.000Z",
          "integration_fields": [

          ],
          "url": "http://account1.example.org/releases/PRJ1-R-2",
          "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-2",
          "owner": {
            "id": "16338845",
            "name": "John Smith",
            "email": "john.smith@account1.com",
            "created_at": "2018-04-26T15:23:53.000Z",
            "updated_at": "2018-04-26T15:23:53.000Z"
          },
          "project": {
            "id": "131414752",
            "reference_prefix": "PRJ1",
            "name": "Project 1",
            "product_line": false,
            "created_at": "2018-04-26T15:23:54.000Z"
          }
        }
      ],
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-04-26T15:23:53.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-04-26T15:23:53.000Z"
        }
      ],
      "custom_fields": [

      ]
    },
    {
      "id": "4125886",
      "name": "Initiative 2",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/4125886",
      "resource": "http://account1.example.org/api/v1/initiatives/4125886",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "824706757",
        "body": "Description of initiative 2",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "219956332",
      "name": "Initiative 3",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/219956332",
      "resource": "http://account1.example.org/api/v1/initiatives/219956332",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "338250583",
        "body": "Description of project1_initiative3_no_epoch",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "330016191",
      "name": "Initiative 4",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/330016191",
      "resource": "http://account1.example.org/api/v1/initiatives/330016191",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "999437064",
        "body": "Description of project1_initiative4_active_epoch",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "time_frame": {
        "id": 273422810,
        "name": "2017"
      },
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "259736534",
      "name": "Initiative 5",
      "status": "not_started",
      "effort": 40,
      "value": 30,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 2,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/259736534",
      "resource": "http://account1.example.org/api/v1/initiatives/259736534",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "53968949",
        "name": "Not Started",
        "position": 1,
        "complete": false
      },
      "description": {
        "id": "1040636124",
        "body": "Description of project1_initiative5_archived_epoch",
        "created_at": "2018-04-26T15:23:54.000Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "time_frame": {
        "id": 834757622,
        "name": "2018"
      },
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "595848429",
      "name": "Initiative complete",
      "status": "done",
      "effort": 10,
      "value": 70,
      "presented": true,
      "start_date": null,
      "end_date": null,
      "position": 1,
      "created_at": "2018-04-26T15:23:53.000Z",
      "updated_at": "2018-04-26T15:23:53.000Z",
      "url": "http://account1.example.org/initiatives/595848429",
      "resource": "http://account1.example.org/api/v1/initiatives/595848429",
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-04-26T15:23:54.000Z"
      },
      "workflow_status": {
        "id": "509459046",
        "name": "Done",
        "position": 4,
        "complete": true
      },
      "description": {
        "id": "6548778344477087227",
        "body": "",
        "created_at": "2018-04-26T15:24:37.088Z",
        "attachments": [

        ]
      },
      "attachments": [

      ],
      "comments_count": 0,
      "goals": [

      ],
      "features": [

      ],
      "master_features": [

      ],
      "releases": [

      ],
      "integration_fields": [

      ],
      "custom_fields": [

      ]
    }
  ],
  "pagination": {
    "total_records": 6,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/initiatives/:id

Get a specific initiative

Parameters

Name Description
id * Numeric ID of the initiative to be retrieved

GET /api/v1/initiatives/423077122

Example CURL command

curl -g "https://account1.aha.io/api/v1/initiatives/423077122" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "initiative": {
    "id": "423077122",
    "name": "Initiative 1",
    "status": "not_started",
    "effort": 10,
    "value": 70,
    "presented": true,
    "start_date": "2018-03-26",
    "end_date": "2018-05-10",
    "position": 1,
    "created_at": "2018-04-26T15:23:53.000Z",
    "updated_at": "2018-04-26T15:23:53.000Z",
    "url": "http://account1.example.org/initiatives/423077122",
    "resource": "http://account1.example.org/api/v1/initiatives/423077122",
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-04-26T15:23:54.000Z"
    },
    "workflow_status": {
      "id": "53968949",
      "name": "Not Started",
      "position": 1,
      "complete": false
    },
    "description": {
      "id": "673273729",
      "body": "Description of initiative 1",
      "created_at": "2018-04-26T15:23:54.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "comments_count": 1,
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-04-26T15:23:53.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-04-26T15:23:54.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "features": [
      {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-04-26T15:23:54.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1"
      }
    ],
    "master_features": [
      {
        "id": "362457003",
        "reference_num": "PRJ1-E-3",
        "name": "And a third",
        "created_at": "2018-04-26T15:23:53.000Z",
        "url": "http://account1.example.org/epics/PRJ1-E-3",
        "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-3"
      },
      {
        "id": "580753216",
        "reference_num": "PRJ1-E-2",
        "name": "Here's another epic",
        "created_at": "2018-04-26T15:23:53.000Z",
        "url": "http://account1.example.org/epics/PRJ1-E-2",
        "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-2"
      },
      {
        "id": "999605892",
        "reference_num": "PRJ1-E-1",
        "name": "Epic 1",
        "created_at": "2018-04-26T15:23:53.000Z",
        "url": "http://account1.example.org/epics/PRJ1-E-1",
        "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
      }
    ],
    "releases": [
      {
        "id": "278327321",
        "reference_num": "PRJ1-R-1",
        "name": "Release 1",
        "start_date": "2018-05-03",
        "release_date": "2018-05-03",
        "parking_lot": false,
        "created_at": "2018-04-26T15:23:53.000Z",
        "integration_fields": [
          {
            "id": "68217473",
            "name": "id",
            "value": "777",
            "integration_id": 204584239,
            "service_name": "jira",
            "created_at": "2018-04-26T15:23:53.000Z"
          }
        ],
        "url": "http://account1.example.org/releases/PRJ1-R-1",
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "john.smith@account1.com",
          "created_at": "2018-04-26T15:23:53.000Z",
          "updated_at": "2018-04-26T15:23:53.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2018-04-26T15:23:54.000Z"
        }
      },
      {
        "id": "161456549",
        "reference_num": "PRJ1-R-2",
        "name": "Release 2",
        "start_date": "2018-03-26",
        "release_date": "2018-05-10",
        "parking_lot": false,
        "created_at": "2018-04-26T15:23:53.000Z",
        "integration_fields": [

        ],
        "url": "http://account1.example.org/releases/PRJ1-R-2",
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-2",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "john.smith@account1.com",
          "created_at": "2018-04-26T15:23:53.000Z",
          "updated_at": "2018-04-26T15:23:53.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2018-04-26T15:23:54.000Z"
        }
      }
    ],
    "integration_fields": [
      {
        "id": "213995437",
        "name": "id",
        "value": "9913333",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2018-04-26T15:23:53.000Z"
      },
      {
        "id": "365436441",
        "name": "key",
        "value": "JRA-987222",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2018-04-26T15:23:53.000Z"
      }
    ],
    "custom_fields": [

    ]
  }
}

PUT /api/v1/products/:product_id/initiatives/:id

Update a initiative

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the initiative in
id * Numeric ID, or key of the initiative to be updated
name Name of the initiative
workflow_status Status of the initiative.
description Description of the initiative and it can include HTML formatting.
effort Effort required for the initiative
value Value the initiative brings to the business
parent_id ID of an initiative to roll up to in the product line, Roll up an initiative to a product line initiative by 1) creating an initiative for the product line 2) choosing that initiative in this control. You can then visualize how releases relate to your strategic initiatives throughout Aha!
presented Whether this initiative is shown on charts
start_date Start date for the initiative in format YYYY-MM-DD
end_date Start date for the initiative in format YYYY-MM-DD

PUT /api/v1/products/PRJ1/initiatives/423077122

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/initiatives/423077122" -d '{"initiative":{"name":"Smarter initiative"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "initiative": {
    "name": "Smarter initiative"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "initiative": {
    "id": "423077122",
    "name": "Smarter initiative",
    "status": "not_started",
    "effort": 10,
    "value": 70,
    "presented": true,
    "start_date": "2018-03-26",
    "end_date": "2018-05-10",
    "position": 1,
    "created_at": "2018-04-26T15:23:53.000Z",
    "updated_at": "2018-04-26T15:24:37.763Z",
    "url": "http://account1.example.org/initiatives/423077122",
    "resource": "http://account1.example.org/api/v1/initiatives/423077122",
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-04-26T15:23:54.000Z"
    },
    "workflow_status": {
      "id": "53968949",
      "name": "Not Started",
      "position": 1,
      "complete": false
    },
    "description": {
      "id": "673273729",
      "body": "Description of initiative 1",
      "created_at": "2018-04-26T15:23:54.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "comments_count": 1,
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-04-26T15:23:53.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-04-26T15:23:54.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "features": [
      {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-04-26T15:23:54.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1"
      }
    ],
    "master_features": [
      {
        "id": "362457003",
        "reference_num": "PRJ1-E-3",
        "name": "And a third",
        "created_at": "2018-04-26T15:23:53.000Z",
        "url": "http://account1.example.org/epics/PRJ1-E-3",
        "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-3"
      },
      {
        "id": "580753216",
        "reference_num": "PRJ1-E-2",
        "name": "Here's another epic",
        "created_at": "2018-04-26T15:23:53.000Z",
        "url": "http://account1.example.org/epics/PRJ1-E-2",
        "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-2"
      },
      {
        "id": "999605892",
        "reference_num": "PRJ1-E-1",
        "name": "Epic 1",
        "created_at": "2018-04-26T15:23:53.000Z",
        "url": "http://account1.example.org/epics/PRJ1-E-1",
        "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
      }
    ],
    "releases": [
      {
        "id": "278327321",
        "reference_num": "PRJ1-R-1",
        "name": "Release 1",
        "start_date": "2018-05-03",
        "release_date": "2018-05-03",
        "parking_lot": false,
        "created_at": "2018-04-26T15:23:53.000Z",
        "integration_fields": [
          {
            "id": "68217473",
            "name": "id",
            "value": "777",
            "integration_id": 204584239,
            "service_name": "jira",
            "created_at": "2018-04-26T15:23:53.000Z"
          }
        ],
        "url": "http://account1.example.org/releases/PRJ1-R-1",
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "john.smith@account1.com",
          "created_at": "2018-04-26T15:23:53.000Z",
          "updated_at": "2018-04-26T15:23:53.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2018-04-26T15:23:54.000Z"
        }
      },
      {
        "id": "161456549",
        "reference_num": "PRJ1-R-2",
        "name": "Release 2",
        "start_date": "2018-03-26",
        "release_date": "2018-05-10",
        "parking_lot": false,
        "created_at": "2018-04-26T15:23:53.000Z",
        "integration_fields": [

        ],
        "url": "http://account1.example.org/releases/PRJ1-R-2",
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-2",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "john.smith@account1.com",
          "created_at": "2018-04-26T15:23:53.000Z",
          "updated_at": "2018-04-26T15:23:53.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2018-04-26T15:23:54.000Z"
        }
      }
    ],
    "integration_fields": [
      {
        "id": "213995437",
        "name": "id",
        "value": "9913333",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2018-04-26T15:23:53.000Z"
      },
      {
        "id": "365436441",
        "name": "key",
        "value": "JRA-987222",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2018-04-26T15:23:53.000Z"
      }
    ],
    "custom_fields": [

    ]
  }
}

DELETE /api/v1/products/:product_id/initiatives/:id

Delete initiative

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the initiative in
id * Numeric ID, or key of the initiative to be deleted

DELETE /api/v1/products/PRJ1/initiatives/423077122

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/initiatives/423077122" -d '' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Overview

API Resources