Aha!
Aha! helps product teams set strategy, prioritize ideas, plan roadmaps, and manage product development work.
Tools (112)
Add Product Idea Portals
Add idea portal links to a product without replacing existing links.
Inputs: product_id, idea_portal_ids
Convert Feature to Epic
Irreversibly convert an existing feature into an epic while preserving its data and relationships.
Inputs: feature_id
Convert Requirement to Feature
Irreversibly convert an existing requirement into a feature.
Inputs: requirement_id
Create Custom Field Option
Create an option for one custom-field definition.
Inputs: color, value, custom_field_definition_id
Create Epic
Create an epic in a release or in a workspace's default release.
Inputs: name, tags, goals, due_date, created_by, initiative, start_date, description, destination_id, duration_source, workflow_status, assigned_to_user, destination_type
Create Feature
Create a feature in a release with its documented planning fields.
Inputs: epic, name, tags, team, goals, release, due_date, progress, iteration, created_by, initiative, release_id, start_date, description, release_phase, workflow_kind, progress_source, workflow_status, assigned_to_user, initial_estimate, detailed_estimate, program_increment, remaining_estimate, team_workflow_status, initial_estimate_text, detailed_estimate_text, remaining_estimate_text
Create Goal
Create a strategic goal in one Aha! workspace or product line.
Inputs: name, value, effort, progress, watchers, parent_id, product_id, time_frame, description, custom_fields, success_metric, progress_source, workflow_status
Create Idea
Create an idea in a product with the documented idea fields.
Inputs: epic, name, spam, tags, themes, feature, categories, created_at, created_by, initiative, product_id, visibility, description, initial_votes, duplicate_idea, workflow_status, assigned_to_user, portal_restricted, submitted_idea_portal_id, restricted_idea_portal_ids
Create Idea Theme
Create an idea theme in a product.
Inputs: name, product_id, description_attributes
Create Initiative
Create a strategic initiative in one Aha! workspace or product line.
Inputs: name, goals, value, effort, end_date, position, progress, watchers, parent_id, presented, product_id, start_date, time_frame, description, custom_fields, duration_source, progress_source, workflow_status, assigned_to_user
Create Key Result
Create a key result under one strategic goal.
Inputs: name, goal_id, watchers, description, custom_fields, target_metric, current_metric, starting_metric, workflow_status, assigned_to_user
Create Parking-Lot Release
Create a parking-lot release in a workspace.
Inputs: name, goals, owner, theme, end_date, parent_id, product_id, start_date, initiatives, capacity_units, workflow_status
Create Product
Create an Aha! product workspace with a name, description, and reference prefix.
Inputs: name, prefix, description
Create Product Contributor
Create an Aha! contributor user associated with a product.
Inputs: role, email, last_name, first_name, product_id
Create Product Roll-Up Release
Create a roll-up release in a product line, optionally adding workspaces.
Inputs: name, theme, product_id, project_ids, release_date
Create Release Milestone
Create a phase or milestone in an Aha! release.
Inputs: name, end_on, progress, start_on, phase_type, release_id, description, duration_source, progress_source
Create Requirement
Create a requirement within one feature.
Inputs: name, end_date, feature_id, start_date, description, workflow_status, assigned_to_user
Create To-Do
Create a standalone personal to-do for the connected Aha! user.
Inputs: body, name
Create Workflow Status Time
Create a workflow status interval for one supported parent record. This endpoint requires activation by Aha! support.
Inputs: parent_id, parent_type, workflow_status_time
Delete Custom Field Option
Delete one option from an Aha! custom-field definition; it may remain restorable through the recycle bin for up to 30 days.
Inputs: option_id, custom_field_definition_id
Delete Epic
Delete an epic by ID; it may remain restorable through the recycle bin for up to 30 days.
Inputs: epic_id
Delete Feature
Delete one feature by ID or reference number; it may remain restorable through the recycle bin for up to 30 days.
Inputs: feature_id
Delete Goal
Delete one strategic goal; it may remain restorable through the recycle bin for up to 30 days.
Inputs: goal_id, product_id
Delete Idea
Delete an idea by ID or reference key; it may remain restorable through the recycle bin for up to 30 days.
Inputs: idea_id
Delete Idea Theme
Delete an idea theme by numeric ID; it may remain restorable through the recycle bin for up to 30 days.
Inputs: idea_theme_id
Delete Initiative
Delete one strategic initiative; it may remain restorable through the recycle bin for up to 30 days.
Inputs: product_id, initiative_id
Delete Key Result
Delete one key result; it may remain restorable through the recycle bin for up to 30 days.
Inputs: key_result_id
Delete Release
Delete a release from a workspace; it may remain restorable through the recycle bin for up to 30 days.
Inputs: product_id, release_id
Delete Release Phase
Delete a release phase by numeric ID; it may remain restorable through the recycle bin for up to 30 days.
Inputs: release_phase_id
Delete Requirement
Delete one requirement by ID or reference number; it may remain restorable through the recycle bin for up to 30 days.
Inputs: requirement_id
Delete To-Do
Delete one to-do by its Aha! task ID; it may remain restorable through the recycle bin for up to 30 days.
Inputs: todo_id
Delete User Custom Role
Remove a user's custom role in one Aha! product.
Inputs: user_id, product_id
Delete User Product Role
Remove a user's role in one Aha! product.
Inputs: user_id, product_id
Delete Workflow Status Time
Delete a workflow status interval. This endpoint requires activation by Aha! support.
Inputs: workflow_status_time_id
Duplicate Release
Create a duplicate of an existing release.
Inputs: release_id
Get Current User
Return the connected Aha! user, account context, and product roles.
Get Custom Layout
Return one custom layout. Requires configuration-administrator access.
Inputs: custom_layout_id
Get Epic
Return one Aha! epic by its ID or reference number.
Inputs: epic_id
Get Feature
Return detailed information for one feature by internal ID or human-readable reference number.
Inputs: fields, feature_id
Get Goal
Return one strategic goal by ID or reference number.
Inputs: goal_id
Get Idea
Return one idea by ID or reference number.
Inputs: fields, idea_id
Get Idea Theme
Return one idea theme by ID.
Inputs: idea_theme_id
Get Identity Provider
Return one identity provider configured for account SSO.
Inputs: identity_provider_id
Get Initiative
Return one strategic initiative by ID or reference number.
Inputs: initiative_id
Get Key Result
Return one key result by ID.
Inputs: key_result_id
Get Release
Return one release by ID or reference number.
Inputs: release_id
Get Release Phase
Return one release phase by ID.
Inputs: release_phase_id
Get Requirement
Return one requirement by ID or reference number.
Inputs: requirement_id
Get Roll-Up Release
Return one roll-up release by ID or reference number.
Inputs: rollup_release_id
Get Strategic Model
Return one strategic model by ID.
Inputs: strategic_model_id
Get Strategic Vision
Return one strategic vision by ID.
Inputs: strategic_vision_id
Get To-Do
Return one to-do by its Aha! task ID.
Inputs: fields, todo_id
Get User
Get a specific Aha! user by ID.
Inputs: user_id
Get Workflow
Return one workflow with its statuses and workflow kinds.
Inputs: workflow_id
Get Workflow Status Time
Return one workflow status interval. The endpoint must be enabled by Aha! support.
Inputs: workflow_status_time_id
Get Workspace
Return one workspace by ID, with applied template details when available or requested.
Inputs: fields, workspace_id
List All Custom Field Options
Return all options configured for one custom-field definition.
Inputs: custom_field_definition_id
List Assigned Records
List one page of records assigned to the connected Aha! user, optionally by record type.
Inputs: cursor, per_page, record_type
List Assistant Usage
Return one page of per-user AI assistant activity. The first page requires both start_at and end_at; subsequent pages accept the returned cursor alone.
Inputs: cursor, end_at, per_page, start_at
List Audits
Return one page of immutable Aha! record-change history, optionally filtered by the changed record or an associated parent record.
Inputs: cursor, fields, per_page, auditable_id, associated_id, auditable_type, associated_type
List Child Releases
Return releases under a roll-up release, one page at a time.
Inputs: cursor, per_page, release_id
List Custom Field Options
Return selectable options for one custom-field definition.
Inputs: custom_field_definition_id
List Custom Fields
Return custom-field definitions, keys, types, and worksheet metadata.
List Custom Layouts
Return custom layouts configured in the account.
List Deletions
Return records currently visible in the account recycle bin, one page at a time.
Inputs: cursor, per_page
List Epics
Return one page of epics across the account or within a goal, initiative, release, or workspace.
Inputs: cursor, fields, per_page, context_id, context_type, custom_fields, workflow_status
List Features
Return one page of features across the account or within a goal, initiative, epic, workspace, or release.
Inputs: cursor, fields, per_page, context_id, context_type, custom_fields, workflow_status
List Goals
Return one page of strategic goals across the account or within an initiative or product.
Inputs: cursor, per_page, context_id, context_type
List Idea Portals
Return idea portals configured in the account or linked to one product, one page at a time.
Inputs: cursor, context, per_page, product_id
List Ideas
Search and filter ideas across the account or within one product, returning one page at a time.
Inputs: tag, sort, spam, query, cursor, fields, context, user_id, per_page, product_id, created_since, updated_since, created_before, workflow_status, assigned_to_user
List Idea Themes
Return idea themes across the account, one page at a time.
Inputs: cursor, per_page
List Identity Providers
Return active identity providers available for account SSO.
List Initiatives
Return one page of strategic initiatives across the account or within a goal or product.
Inputs: cursor, fields, per_page, context_id, context_type, custom_fields, workflow_status
List Key Results
Return key results for one strategic goal, one page at a time.
Inputs: cursor, goal_id, per_page
List My Pending To-Dos
Deprecated compatibility action that lists one page of pending to-dos assigned to the connected Aha! user.
Inputs: cursor, per_page
List Product Roll-Up Releases
Return roll-up releases in one Aha! product line, one page at a time.
Inputs: cursor, per_page, product_line_id
List Product Users
List one page of users and roles associated with an Aha! product.
Inputs: cursor, per_page, product_id
List Related Ideas
Find ideas related to a term, one page at a time.
Inputs: query, cursor, idea_portal_id
List Release Phases
Return release phases across the account or within one release, one page at a time.
Inputs: type, cursor, context, per_page, release_id
List Releases
Return releases associated with a workspace, goal, or initiative, one page at a time.
Inputs: cursor, per_page, context_id, context_type
List Requirements
Return requirements for one feature, optionally updated since a timestamp, one page at a time.
Inputs: cursor, per_page, feature_id, updated_since
List Roll-Up Child Releases
Return releases under a roll-up release, one page at a time.
Inputs: cursor, per_page, release_id
List Strategy Models
Return strategy models configured in the account, one page at a time.
Inputs: cursor, per_page
List Strategy Visions
Return strategic vision records in the account, one page at a time.
Inputs: cursor, per_page
List To-Dos
Return one page of account, assigned-user, or associated-record to-dos.
Inputs: view, cursor, fields, epic_id, idea_id, user_id, per_page, parent_id, todo_type, feature_id, product_id, release_id, parent_type, updated_since, requirement_id
List User Custom Roles
List one page of an Aha! user's custom roles and their scopes.
Inputs: cursor, user_id, per_page
List User Product Roles
List one page of an Aha! user's roles in individual products.
Inputs: cursor, user_id, per_page
List Users
Return account users and their seat and administrator flags, one page at a time.
Inputs: cursor, per_page
List Workflows
Return workflows and statuses configured for one workspace.
Inputs: workspace_id
List Workflow Status Times
Return workflow status intervals for one supported parent record, one page at a time. The endpoint must be enabled by Aha! support.
Inputs: cursor, per_page, parent_id, parent_type
List Workspaces
Return Aha! workspaces and workspace lines available to the connected user, one page at a time.
Inputs: cursor, per_page, include_teams, with_idea_portals
Promote Idea
Promote an idea to an epic, feature, initiative, or requirement.
Inputs: idea_id, feature_id, product_id, release_id, promotable_type
Replace Product Idea Portals
Replace every idea portal link on a product.
Inputs: product_id, idea_portal_ids
Restore Deleted Record
Start restoring a record from the recycle bin within its retention period; restoration may continue asynchronously.
Inputs: deletion_id
Update Custom Field Option
Update the value, color, or visibility of a custom-field option.
Inputs: color, value, hidden, option_id, custom_field_definition_id
Update Epic
Update an epic by ID; provide at least one field to change.
Inputs: name, tags, goals, epic_id, release, due_date, initiative, start_date, description, duration_source, workflow_status, assigned_to_user
Update Feature
Update one feature's planning fields; provide at least one field to change.
Inputs: epic, name, tags, team, goals, release, due_date, progress, iteration, created_by, feature_id, initiative, start_date, description, release_phase, workflow_kind, progress_source, workflow_status, assigned_to_user, initial_estimate, detailed_estimate, program_increment, remaining_estimate, team_workflow_status, initial_estimate_text, detailed_estimate_text, remaining_estimate_text
Update Goal
Update one strategic goal; provide at least one field to change.
Inputs: name, value, effort, goal_id, progress, watchers, parent_id, product_id, time_frame, description, custom_fields, success_metric, progress_source, workflow_status
Update Idea
Update an existing idea; provide at least one field to change.
Inputs: epic, name, spam, tags, themes, feature, idea_id, categories, created_at, created_by, initiative, visibility, description, initial_votes, duplicate_idea, workflow_status, assigned_to_user, portal_restricted, submitted_idea_portal_id, restricted_idea_portal_ids
Update Idea Theme
Update an idea theme; provide a new name or description.
Inputs: name, idea_theme_id, description_attributes
Update Initiative
Update one strategic initiative; provide at least one field to change.
Inputs: name, goals, value, effort, end_date, position, progress, watchers, parent_id, presented, product_id, start_date, time_frame, description, custom_fields, initiative_id, duration_source, progress_source, workflow_status, assigned_to_user
Update Key Result
Update one key result; provide at least one field to change.
Inputs: name, watchers, description, custom_fields, key_result_id, target_metric, current_metric, starting_metric, workflow_status, assigned_to_user
Update Product
Update an Aha! product; provide a new name, description, or reference prefix.
Inputs: name, product_id, description, reference_prefix
Update Release
Update a release by ID, optionally through a specified workspace, including dates, capacity, progress, parent, owner, goals, and initiatives; provide at least one field to change.
Inputs: name, goals, owner, theme, end_date, progress, parent_id, release_id, start_date, initiatives, parking_lot, release_date, workspace_id, capacity_units, duration_source, progress_source, workflow_status, total_capacity_text, external_release_date, development_started_on, external_date_resolution
Update Release Phase
Update a release phase's type and optionally its dates, description, or progress. The phase type is required on every update.
Inputs: end_on, progress, start_on, phase_type, description, duration_source, progress_source, release_phase_id
Update Requirement
Update one requirement; provide at least one field to change.
Inputs: name, end_date, start_date, description, requirement_id, workflow_status, assigned_to_user
Update Roll-Up Release
Update a roll-up release's name or add workspaces to it.
Inputs: name, project_ids, rollup_release_id
Update To-Do
Update an existing to-do's name or description; provide at least one of name or body.
Inputs: body, name, todo_id
Update User
Update an Aha! user; provide a new name or enabled state.
Inputs: enabled, user_id, last_name, first_name
Update User Custom Roles
Assign a custom role to an Aha! user for one product.
Inputs: user_id, product_id, custom_role_id
Update User Product Roles
Assign a product role to an Aha! user for one product.
Inputs: role, user_id, product_id
Update Workflow Status Time
Update a workflow status interval. This endpoint requires activation by Aha! support.
Inputs: workflow_status_time, workflow_status_time_id