openapi: 3.1.0 info: title: Aha! Account backups Releases 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: Releases paths: /api/v1/releases/{id}: get: summary: Get a specific release description: null tags: - Releases 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/ReleasesGetResponse' example: release: id: '278327321' product_id: '131414752' reference_num: PRJ1-R-1 name: Release 1 start_date: '2019-01-01' end_date: null development_started_on: '2019-01-01' release_date: '2019-01-01' external_release_date: '2019-01-01' external_release_date_description: Sep 11, 2025 external_date_resolution: exact released: false parking_lot: false master_release: false released_on: '2019-01-01' created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' position: null progress: null progress_source: progress_manual duration_source: duration_manual status_changed_on: null theme: id: '522610666' body: Theme of the release editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/releases/PRJ1-R-1 resource: http://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' custom_fields: - id: '432637490' key: note name: Note updatedAt: '2019-01-01T00:00:00Z' body:

sample text

editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:

sample text

type: note - id: 424324947 key: text_field name: TextField updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string comments_count: 1 workflow_status: id: '738862546' name: New position: 1 complete: false color: '#dce7c6' 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' 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: [] initiatives: - 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' 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 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' security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] /api/v1/products/{product_id}/releases: post: summary: Create a release description: null tags: - Releases parameters: - name: product_id in: path required: true schema: type: string description: ProductId 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/ReleasesPostResponse' example: release: id: '6776881149495764123' product_id: '131414752' reference_num: PRJ1-R-5 name: Release 3 start_date: null end_date: null development_started_on: null release_date: '2019-01-01' external_release_date: '2019-01-01' external_release_date_description: Oct 4, 2025 external_date_resolution: sync released: false parking_lot: false master_release: false released_on: null created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' position: 1 progress: 0 progress_source: progress_from_features_completed duration_source: duration_manual status_changed_on: '2019-01-01' theme: id: '6776881149493840411' body: '' editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/releases/PRJ1-R-5 resource: http://company.aha.io/api/v1/releases/PRJ1-R-5 integration_fields: [] custom_fields: [] comments_count: 0 workflow_status: id: '738862546' name: New position: 1 complete: false color: '#dce7c6' owner: 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' goals: [] key_results: [] initiatives: - id: '4125886' reference_num: PRJ1-S-2 name: Initiative 2 url: http://company.aha.io/initiatives/PRJ1-S-2 resource: http://company.aha.io/api/v1/initiatives/PRJ1-S-2 created_at: '2019-01-01T00:00:00.000Z' description: id: '824706757' body: Description of initiative 2 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] integration_fields: [] - 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' 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 workflow_status_times: - status_id: '738862546' status_name: New started_at: '2019-01-01T00:00:00.000Z' ended_at: null 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' security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReleasesPostRequest' example: release: owner: no-reply@aha.io initiatives: Initiative 1 name: Release 3 status: New theme: Our first big release external_date_resolution: month get: summary: List releases in a product description: null tags: - Releases parameters: - name: product_id in: path required: true schema: type: string description: ProductId 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/ReleasesGetResponse' example: releases: - id: '141021264' reference_num: PRJ1-MR-2 name: Roll-up Release 2 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: [] url: http://company.aha.io/master_releases/PRJ1-MR-2 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-2 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 - id: '161456549' 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' product_id: '131414752' integration_fields: [] url: http://company.aha.io/releases/PRJ1-R-2 resource: http://company.aha.io/api/v1/releases/PRJ1-R-2 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 - 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 - id: '292454904' reference_num: PRJ1-MR-1 name: Roll-up 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: [] url: http://company.aha.io/master_releases/PRJ1-MR-1 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-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 - id: '325518644' reference_num: PRJ1-R-4 name: Sub 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: [] url: http://company.aha.io/releases/PRJ1-R-4 resource: http://company.aha.io/api/v1/releases/PRJ1-R-4 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 parent: id: '141021264' reference_num: PRJ1-MR-2 name: Roll-up Release 2 start_date: '2019-01-01' release_date: '2019-01-01' created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/master_releases/PRJ1-MR-2 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-2 - id: '1050186040' reference_num: PRJ1-R-3 name: Release 3 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: '453734818' name: id value: '4221' integration_id: 342659513 service_name: jira created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/releases/PRJ1-R-3 resource: http://company.aha.io/api/v1/releases/PRJ1-R-3 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 pagination: total_records: 6 total_pages: 1 current_page: 1 security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] /api/v1/goals/{goal_id}/releases: get: summary: List releases associated with a goal description: null tags: - Releases parameters: - name: goal_id in: path required: true schema: type: string description: GoalId 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/ReleasesGetResponse' example: releases: - 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 pagination: total_records: 1 total_pages: 1 current_page: 1 security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] /api/v1/initiatives/{initiative_id}/releases: get: summary: List releases associated with an initiative description: null tags: - Releases parameters: - name: initiative_id in: path required: true schema: type: string description: InitiativeId 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/ReleasesGetResponse' example: releases: - id: '161456549' 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' product_id: '131414752' integration_fields: [] url: http://company.aha.io/releases/PRJ1-R-2 resource: http://company.aha.io/api/v1/releases/PRJ1-R-2 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 - 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 pagination: total_records: 2 total_pages: 1 current_page: 1 security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] /api/v1/releases/{release_id}/releases: get: summary: List releases under a roll-up release description: null tags: - Releases 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/ReleasesGetResponse' example: releases: - id: '325518644' reference_num: PRJ1-R-4 name: Sub 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: [] url: http://company.aha.io/releases/PRJ1-R-4 resource: http://company.aha.io/api/v1/releases/PRJ1-R-4 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 parent: id: '141021264' reference_num: PRJ1-MR-2 name: Roll-up Release 2 start_date: '2019-01-01' release_date: '2019-01-01' created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/master_releases/PRJ1-MR-2 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-2 pagination: total_records: 1 total_pages: 1 current_page: 1 security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] /api/v1/roll_up_releases/{release_id}/releases: get: summary: List releases under a roll-up release description: null tags: - Releases 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/ReleasesGetResponse' example: releases: - id: '85510963' reference_num: PRJ4-R-4 name: Parking lot for Project 4 parking_lot: true created_at: '2019-01-01T00:00:00.000Z' product_id: '935317104' integration_fields: [] url: http://company.aha.io/releases/PRJ4-R-4 resource: http://company.aha.io/api/v1/releases/PRJ4-R-4 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: '935317104' reference_prefix: PRJ4 name: Project 4 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ4 - id: '141021264' reference_num: PRJ1-MR-2 name: Roll-up Release 2 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: [] url: http://company.aha.io/master_releases/PRJ1-MR-2 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-2 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 - id: '161456549' 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' product_id: '131414752' integration_fields: [] url: http://company.aha.io/releases/PRJ1-R-2 resource: http://company.aha.io/api/v1/releases/PRJ1-R-2 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 - 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 - id: '292454904' reference_num: PRJ1-MR-1 name: Roll-up 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: [] url: http://company.aha.io/master_releases/PRJ1-MR-1 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-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 - id: '325518644' reference_num: PRJ1-R-4 name: Sub 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: [] url: http://company.aha.io/releases/PRJ1-R-4 resource: http://company.aha.io/api/v1/releases/PRJ1-R-4 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 parent: id: '141021264' reference_num: PRJ1-MR-2 name: Roll-up Release 2 start_date: '2019-01-01' release_date: '2019-01-01' created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/master_releases/PRJ1-MR-2 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-2 - id: '342040612' reference_num: PRJ3-R-1 name: Release 3 Project 3 start_date: '2019-01-01' release_date: '2019-01-01' parking_lot: false created_at: '2019-01-01T00:00:00.000Z' product_id: '702241743' integration_fields: [] url: http://company.aha.io/releases/PRJ3-R-1 resource: http://company.aha.io/api/v1/releases/PRJ3-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: '702241743' reference_prefix: PRJ3 name: Project 3 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ3 - id: '414276209' reference_num: PRJ4-R-3 name: Release month old (shipped) start_date: '2019-01-01' release_date: '2019-01-01' parking_lot: false created_at: '2019-01-01T00:00:00.000Z' product_id: '935317104' integration_fields: [] url: http://company.aha.io/releases/PRJ4-R-3 resource: http://company.aha.io/api/v1/releases/PRJ4-R-3 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: '935317104' reference_prefix: PRJ4 name: Project 4 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ4 - id: '637342960' reference_num: PRJ2-R-2 name: Parking lot for Project 2 parking_lot: true created_at: '2019-01-01T00:00:00.000Z' product_id: '517761884' integration_fields: [] url: http://company.aha.io/releases/PRJ2-R-2 resource: http://company.aha.io/api/v1/releases/PRJ2-R-2 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: '517761884' reference_prefix: PRJ2 name: Project 2 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ2 - id: '800484072' reference_num: PRJ4-R-2 name: Release week old (shipped) start_date: '2019-01-01' release_date: '2019-01-01' parking_lot: false created_at: '2019-01-01T00:00:00.000Z' product_id: '935317104' integration_fields: [] url: http://company.aha.io/releases/PRJ4-R-2 resource: http://company.aha.io/api/v1/releases/PRJ4-R-2 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: '935317104' reference_prefix: PRJ4 name: Project 4 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ4 - id: '918502240' reference_num: PRJ4-R-1 name: Release 4 start_date: '2019-01-01' release_date: '2019-01-01' parking_lot: false created_at: '2019-01-01T00:00:00.000Z' product_id: '935317104' integration_fields: [] url: http://company.aha.io/releases/PRJ4-R-1 resource: http://company.aha.io/api/v1/releases/PRJ4-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: '935317104' reference_prefix: PRJ4 name: Project 4 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ4 - id: '946589036' reference_num: PRJe-R-4 name: Parking lot parking_lot: true created_at: '2019-01-01T00:00:00.000Z' product_id: '702241743' integration_fields: [] url: http://company.aha.io/releases/PRJe-R-4 resource: http://company.aha.io/api/v1/releases/PRJe-R-4 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: '702241743' reference_prefix: PRJ3 name: Project 3 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ3 - id: '1000426269' reference_num: PRJ2-R-1 name: Release 2 start_date: '2019-01-01' release_date: '2019-01-01' parking_lot: false created_at: '2019-01-01T00:00:00.000Z' product_id: '517761884' integration_fields: [] url: http://company.aha.io/releases/PRJ2-R-1 resource: http://company.aha.io/api/v1/releases/PRJ2-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: '517761884' reference_prefix: PRJ2 name: Project 2 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ2 - id: '1050186040' reference_num: PRJ1-R-3 name: Release 3 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: '453734818' name: id value: '4221' integration_id: 342659513 service_name: jira created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/releases/PRJ1-R-3 resource: http://company.aha.io/api/v1/releases/PRJ1-R-3 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 pagination: total_records: 14 total_pages: 1 current_page: 1 security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] /api/v1/releases/{id}/duplicate: post: summary: Duplicate a release description: null tags: - Releases 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/ReleasesPostResponse' example: release: id: '6776881149492110971' name: '[Copy] Release 1' security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] /api/v1/products/{product_id}/releases/{id}: put: summary: Update a release description: null tags: - Releases parameters: - name: product_id in: path required: true schema: type: string description: ProductId identifier - 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/ReleasesPutResponse' example: release: id: '278327321' product_id: '131414752' reference_num: PRJ1-R-1 name: Release 1 start_date: '2019-01-01' end_date: null development_started_on: '2019-01-01' release_date: '2019-01-01' external_release_date: '2019-01-01' external_release_date_description: Sep 11, 2025 external_date_resolution: exact released: false parking_lot: false master_release: false released_on: null created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' position: null progress: null progress_source: progress_manual duration_source: duration_manual status_changed_on: null theme: id: '522610666' body: Theme of the release editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/releases/PRJ1-R-1 resource: http://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' custom_fields: - id: '432637490' key: note name: Note updatedAt: '2019-01-01T00:00:00Z' body:

sample text

editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:

sample text

type: note - id: 424324947 key: text_field name: TextField updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string comments_count: 1 workflow_status: id: '738862546' name: New position: 1 complete: false color: '#dce7c6' 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' 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: [] 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 parent: id: '292454904' reference_num: PRJ1-MR-1 name: Roll-up Release 1 start_date: '2019-01-01' release_date: '2019-01-01' created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/master_releases/PRJ1-MR-1 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-1 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' security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReleasesPostRequest' example: release: initiatives: [] name: Smarter release delete: summary: Delete a release description: null tags: - Releases parameters: - name: product_id in: path required: true schema: type: string description: ProductId identifier - name: id in: path required: true schema: type: string description: Id identifier responses: '204': description: No content - operation successful security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] components: schemas: ReleasesPostRequest: type: object properties: release: type: object properties: initiatives: type: array items: {} name: type: string example: Smarter release example: initiatives: [] name: Smarter release example: release: initiatives: [] name: Smarter release ReleasesGetResponse: type: object properties: release: type: object properties: id: type: string example: '278327321' product_id: type: string example: '131414752' reference_num: type: string example: PRJ1-R-1 name: type: string example: Release 1 start_date: type: string example: '2019-01-01' end_date: type: 'null' development_started_on: type: string example: '2019-01-01' release_date: type: string example: '2019-01-01' external_release_date: type: string example: '2019-01-01' external_release_date_description: type: string example: Sep 11, 2025 external_date_resolution: type: string example: exact released: type: boolean example: false parking_lot: type: boolean example: false master_release: type: boolean example: false released_on: type: string example: '2019-01-01' created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' position: type: 'null' progress: type: 'null' progress_source: type: string example: progress_manual duration_source: type: string example: duration_manual status_changed_on: type: 'null' theme: type: object properties: id: type: string example: '522610666' body: type: string example: Theme of the release 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: '522610666' body: Theme of the release editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] 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 integration_fields: type: array items: type: object properties: id: type: string name: type: string value: type: string integration_id: type: string service_name: type: string created_at: type: string example: id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' example: - id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' custom_fields: type: array items: type: object properties: id: type: string key: type: string name: type: string updatedAt: type: string body: type: string editor_version: type: string created_at: type: string updated_at: type: string attachments: type: string value: type: string type: type: string example: id: '432637490' key: note name: Note updatedAt: '2019-01-01T00:00:00Z' body:

sample text

editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:

sample text

type: note example: - id: '432637490' key: note name: Note updatedAt: '2019-01-01T00:00:00Z' body:

sample text

editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:

sample text

type: note - id: 424324947 key: text_field name: TextField updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string comments_count: type: integer example: 1 workflow_status: type: object properties: id: type: string example: '738862546' name: type: string example: New position: type: integer example: 1 complete: type: boolean example: false color: type: string example: '#dce7c6' example: id: '738862546' name: New position: 1 complete: false color: '#dce7c6' owner: 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' 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' goals: type: array items: type: object properties: id: type: string name: type: string url: type: string resource: type: string created_at: type: string description: type: string example: 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: [] example: - 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: type: array items: {} initiatives: type: array items: type: object properties: id: type: string reference_num: type: string name: type: string url: type: string resource: type: string created_at: type: string description: type: string integration_fields: type: string example: 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' example: - 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' 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 created_by_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' 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' example: id: '278327321' product_id: '131414752' reference_num: PRJ1-R-1 name: Release 1 start_date: '2019-01-01' end_date: null development_started_on: '2019-01-01' release_date: '2019-01-01' external_release_date: '2019-01-01' external_release_date_description: Sep 11, 2025 external_date_resolution: exact released: false parking_lot: false master_release: false released_on: '2019-01-01' created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' position: null progress: null progress_source: progress_manual duration_source: duration_manual status_changed_on: null theme: id: '522610666' body: Theme of the release editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/releases/PRJ1-R-1 resource: http://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' custom_fields: - id: '432637490' key: note name: Note updatedAt: '2019-01-01T00:00:00Z' body:

sample text

editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:

sample text

type: note - id: 424324947 key: text_field name: TextField updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string comments_count: 1 workflow_status: id: '738862546' name: New position: 1 complete: false color: '#dce7c6' 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' 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: [] initiatives: - 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' 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 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' example: release: id: '278327321' product_id: '131414752' reference_num: PRJ1-R-1 name: Release 1 start_date: '2019-01-01' end_date: null development_started_on: '2019-01-01' release_date: '2019-01-01' external_release_date: '2019-01-01' external_release_date_description: Sep 11, 2025 external_date_resolution: exact released: false parking_lot: false master_release: false released_on: '2019-01-01' created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' position: null progress: null progress_source: progress_manual duration_source: duration_manual status_changed_on: null theme: id: '522610666' body: Theme of the release editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/releases/PRJ1-R-1 resource: http://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' custom_fields: - id: '432637490' key: note name: Note updatedAt: '2019-01-01T00:00:00Z' body:

sample text

editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:

sample text

type: note - id: 424324947 key: text_field name: TextField updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string comments_count: 1 workflow_status: id: '738862546' name: New position: 1 complete: false color: '#dce7c6' 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' 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: [] initiatives: - 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' 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 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' ReleasesPostResponse: type: object properties: release: type: object properties: id: type: string example: '6776881149492110971' name: type: string example: '[Copy] Release 1' example: id: '6776881149492110971' name: '[Copy] Release 1' example: release: id: '6776881149492110971' name: '[Copy] Release 1' ReleasesPutResponse: type: object properties: release: type: object properties: id: type: string example: '278327321' product_id: type: string example: '131414752' reference_num: type: string example: PRJ1-R-1 name: type: string example: Release 1 start_date: type: string example: '2019-01-01' end_date: type: 'null' development_started_on: type: string example: '2019-01-01' release_date: type: string example: '2019-01-01' external_release_date: type: string example: '2019-01-01' external_release_date_description: type: string example: Sep 11, 2025 external_date_resolution: type: string example: exact released: type: boolean example: false parking_lot: type: boolean example: false master_release: type: boolean example: false released_on: type: 'null' created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' position: type: 'null' progress: type: 'null' progress_source: type: string example: progress_manual duration_source: type: string example: duration_manual status_changed_on: type: 'null' theme: type: object properties: id: type: string example: '522610666' body: type: string example: Theme of the release 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: '522610666' body: Theme of the release editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] 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 integration_fields: type: array items: type: object properties: id: type: string name: type: string value: type: string integration_id: type: string service_name: type: string created_at: type: string example: id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' example: - id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' custom_fields: type: array items: type: object properties: id: type: string key: type: string name: type: string updatedAt: type: string body: type: string editor_version: type: string created_at: type: string updated_at: type: string attachments: type: string value: type: string type: type: string example: id: '432637490' key: note name: Note updatedAt: '2019-01-01T00:00:00Z' body:

sample text

editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:

sample text

type: note example: - id: '432637490' key: note name: Note updatedAt: '2019-01-01T00:00:00Z' body:

sample text

editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:

sample text

type: note - id: 424324947 key: text_field name: TextField updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string comments_count: type: integer example: 1 workflow_status: type: object properties: id: type: string example: '738862546' name: type: string example: New position: type: integer example: 1 complete: type: boolean example: false color: type: string example: '#dce7c6' example: id: '738862546' name: New position: 1 complete: false color: '#dce7c6' owner: 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' 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' goals: type: array items: type: object properties: id: type: string name: type: string url: type: string resource: type: string created_at: type: string description: type: string example: 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: [] example: - 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: type: array items: {} 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 parent: type: object properties: id: type: string example: '292454904' reference_num: type: string example: PRJ1-MR-1 name: type: string example: Roll-up Release 1 start_date: type: string example: '2019-01-01' release_date: type: string example: '2019-01-01' created_at: type: string example: '2019-01-01T00:00:00.000Z' url: type: string example: http://company.aha.io/master_releases/PRJ1-MR-1 resource: type: string example: http://company.aha.io/api/v1/releases/PRJ1-MR-1 example: id: '292454904' reference_num: PRJ1-MR-1 name: Roll-up Release 1 start_date: '2019-01-01' release_date: '2019-01-01' created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/master_releases/PRJ1-MR-1 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-1 created_by_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' 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' example: id: '278327321' product_id: '131414752' reference_num: PRJ1-R-1 name: Release 1 start_date: '2019-01-01' end_date: null development_started_on: '2019-01-01' release_date: '2019-01-01' external_release_date: '2019-01-01' external_release_date_description: Sep 11, 2025 external_date_resolution: exact released: false parking_lot: false master_release: false released_on: null created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' position: null progress: null progress_source: progress_manual duration_source: duration_manual status_changed_on: null theme: id: '522610666' body: Theme of the release editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/releases/PRJ1-R-1 resource: http://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' custom_fields: - id: '432637490' key: note name: Note updatedAt: '2019-01-01T00:00:00Z' body:

sample text

editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:

sample text

type: note - id: 424324947 key: text_field name: TextField updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string comments_count: 1 workflow_status: id: '738862546' name: New position: 1 complete: false color: '#dce7c6' 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' 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: [] 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 parent: id: '292454904' reference_num: PRJ1-MR-1 name: Roll-up Release 1 start_date: '2019-01-01' release_date: '2019-01-01' created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/master_releases/PRJ1-MR-1 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-1 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' example: release: id: '278327321' product_id: '131414752' reference_num: PRJ1-R-1 name: Release 1 start_date: '2019-01-01' end_date: null development_started_on: '2019-01-01' release_date: '2019-01-01' external_release_date: '2019-01-01' external_release_date_description: Sep 11, 2025 external_date_resolution: exact released: false parking_lot: false master_release: false released_on: null created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' position: null progress: null progress_source: progress_manual duration_source: duration_manual status_changed_on: null theme: id: '522610666' body: Theme of the release editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/releases/PRJ1-R-1 resource: http://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' custom_fields: - id: '432637490' key: note name: Note updatedAt: '2019-01-01T00:00:00Z' body:

sample text

editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:

sample text

type: note - id: 424324947 key: text_field name: TextField updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string comments_count: 1 workflow_status: id: '738862546' name: New position: 1 complete: false color: '#dce7c6' 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' 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: [] 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 parent: id: '292454904' reference_num: PRJ1-MR-1 name: Roll-up Release 1 start_date: '2019-01-01' release_date: '2019-01-01' created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/master_releases/PRJ1-MR-1 resource: http://company.aha.io/api/v1/releases/PRJ1-MR-1 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' securitySchemes: OAuth2: type: oauth2 description: OAuth2 authentication with bearer tokens flows: authorizationCode: authorizationUrl: https://{account-domain}.aha.io/oauth/authorize tokenUrl: https://{account-domain}.aha.io/oauth/token scopes: {} ApiKeyAuth: type: http scheme: bearer description: API key authentication using Bearer token in Authorization header. Generate API keys at https://secure.aha.io/settings/api_keys CookieAuth: type: apiKey in: cookie name: session description: Cookie-based authentication for web browser integration