Aha.io Requirements API
The Requirements API from Aha.io — 3 operation(s) for requirements.
OpenAPI Specification
openapi: 3.1.0
info:
title: Aha! Account backups Requirements 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: Requirements
paths:
/api/v1/requirements/{id}:
get:
summary: Get a specific requirement
description: null
tags:
- Requirements
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/RequirementsGetResponse'
example:
requirement:
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
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
delete:
summary: Delete a requirement
description: null
tags:
- Requirements
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/features/{feature_id}/requirements:
get:
summary: List requirements for a feature
description: null
tags:
- Requirements
parameters:
- name: feature_id
in: path
required: true
schema:
type: string
description: FeatureId identifier
- name: updated_since
in: query
required: false
schema:
type: string
example: '2019-01-01T00:00:00Z'
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/RequirementsGetResponse'
example:
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: '6776881149488866340'
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: '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: '6776881149498326874'
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
pagination:
total_records: 2
total_pages: 1
current_page: 1
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
post:
summary: Create a requirement
description: null
tags:
- Requirements
parameters:
- name: feature_id
in: path
required: true
schema:
type: string
description: FeatureId 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/RequirementsPostResponse'
example:
requirement:
id: '6776881149495309190'
name: New name
reference_num: PRJ1-1-4
position: 4
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: '962984386'
name: Designed
position: 2
complete: false
color: '#ecdd8f'
url: http://company.aha.io/requirements/PRJ1-1-4
resource: http://company.aha.io/api/v1/requirements/PRJ1-1-4
description:
id: '6776881149498089069'
body: <p>This is the description</p>
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: '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: false
attachments: []
tags: []
full_tags: []
custom_fields: []
integration_fields: []
comments_count: 0
workflow_status_times:
- status_id: '962984386'
status_name: Designed
started_at: '2019-01-01T00:00:00.000Z'
ended_at: null
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequirementsPostRequest'
example:
requirement:
name: New name
workflow_status:
name: Designed
description: <p>This is the description</p>
assigned_to_user:
email: no-reply@aha.io
/api/v1/requirements/{id}/convert_to_feature:
post:
summary: Convert a requirement to a feature
description: null
tags:
- Requirements
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/RequirementsPostResponse'
example:
feature:
id: '6776881149487717549'
name: Body of requirement 1
reference_num: PRJ1-251
initiative_reference_num: null
release_reference_num: PRJ1-R-1
epic_reference_num: null
position: 1
score: 2
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: '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: '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: []
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: '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: []
goals: []
comments_count: 1
score_facts: []
tags: []
full_tags: []
custom_fields:
- id: '6776881149495350529'
key: expected_completion_date
name: Expected completion date
updatedAt: '2019-01-01T00:00:00Z'
value: '2019-01-01'
type: date
feature_links:
- link_type: Relates to
link_type_id: 10
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: '6776881149487717549'
reference_num: PRJ1-251
name: Body of requirement 1
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/features/PRJ1-251
resource: http://company.aha.io/api/v1/features/PRJ1-251
product_id: '131414752'
workflow_status_times:
- status_id: '934242751'
status_name: New
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: []
components:
schemas:
RequirementsPostResponse:
type: object
properties:
feature:
type: object
properties:
id:
type: string
example: '6776881149487717549'
name:
type: string
example: Body of requirement 1
reference_num:
type: string
example: PRJ1-251
initiative_reference_num:
type: 'null'
release_reference_num:
type: string
example: PRJ1-R-1
epic_reference_num:
type: 'null'
position:
type: integer
example: 1
score:
type: integer
example: 2
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
start_date:
type: 'null'
due_date:
type: 'null'
product_id:
type: string
example: '131414752'
progress:
type: integer
example: 0
progress_source:
type: string
example: progress_manual
status_changed_on:
type: string
example: '2019-01-01'
created_by_user:
type: object
properties:
id:
type: string
example: '1020675218'
name:
type: string
example: Mary Humpty
email:
type: string
example: no-reply@aha.io
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
example:
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:
type: object
properties:
id:
type: string
example: '98484309'
name:
type: string
example: New
example:
id: '98484309'
name: New
workflow_status:
type: object
properties:
id:
type: string
example: '934242751'
name:
type: string
example: New
position:
type: integer
example: 1
complete:
type: boolean
example: false
color:
type: string
example: '#dce7c6'
example:
id: '934242751'
name: New
position: 1
complete: false
color: '#dce7c6'
project:
type: object
properties:
id:
type: string
example: '131414752'
reference_prefix:
type: string
example: PRJ1
name:
type: string
example: Project 1
product_line:
type: boolean
example: false
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
workspace_type:
type: string
example: product_workspace
url:
type: string
example: http://company.aha.io/projects/PRJ1
example:
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:
type: object
properties:
id:
type: string
example: '910541534'
body:
type: string
example: Body of requirement 1
editor_version:
type: integer
example: 1
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
attachments:
type: array
items: {}
example:
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: []
attachments:
type: array
items: {}
integration_fields:
type: array
items: {}
url:
type: string
example: http://company.aha.io/features/PRJ1-251
resource:
type: string
example: http://company.aha.io/api/v1/features/PRJ1-251
release:
type: object
properties:
id:
type: string
example: '278327321'
reference_num:
type: string
example: PRJ1-R-1
name:
type: string
example: Release 1
start_date:
type: string
example: '2019-01-01'
release_date:
type: string
example: '2019-01-01'
parking_lot:
type: boolean
example: false
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
product_id:
type: string
example: '131414752'
integration_fields:
type: array
items:
type: string
example:
- id: '68217473'
name: id
value: '777'
integration_id: 204584239
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
url:
type: string
example: http://company.aha.io/releases/PRJ1-R-1
resource:
type: string
example: http://company.aha.io/api/v1/releases/PRJ1-R-1
owner:
type: object
properties:
id:
type: string
name:
type: string
email:
type: string
created_at:
type: string
updated_at:
type: string
example:
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:
type: object
properties:
id:
type: string
reference_prefix:
type: string
name:
type: string
product_line:
type: string
created_at:
type: string
workspace_type:
type: string
url:
type: string
example:
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
example:
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:
type: object
properties:
id:
type: string
example: '16338845'
name:
type: string
example: John Smith
email:
type: string
example: no-reply@aha.io
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
default_assignee:
type: boolean
example: false
example:
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:
type: array
items: {}
goals:
type: array
items: {}
comments_count:
type: integer
example: 1
score_facts:
type: array
items: {}
tags:
type: array
items: {}
full_tags:
type: array
items: {}
custom_fields:
type: array
items:
type: object
properties:
id:
type: string
key:
type: string
name:
type: string
updatedAt:
type: string
value:
type: string
type:
type: string
example:
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aha/refs/heads/main/openapi/aha-requirements-api-openapi.yml