Aha.io Features API
The Features API from Aha.io — 8 operation(s) for features.
OpenAPI Specification
openapi: 3.1.0
info:
title: Aha! Account backups Features API
version: 1.0.0
description: Complete API documentation for Aha! generated from actual test responses
contact:
name: Aha! Support
url: https://www.aha.io/support
servers:
- url: https://{account-domain}.aha.io/api/v1
description: Aha! API Server
variables:
account-domain:
description: Your Aha! account domain
default: company
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
tags:
- name: Features
paths:
/api/v1/features/{id}:
get:
summary: Get a specific feature
description: 'Features belong to releases.
This means that if you want to
[create one](/api/resources/features/create_a_feature) then
you must scope it to a release.
You can return a result set which is unfiltered, or filter by
[release](/api/resources/features/list_features_in_a_release)
, [product](/api/resources/features/list_features_in_a_product)
, or [epic](/api/resources/features/list_features_in_an_epic).
All these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.
Once you have the id of a specific feature, you can
[inspect](/api/resources/features/get_a_specific_feature),
[modify](/api/resources/features/update_a_feature),
or
[delete](/api/resources/features/delete_a_feature)
them on the root features resource.'
tags:
- Features
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Id identifier
responses:
'200':
description: Successful operation
headers:
Content-Type:
description: application/json; charset=utf-8
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/FeaturesGetResponse'
example:
feature:
id: '1007868956'
name: Feature 1
reference_num: PRJ1-1
initiative_reference_num: PRJ1-S-1
release_reference_num: PRJ1-R-1
epic_reference_num: PRJ1-E-1
position: 1
score: 3
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
start_date: '2019-01-01'
due_date: '2019-01-01'
product_id: '131414752'
progress: null
progress_source: progress_manual
status_changed_on: null
created_by_user:
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'
workflow_kind:
id: '98484309'
name: New
workflow_status:
id: '934242751'
name: New
position: 1
complete: false
color: '#dce7c6'
project:
id: '131414752'
reference_prefix: PRJ1
name: Project 1
product_line: false
created_at: '2019-01-01T00:00:00.000Z'
workspace_type: product_workspace
url: http://company.aha.io/projects/PRJ1
description:
id: '793547626'
body: Body of note 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments:
- id: '630489833'
download_url: https://company.aha.io/attachments/630489833/token/aaabbbccc7.download?size=original
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
original_file_size: 123
content_type: application/excel
file_name: spreadsheet_file.xlsx
file_size: 123
- id: '724655692'
download_url: https://company.aha.io/attachments/724655692/token/aaabbbccc7.download?size=original
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
original_file_size: 123
content_type: text/plain
file_name: uploaded_file_name.txt
file_size: 123
attachments: []
integration_fields:
- id: '92040219'
name: url
value: https://bigaha.atlassian.net/issues/JRA-123
integration_id: 204584239
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
- id: '728894778'
name: key
value: JRA-123
integration_id: 204584239
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
- id: '846945422'
name: id
value: '435'
integration_id: 204584239
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/features/PRJ1-1
resource: http://company.aha.io/api/v1/features/PRJ1-1
release:
id: '278327321'
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'
product_id: '131414752'
integration_fields:
- id: '68217473'
name: id
value: '777'
integration_id: 204584239
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/releases/PRJ1-R-1
resource: http://company.aha.io/api/v1/releases/PRJ1-R-1
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'
workspace_type: product_workspace
url: http://company.aha.io/projects/PRJ1
master_feature:
id: '999605892'
reference_num: PRJ1-E-1
name: Epic 1
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/epics/PRJ1-E-1
resource: http://company.aha.io/api/v1/epics/PRJ1-E-1
belongs_to_release_phase:
id: '20526005'
name: Alpha
start_on: '2019-01-01'
end_on: '2019-01-01'
type: phase
release_id: 278327321
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
progress: null
progress_source: progress_manual
duration_source: duration_manual
description:
id: '243384959'
body: Description of release phase 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
epic:
id: '999605892'
reference_num: PRJ1-E-1
name: Epic 1
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/epics/PRJ1-E-1
resource: http://company.aha.io/api/v1/epics/PRJ1-E-1
assigned_to_user:
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'
default_assignee: false
requirements:
- id: '96915428'
name: Body of requirement 2
reference_num: PRJ1-1-2
position: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
release_id: 278327321
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'
workflow_status:
id: '1025247908'
name: Shipped
position: 5
complete: true
color: '#ecdd8f'
url: http://company.aha.io/requirements/PRJ1-1-2
resource: http://company.aha.io/api/v1/requirements/PRJ1-1-2
description:
id: '6776881149487303525'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
feature:
id: '1007868956'
reference_num: PRJ1-1
name: Feature 1
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/features/PRJ1-1
resource: http://company.aha.io/api/v1/features/PRJ1-1
product_id: '131414752'
assigned_to_user:
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'
default_assignee: false
attachments: []
tags: []
full_tags: []
custom_fields: []
integration_fields: []
comments_count: 0
- id: '483368544'
name: Body of requirement 1
reference_num: PRJ1-1-1
position: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
release_id: 278327321
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'
workflow_status:
id: '934242751'
name: New
position: 1
complete: false
color: '#dce7c6'
url: http://company.aha.io/requirements/PRJ1-1-1
resource: http://company.aha.io/api/v1/requirements/PRJ1-1-1
description:
id: '910541534'
body: Body of requirement 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
feature:
id: '1007868956'
reference_num: PRJ1-1
name: Feature 1
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/features/PRJ1-1
resource: http://company.aha.io/api/v1/features/PRJ1-1
product_id: '131414752'
assigned_to_user:
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'
default_assignee: false
attachments: []
tags: []
full_tags: []
custom_fields:
- id: 848810602
key: expected_completion_date
name: Expected completion date
updatedAt: '2019-01-01T00:00:00Z'
value: '2019-01-01'
type: date
- id: 731808726
key: requested_by
name: Requested By
updatedAt: '2019-01-01T00:00:00Z'
value: TK
type: string
integration_fields:
- id: '32487847'
name: key
value: JRA-987
integration_id: 342659513
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
- id: '417785887'
name: id
value: '991'
integration_id: 342659513
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
- id: '803330186'
name: aha::remote_entity
value: issue_10100
integration_id: 342659513
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
comments_count: 1
- id: '851574643'
name: Body of requirement 3
reference_num: PRJ1-1-3
position: 3
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
release_id: 278327321
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'
workflow_status:
id: '922838743'
name: Not started
position: 8
complete: false
color: '#dce790'
url: http://company.aha.io/requirements/PRJ1-1-3
resource: http://company.aha.io/api/v1/requirements/PRJ1-1-3
description:
id: '6776881149485217306'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
feature:
id: '1007868956'
reference_num: PRJ1-1
name: Feature 1
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/features/PRJ1-1
resource: http://company.aha.io/api/v1/features/PRJ1-1
product_id: '131414752'
assigned_to_user:
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'
default_assignee: false
attachments: []
tags: []
full_tags: []
custom_fields: []
integration_fields: []
comments_count: 0
initiative:
id: '423077122'
reference_num: PRJ1-S-1
name: Initiative 1
url: http://company.aha.io/initiatives/PRJ1-S-1
resource: http://company.aha.io/api/v1/initiatives/PRJ1-S-1
created_at: '2019-01-01T00:00:00.000Z'
description:
id: '673273729'
body: Description of initiative 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
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'
goals:
- id: '602095703'
name: Goal 1
url: http://company.aha.io/strategic_imperatives/DEMOENT-G-1
resource: http://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
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
key_results:
- id: '631791848'
name: KR 1
reference_num: DEMOENT-G-1-KR-1
url: http://company.aha.io/key_results/DEMOENT-G-1-KR-1
position: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
progress: null
target_metric: 100%
starting_metric: 5%
current_metric: 20%
comments_count: 1
score_facts:
- id: '728895917'
value: 1
name: Effort
- id: '846938137'
value: 2
name: Benefit
tags:
- Engineering
- Infrastructure
full_tags:
- id: 3412727
name: Engineering
color: '#e09052'
- id: 775582684
name: Infrastructure
color: '#7552e0'
custom_fields:
- id: 1051489895
key: equation_specs_field
name: Equation specs field
updatedAt: '2019-01-01T00:00:00Z'
value:
values:
'123':
value: 10
name: a
display_value: '10.0'
'456':
value: Foobar
name: b
display_value: Foobar
'789':
value: null
name: '789'
display_value: null
type: equation_sheet
- id: 621325984
key: expected_completion_date
name: Expected completion date
updatedAt: '2019-01-01T00:00:00Z'
value: '2019-01-01'
type: date
- id: 694694494
key: negative_scorecard
name: Negative custom scorecard
updatedAt: '2019-01-01T00:00:00Z'
value: 31
type: scorecard
score_facts:
- id: '462102328'
value: 6
name: Negative default value
- id: 736691743
key: upload
name: Upload
updatedAt: '2019-01-01T00:00:00Z'
attachments:
- id: '471688235'
download_url: https://company.aha.io/attachments/471688235/token/aaabbbccc7.download?size=original
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
original_file_size: 123
content_type: text/plain
file_name: uploaded_file_name.txt
file_size: 123
type: attachment
feature_links:
- link_type: Depends on
link_type_id: 20
created_at: '2019-01-01T00:00:00.000Z'
parent_record:
id: '1007868956'
reference_num: PRJ1-1
name: Feature 1
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/features/PRJ1-1
resource: http://company.aha.io/api/v1/features/PRJ1-1
product_id: '131414752'
child_record:
id: '622562724'
reference_num: PRJ1-2
name: Another Feature
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/features/PRJ1-2
resource: http://company.aha.io/api/v1/features/PRJ1-2
product_id: '131414752'
feature_only_original_estimate: null
feature_only_remaining_estimate: null
feature_only_work_done: null
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
delete:
summary: Delete a feature
description: 'Features belong to releases.
This means that if you want to
[create one](/api/resources/features/create_a_feature) then
you must scope it to a release.
You can return a result set which is unfiltered, or filter by
[release](/api/resources/features/list_features_in_a_release)
, [product](/api/resources/features/list_features_in_a_product)
, or [epic](/api/resources/features/list_features_in_an_epic).
All these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.
Once you have the id of a specific feature, you can
[inspect](/api/resources/features/get_a_specific_feature),
[modify](/api/resources/features/update_a_feature),
or
[delete](/api/resources/features/delete_a_feature)
them on the root features resource.'
tags:
- Features
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Id identifier
responses:
'204':
description: No content - operation successful
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
/api/v1/releases/{release_id}/features:
post:
summary: Create a feature
description: Creates a new feature in a release with full details including assignee and description
tags:
- Features
parameters:
- name: release_id
in: path
required: true
schema:
type: string
description: ReleaseId identifier
responses:
'200':
description: Successful operation
headers:
Content-Type:
description: application/json; charset=utf-8
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/FeaturesPostResponse'
example:
feature:
id: '6776881149496854993'
name: New feature
reference_num: PRJ1-251
initiative_reference_num: null
release_reference_num: PRJ1-R-1
epic_reference_num: null
position: 1
score: 13
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
start_date: null
due_date: null
product_id: '131414752'
progress: 0
progress_source: progress_manual
status_changed_on: '2019-01-01'
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'
workflow_kind:
id: '98484309'
name: New
workflow_status:
id: '962984386'
name: Designed
position: 2
complete: false
color: '#ecdd8f'
project:
id: '131414752'
reference_prefix: PRJ1
name: Project 1
product_line: false
created_at: '2019-01-01T00:00:00.000Z'
workspace_type: product_workspace
url: http://company.aha.io/projects/PRJ1
description:
id: '6776881149494125544'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
attachments: []
integration_fields: []
url: http://company.aha.io/features/PRJ1-251
resource: http://company.aha.io/api/v1/features/PRJ1-251
release:
id: '278327321'
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'
product_id: '131414752'
integration_fields:
- id: '68217473'
name: id
value: '777'
integration_id: 204584239
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/releases/PRJ1-R-1
resource: http://company.aha.io/api/v1/releases/PRJ1-R-1
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'
workspace_type: product_workspace
url: http://company.aha.io/projects/PRJ1
assigned_to_user:
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'
default_assignee: true
requirements: []
goals: []
key_results: []
comments_count: 0
score_facts:
- id: '6776881149484679393'
value: 3
name: Effort
- id: '6776881149490073185'
value: 10
name: Benefit
tags: []
full_tags: []
custom_fields: []
feature_links: []
workflow_status_times:
- status_id: '962984386'
status_name: Designed
started_at: '2019-01-01T00:00:00.000Z'
ended_at: null
feature_only_original_estimate: null
feature_only_remaining_estimate: null
feature_only_work_done: null
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FeaturesPostRequest'
example:
feature:
name: New name
workflow_kind: new
workflow_status:
name: Designed
description: <p>This is the description</p>
assigned_to_user:
email: no-reply@aha.io
get:
summary: List features in a release
description: 'Features belong to releases.
This means that if you want to
[create one](/api/resources/features/create_a_feature) then
you must scope it to a release.
You can return a result set which is unfiltered, or filter by
[release](/api/resources/features/list_features_in_a_release)
, [product](/api/resources/features/list_features_in_a_product)
, or [epic](/api/resources/features/list_features_in_an_epic).
All these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.
Once you have the id of a specific feature, you can
[inspect](/api/resources/features/get_a_specific_feature),
[modify](/api/resources/features/update_a_feature),
or
[delete](/api/resources/features/delete_a_feature)
them on the root features resource.'
tags:
- Features
parameters:
- name: release_id
in: path
required: true
schema:
type: string
description: ReleaseId identifier
responses:
'200':
description: Successful operation
headers:
Content-Type:
description: application/json; charset=utf-8
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/FeaturesGetResponse'
example:
features:
- id: '209201304'
# --- truncated at 32 KB (151 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aha/refs/heads/main/openapi/aha-features-api-openapi.yml