Initiatives
Get a specific initiative
Changed onget/initiatives/{id}
Request
- Base URLhttps://company.aha.io/api/v1
- Auth
- OAuth 2Authorization codehttps://{account-domain}.aha.io/oauth/authorizeToken URLhttps://{account-domain}.aha.io/oauth/token
- or HTTP bearer
- or API key in cookie session
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
Id identifier
Response
Successful operation
Example response
{
"initiatives": [
{
"id": "4125886",
"name": "Initiative 2",
"reference_num": "PRJ1-S-2",
"status": "not_started",
"effort": 40,
"value": 30,
"presented": true,
"color": "#bada55",
"start_date": null,
"end_date": null,
"position": 2,
"score": 0,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"progress": null,
"progress_source": "progress_manual",
"duration_source": "duration_manual",
"url": "https://company.aha.io/initiatives/PRJ1-S-2",
"resource": "https://company.aha.io/api/v1/initiatives/PRJ1-S-2",
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
},
"workflow_status": {
"id": "53968949",
"name": "Not Started",
"position": 1,
"complete": false,
"color": "#dce7c6",
"workflow_status_category": null
},
"description": {
"id": "824706757",
"body": "Description of initiative 2",
"notable_id": "4125886",
"notable_type": "Initiative",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"attachments": [],
"assigned_to_user": {
"default_assignee": false,
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"comments_count": 0,
"goals": [],
"key_results": [],
"score_facts": [],
"integration_fields": [],
"created_by_user": {
"id": "82352673",
"name": "Bob Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
}
},
{
"id": "219956332",
"name": "Initiative 3",
"reference_num": "PRJ1-S-3",
"status": "not_started",
"effort": 40,
"value": 30,
"presented": true,
"color": "#bada55",
"start_date": null,
"end_date": null,
"position": 2,
"score": 0,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"progress": null,
"progress_source": "progress_manual",
"duration_source": "duration_manual",
"url": "https://company.aha.io/initiatives/PRJ1-S-3",
"resource": "https://company.aha.io/api/v1/initiatives/PRJ1-S-3",
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
},
"workflow_status": {
"id": "53968949",
"name": "Not Started",
"position": 1,
"complete": false,
"color": "#dce7c6",
"workflow_status_category": null
},
"description": {
"id": "338250583",
"body": "Description of project1_initiative3_no_epoch",
"notable_id": "219956332",
"notable_type": "Initiative",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"attachments": [],
"assigned_to_user": {
"default_assignee": true,
"id": "689956296",
"name": "Henry Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"comments_count": 0,
"goals": [],
"key_results": [],
"score_facts": [],
"integration_fields": []
},
{
"id": "259736534",
"name": "Initiative 5",
"reference_num": "PRJ1-S-5",
"status": "not_started",
"effort": 40,
"value": 30,
"presented": true,
"color": "#bada55",
"start_date": null,
"end_date": null,
"position": 2,
"score": 0,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"progress": null,
"progress_source": "progress_manual",
"duration_source": "duration_manual",
"url": "https://company.aha.io/initiatives/PRJ1-S-5",
"resource": "https://company.aha.io/api/v1/initiatives/PRJ1-S-5",
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
},
"workflow_status": {
"id": "53968949",
"name": "Not Started",
"position": 1,
"complete": false,
"color": "#dce7c6",
"workflow_status_category": null
},
"description": {
"id": "1040636124",
"body": "Description of project1_initiative5_archived_epoch",
"notable_id": "259736534",
"notable_type": "Initiative",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"attachments": [],
"assigned_to_user": {
"default_assignee": true,
"id": "689956296",
"name": "Henry Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"time_frame": {
"id": 834757622,
"name": "2018"
},
"comments_count": 0,
"goals": [],
"key_results": [],
"score_facts": [],
"integration_fields": []
},
{
"id": "330016191",
"name": "Initiative 4",
"reference_num": "PRJ1-S-4",
"status": "not_started",
"effort": 40,
"value": 30,
"presented": true,
"color": "#bada55",
"start_date": null,
"end_date": null,
"position": 2,
"score": 0,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"progress": null,
"progress_source": "progress_manual",
"duration_source": "duration_manual",
"url": "https://company.aha.io/initiatives/PRJ1-S-4",
"resource": "https://company.aha.io/api/v1/initiatives/PRJ1-S-4",
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
},
"workflow_status": {
"id": "53968949",
"name": "Not Started",
"position": 1,
"complete": false,
"color": "#dce7c6",
"workflow_status_category": null
},
"description": {
"id": "999437064",
"body": "Description of project1_initiative4_active_epoch",
"notable_id": "330016191",
"notable_type": "Initiative",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"attachments": [],
"assigned_to_user": {
"default_assignee": true,
"id": "689956296",
"name": "Henry Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"time_frame": {
"id": 273422810,
"name": "2017"
},
"comments_count": 0,
"goals": [],
"key_results": [],
"score_facts": [],
"integration_fields": []
},
{
"id": "423077122",
"name": "Initiative 1",
"reference_num": "PRJ1-S-1",
"status": "not_started",
"effort": 30,
"value": 50,
"presented": true,
"color": "#bada55",
"start_date": null,
"end_date": null,
"position": 1,
"score": 4,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"progress": null,
"progress_source": "progress_manual",
"duration_source": "duration_manual",
"url": "https://company.aha.io/initiatives/PRJ1-S-1",
"resource": "https://company.aha.io/api/v1/initiatives/PRJ1-S-1",
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
},
"workflow_status": {
"id": "53968949",
"name": "Not Started",
"position": 1,
"complete": false,
"color": "#dce7c6",
"workflow_status_category": null
},
"description": {
"id": "673273729",
"body": "Description of initiative 1",
"notable_id": "423077122",
"notable_type": "Initiative",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"attachments": [],
"assigned_to_user": {
"default_assignee": false,
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"comments_count": 1,
"goals": [
{
"id": "602095703",
"name": "Goal 1",
"url": "https://company.aha.io/strategic_imperatives/DEMOENT-G-1",
"resource": "https://company.aha.io/api/v1/goals/DEMOENT-G-1",
"created_at": "2019-01-01T00:00:00.000Z",
"description": {
"id": "166463080",
"body": "Description of goal 1",
"notable_id": "602095703",
"notable_type": "StrategicImperative",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
}
}
],
"key_results": [],
"score_facts": [],
"features": [
{
"id": "1007868956",
"name": "Feature 1",
"reference_num": "PRJ1-1",
"created_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"url": "https://company.aha.io/features/PRJ1-1",
"resource": "https://company.aha.io/api/v1/features/PRJ1-1"
}
],
"master_features": [
{
"id": "269219656",
"name": "A different project epic",
"reference_num": "PRJ3-E-3",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/epics/PRJ3-E-3",
"resource": "https://company.aha.io/api/v1/epics/PRJ3-E-3"
},
{
"id": "362457003",
"name": "And a third",
"reference_num": "PRJ1-E-3",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/epics/PRJ1-E-3",
"resource": "https://company.aha.io/api/v1/epics/PRJ1-E-3"
},
{
"id": "580753216",
"name": "Here's another epic",
"reference_num": "PRJ1-E-2",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/epics/PRJ1-E-2",
"resource": "https://company.aha.io/api/v1/epics/PRJ1-E-2"
},
{
"id": "999605892",
"name": "Epic 1",
"reference_num": "PRJ1-E-1",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/epics/PRJ1-E-1",
"resource": "https://company.aha.io/api/v1/epics/PRJ1-E-1"
}
],
"epic": [
{
"id": "269219656",
"name": "A different project epic",
"reference_num": "PRJ3-E-3",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/epics/PRJ3-E-3",
"resource": "https://company.aha.io/api/v1/epics/PRJ3-E-3"
},
{
"id": "362457003",
"name": "And a third",
"reference_num": "PRJ1-E-3",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/epics/PRJ1-E-3",
"resource": "https://company.aha.io/api/v1/epics/PRJ1-E-3"
},
{
"id": "580753216",
"name": "Here's another epic",
"reference_num": "PRJ1-E-2",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/epics/PRJ1-E-2",
"resource": "https://company.aha.io/api/v1/epics/PRJ1-E-2"
},
{
"id": "999605892",
"name": "Epic 1",
"reference_num": "PRJ1-E-1",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/epics/PRJ1-E-1",
"resource": "https://company.aha.io/api/v1/epics/PRJ1-E-1"
}
],
"releases": [
{
"id": "161456549",
"product_id": "131414752",
"reference_num": "PRJ1-R-2",
"name": "Release 2",
"start_date": "2019-01-01",
"release_date": "2019-01-01",
"parking_lot": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/releases/PRJ1-R-2",
"resource": "https://company.aha.io/api/v1/releases/PRJ1-R-2",
"integration_fields": [],
"owner": {
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
}
},
{
"id": "278327321",
"product_id": "131414752",
"reference_num": "PRJ1-R-1",
"name": "Release 1",
"start_date": "2019-01-01",
"release_date": "2019-01-01",
"parking_lot": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/releases/PRJ1-R-1",
"resource": "https://company.aha.io/api/v1/releases/PRJ1-R-1",
"integration_fields": [
{
"id": "68217473",
"name": "id",
"value": "777",
"integration_id": 204584239,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"owner": {
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
}
}
],
"integration_fields": [
{
"id": "546711007",
"name": "id",
"value": "9913333",
"integration_id": 186281709,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "966751335",
"name": "key",
"value": "JRA-987222",
"integration_id": 186281709,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"id": 973371762,
"key": "initiative_custom_date",
"name": "Initiative custom date",
"updatedAt": "2019-01-01T00:00:00Z",
"type": "date",
"value": "2019-01-01"
},
{
"id": 1073063442,
"key": "initiative_priority",
"name": "Initiative priority",
"updatedAt": "2019-01-01T00:00:00Z",
"type": "string",
"value": "P2"
}
],
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
}
},
{
"id": "595848429",
"name": "Initiative complete",
"reference_num": "PRJ1-S-11",
"status": "done",
"effort": 10,
"value": 70,
"presented": true,
"color": "#bada55",
"start_date": null,
"end_date": null,
"position": 1,
"score": 0,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"progress": null,
"progress_source": "progress_manual",
"duration_source": "duration_manual",
"url": "https://company.aha.io/initiatives/PRJ1-S-11",
"resource": "https://company.aha.io/api/v1/initiatives/PRJ1-S-11",
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
},
"workflow_status": {
"id": "509459046",
"name": "Done",
"position": 3,
"complete": true,
"color": "#ecdd8f",
"workflow_status_category": {
"id": "935706688",
"name": "Done"
}
},
"description": null,
"attachments": [],
"assigned_to_user": {
"default_assignee": true,
"id": "689956296",
"name": "Henry Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"comments_count": 0,
"goals": [],
"key_results": [],
"score_facts": [],
"integration_fields": []
}
],
"pagination": {
"total_records": 6,
"total_pages": 1,
"current_page": 1
}
}Changes
- breaking
the response property
///became nullable for the status - breaking
the
///response's property type changed fromobjecttonullfor status - warning
removed the optional property
////from the response with the status - warning
removed the optional property
////from the response with the status
- breaking
- info
added the optional property
///to the response with the status
- info