Products

Product overview

Streamline product development

Link strategy to plans

Capture customer feedback

Aha! Whiteboards

Explore visual concepts

Publish product information

Manage agile delivery

Get trained and certified

Connect your tools

Accelerate your work

Product success

Receive expert support

Product concierge

Use advanced services

Products

Products

The Aha! Framework

Build software like we do, blending strategic planning with the speed of agile.

Solutions

By team

Align teams around a strategic roadmap

Product management

Product operations

Project management

Business operations

By use case

Manage each phase of product development

Customer research

Release management

Solutions

Solutions

Streamline PI planning

New capabilities in Aha! software make it easier to scope out work.

Resources

Guide for product managers

Find expert answers and advice

Inspirational templates

Choose from a library of guided templates

Gain insights on company and product building

Customer stories

See why thousands of companies trust Aha!

Product dictionary

Get familiar with product development terms

Support knowledge base

Read step-by-step guidance on Aha! products

See best practices for using the Aha! suite

Product management training

Earn your Aha! certification

Attend sessions with our product experts

Work with a network of certified consultants

Resources

Resources

Align with stakeholders

Engage key stakeholders at every stage of product planning.

Company

Learn what makes us so different

Building a company that puts people first

The Responsive Method

Our framework for business growth

Meet the people driving our success

Love your job and build what matters

We put people and profit first

Company

Company

Get advice on building a high-growth software company.

Log in
Free trial
Join a demo

API
API resources / Team members

Team members API

Manage virtual users used in capacity planning

Select an API endpoint from the navigation to learn more.

Overview

Introduction
URLs
Authentication
Pagination
Errors
Rate Limits
Customization
User Agent
Custom Fields
Email Suppression

Authentication

OAuth2 Authentication
Registering an Application
Authorization Flow

Additional

JavaScript API
Integrating with Aha!

API Resources

Account backups

Create an account backup
Download an account backup
Get a specific account backup
List account backups

Attachments

Create an attachment on a comment
Create an attachment on a comment via a link
Create an attachment on a custom attachment field
Create an attachment on a custom attachment field via a link
Create an attachment on a custom note field
Create an attachment on a custom note field via a link
Create an attachment on a record description
Create an attachment on a record description via a link
Create an attachment on a to-do
Create an attachment on a to-do via a link
Create an attachment on an idea comment
Create an attachment on an idea comment via a link
Delete an attachment
Reject duplicate attachments

Capacity estimate values

Create estimate values for a capacity investment
Delete an estimate value
List estimate values for a capacity investment
Update an estimate value

Capacity investments

Create a capacity investment on a feature
Create a capacity investment on an epic
Create a capacity investment on an initiative
Create a Capacity Investment with custom fields
Get a capacity investment
List capacity investments for a feature
List capacity investments for a product
List capacity investments for an epic
List capacity investments for an initiative
Update a capacity investment
Update a capacity investment's custom fields

Capacity scenarios

Get a capacity scenario
List capacity scenarios

Comments

Create a comment on a feature
Create a comment on a goal
Create a comment on a note
Create a comment on a release
Create a comment on a release phase
Create a comment on a requirement
Create a comment on a to-do
Create a comment on an epic
Create a comment on an initiative
Create an internal comment for an idea
Delete a comment
Get a specific comment
List comments in a product
List comments on a feature
List comments on a goal
List comments on a note
List comments on a release
List comments on a release phase
List comments on a requirement
List comments on a to-do
List comments on a to-do
List comments on an epic
List comments on an idea
List comments on an initiative
Update a comment

Competitors

Create a competitor
Delete a competitor
Get a specific competitor
List competitors in a product
Update a competitor

Creative briefs

Create a creative brief
Delete a creative brief
Get a specific creative_brief
List creative briefs in a product
Update a creative brief

Custom Layouts

Get a custom layout by ID
List all custom layouts

Custom field options

Create a custom field option
Delete a custom field option
List all custom fields
Update a custom field option

Custom fields

List all custom fields
List options for a custom field

Custom pivots

Get the list view of a saved report
Get the pivot view of a saved report

Custom table record links

Create a custom table record link associated with a feature
Create a custom table record link associated with a goal
Create a custom table record link associated with a product
Create a custom table record link associated with a release
Create a custom table record link associated with a requirement
Create a custom table record link associated with an idea
Create a custom table record link associated with an initiative
Link custom table records to another custom table record

Custom table records

Create a custom table record
Delete a custom table record
Get a specific custom table record
List records in a custom table for a product
Update a custom table record

Deletions

List contents of recycle bin
restore a specific record

Epics

Create an epic
Create an epic in the default release
Create an epic on behalf of a user
Create an epic with goals
Create an epic with watchers
Delete an epic
Get a specific epic
List epics
List epics associated with a goal
List epics associated with an initiative
List epics in a product
List epics in a release
Update an epic
Update an epic's custom fields
Update an epic's goals
Update an epic's progress
Update an epic's progress source
Update an epic's score
Update an epic's tags with an array
Update an epic's tags with comma-separated values
Update an epic's watchers

Features

Convert a feature to an epic
Create a feature
Create a feature with a score
Create a feature with an assignee
Create a feature with goals
Create a feature with tags
Create a feature with watchers
Delete a feature
Get a specific feature
List features
List features associated with a goal
List features associated with an initiative
List features in a product
List features in a release
List features in an epic
Update a feature
Update a feature's custom fields
Update a feature's custom fields with tag-like value
Update a feature's custom worksheet fields
Update a feature's epic
Update a feature's goals
Update a feature's progress
Update a feature's progress source
Update a feature's release
Update a feature's score
Update a feature's tags with an array
Update a feature's tags with comma-separated values
Update a feature's watchers

Goals

Create a goal
Create a goal with watchers
Delete a goal
Get a specific goal
List goals
List goals associated with an initiative
List goals in a product
Update a goal
Update a goal's progress
Update a goal's progress source
Update a goal's watchers

Idea Portals

List idea portals in a product

Idea categories

List idea categories in a product

Idea comments

Create an idea comment created by an Aha! user (specified by id)
Create an idea comment created by an ideas portal user (specified by id)
Create an idea comment for an idea
Create an idea comment reply to a parent idea_comment
Create an idea comment visible to idea creator
Create an idea comment with restricted visibility
Delete an idea comment
List idea comments for an idea
Mark an idea comment as spam
Update a comment
Update an idea comment's visibility

Idea organizations

Create an idea organization
Delete organization
Get a specific organization
List idea organizations
Update organization
Update organization custom fields

Idea subscriptions

Create an idea subscription
Create an idea subscription in a specific portal
Delete an idea subscription
Get a specific subscription for an idea
List subscriptions for an idea

Idea users

Create a idea user
Delete an idea user
Get a specific idea user
List idea users for an account
Remove an idea user's idea_organizations
Update an idea user
Update an idea user's idea_organizations

Idea votes

Create a proxy vote
Create a proxy vote created by an Aha! user
Create a proxy vote created by the authenticated user
Create a proxy vote with custom fields
Create a proxy vote with idea users (contacts)
Create additional idea votes
Create an idea vote
Create an idea vote for a user, using the vote limits of an idea portal
Delete an idea vote
Get a specific vote for an idea
Get all related idea organizations for votes associated with an idea
List votes for an account
List votes for an idea
Update an idea vote
Update an idea vote's custom fields
Update an idea vote's custom fields with an array value

Ideas

Create an idea
Create an idea created by a ideas portal user
Create an idea with a category
Create an idea with a score
Create an idea with a set creation date
Create an idea with a specific submitted_idea_portal
Create an idea with a specific visibility
Create an idea with an admin response
Create an idea with comma-separated tags
Create an idea with custom fields
Create an idea with multiple categories
Create an idea with watchers
Create an idea without a submitted_idea_portal
Delete an idea
Get a specific idea
Get a specific idea that is merged (has a duplicate_of)
Get a specific idea with plain text body
Get duplicates of a specific idea
List ideas
List ideas for a product
List ideas related to a particular term
Mark an idea as spam
Move an idea to a different workspace
Promote an idea
Un-promote an idea from a feature
Un-promote an idea from an epic
Un-promote an idea from an initiative
Update a idea's watchers
Update an idea
Update an idea's custom fields
Update an idea's custom fields with an array value
Update an idea's submitted_idea_portal
Update an idea's visibility

Ideas portal user subscriptions

List a portal user's preferences for the portal summary email
Set a portal user's preferences to specific categories
Set a portal user's preferences to specific project and category updates
Subscribe a portal user to updates from all projects and categories

Ideas portal users

Create a portal user
Create a portal user with employee permissions
Delete a portal user
Get a specific portal user
List portal users for an ideas portal
Unsubscribe portal user from all communications
Update a portal user

Identity providers

Get a specific identity provider
List active identity providers that can be used for SSO

Initiatives

Create an initiative
Create an initiative with watchers
Delete an initiative
Get a specific initiative
List initiatives
List initiatives associated with a goal
List initiatives in a product
Update an initiative
Update an initiative's custom fields
Update an initiative's progress
Update an initiative's progress source
Update an initiative's watchers

Integration fields

Create an integration field for a epic by integration ID
Create an integration field for a feature by integration ID
Create an integration field for a feature by service name
Create an integration field for an idea vote
Create multiple integration fields for a epic by integration ID
Create multiple integration fields for a feature by integration ID
Create multiple integration fields for a feature by service name
Delete an integration field
Get a specific integration field value
List epics with an associated integration field value
List features with an associated integration field value
List idea votes with an associated integration field value
List initiatives with an associated integration field value
List records with an associated integration field value
List releases with an associated integration field value
List requirements with an associated integration field value

Integrations

Create an integration based on a template for a product
Create an integration for a product
Create an integration for an account
Get a specific integration
Get a specific integration by service name
List integrations for a product
List integrations for an account

Key results

Create a key result
Delete a key result
Get a specific key result
List key results for a goal
Update a key result
Update a key result's custom fields

Me

Get the current user
List pending tasks assigned to the current user
List records assigned to the current user

Notes

Create a note
Create an internal link
Delete a note
Get a specific note
List notes for a product
Update a note
Update a note's custom fields
Update a note's tags with an array
Update a note's tags with comma-separated values
Update an external link

Paid Seat Groups

Adds the user to the paid seat group
List the administered paid seat groups
Updates the paid seat group

Personas

Create a persona
Delete a persona
Get a specific persona
List personas in a product
Update a persona

Products

Create a product
Create a product line
Get a specific product
List products (including Aha! Develop teams in the account)
List products in the account
List products with idea portals in the account
Update a product

Record links

Create a record link for a epic
Create a record link for a feature
Create a record link for a goal
Create a record link for a idea
Create a record link for a initiative
Create a record link for a page
Create a record link for a release
Create a record link for a release phase
Create a record link for a requirement
Delete a record link
Get a specific record link
List record links for a feature
List record links including both parent and child records

Release phases

Create a release milestone
Create a release phase
Delete a release phase
Get a specific release phase
List release phases for a release
List release phases in the account
Update a release phase
Update a release phase's progress
Update a release phase's progress source

Releases

Add a release to a roll up release
Create a parking lot release
Create a release
Create a release with goals
Create a release with initiatives
Create a release with watchers
Delete a release
Duplicate a release
Get a specific release
List releases associated with a goal
List releases associated with an initiative
List releases in a product
List releases under a roll-up release
List releases under a roll-up release
Update a release
Update a release's goals
Update a release's initiatives
Update a release's progress
Update a release's progress source
Update a release's watchers

Requirements

Convert a requirement to a feature
Create a requirement
Delete a requirement
Get a specific requirement
Get requirements updated after a certain time
List requirements for a feature
Update a requirement
Update a requirement's custom fields

Roll up releases

Add a project to a roll up release
Create a project with a roll up release
Creates a roll up release
Get a specific roll up release
List roll up releases in a product
Update a roll up release

Schedulable changes

Create a schedulable change
Delete a schedulable change
List schedulable changes
Update a schedulable change
Update a scheduled change's team memberships

Schedules

List schedules

Strategic models

Get a specific strategic model
List strategic models

Strategic positionings

Get a specific strategic positioning
List strategic positionings

Strategic visions

Get a specific strategic vision
List strategic visions

Team members

Create a virtual user
Delete a virtual team member
List virtual team members

Team memberships

Add user to a team
List team memberships for a team
Remove a user from a team

Teams

Automatically calculate team's member count
Create a team
Create a team associated with a product
Delete a team
Get a specific team
List teams
List teams in a product
Manually update a team's member count
Update a team's product

Time tracking events

Create a time tracking event for a feature with remaining estimate
Create a time tracking event for a requirement
Create a time tracking event for an initiative
Delete a time tracking event
Log work done for a feature that uses story points

To-dos

Create a task
Create a to-do associated with a feature
Create a to-do with a due date
Create a to-do with multiple assignees
Create a to-do without an associated record
Create an approval associated with a feature
Delete a to-do
Get a specific to-do
Get tasks updated after a certain time
List approvals
List to-dos
List to-dos assigned to a user
List to-dos associated with a feature
List to-dos associated with a product
List to-dos associated with a release
List to-dos associated with a requirement
List to-dos associated with an epic
List to-dos associated with an idea
Update a to-do
Update a to-do's status

Users

Create a contributor user
Create a user
Create a user with a password access
Create a user with an identity provider ID
Create a viewer user
Delete a user's custom role
Delete a user's product role
Get a specific user
List a user's custom roles
List a user's product roles
List users
List users associated with a product
Update a user
Update a user's custom roles
Update a user's product roles

Workflows

Get a specific workflow
List workflows

Products
Company
Resources
Popular links
Contact us

© 2024 Aha! Labs Inc.•All rights reserved

Privacy policy
Terms of service