API Resources

Full documentation on Aha!'s many resources and sub-resources can be browsed here. The navigation on the side allows you to drill down on a particular point of interest.

Account Backups API


Account Backups let you create a complete off-site backup of your Aha! account. They can be created, listed, and downloaded.

An account backup may only be created once every 24 hours.

The backup file contains a representation of all of the data in the Aha! account, including all relationships. It does not contain user authentication data or integration secrets. The backup does not include any uploaded files.

Account backups are an Enterprise+ exclusive feature.

GET /api/v1/account_backups

List account backups

GET /api/v1/account_backups

Example CURL command

curl -g "https://account1.aha.io/api/v1/account_backups" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "account_backups": [

  ]
}

POST /api/v1/account_backups

Trigger creation of an account backup

The backup may take some time to generate (as long as ten minutes in a large account). You should poll the GET endpoint to see when the backup is complete. You should not poll more frequently than once every twenty seconds. Returns an HTTP status of 429 if a backup was already created within the last 24 hours.

POST /api/v1/account_backups

Example CURL command

curl "https://account1.aha.io/api/v1/account_backups" -d '' -X POST \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "account_backup": {
    "id": "6580368810572561457",
    "status_code": 0,
    "status_description": "In Queue",
    "created_at": "2018-07-20T18:31:45.644Z"
  }
}

GET /api/v1/account_backups/:id

Show account backup

The status field indicates whether the backup is ready the possible values are: 0=queued, 1=working, 2=completed, 3=error.

Parameters

Name Description
id * Numeric ID of the backup to fetch

GET /api/v1/account_backups/6580368811744096288

Example CURL command

curl -g "https://account1.aha.io/api/v1/account_backups/6580368811744096288" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "account_backup": {
    "id": "6580368811744096288",
    "status_code": 3,
    "status_description": "Error",
    "created_at": "2018-07-20T18:31:45.916Z"
  }
}

GET /api/v1/account_backups/:id.tgz

Download account backup

Parameters

Name Description
id * Numeric ID of the backup to download

GET /api/v1/account_backups/6580368813154572650.tgz

Example CURL command

curl -g "https://account1.aha.io/api/v1/account_backups/6580368813154572650.tgz" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/gzip

Attachments API


Files can be uploaded to Aha! as a sub-resource on any resource that supports them. These resources support attachments:

Notes appear all across the system on various records like Feature descriptions or Release themes. The id for these note fields can be found in the attributes of the record.

The format of an attachment is either a multipart/form-data upload or a json payload pointing to a file url link:

{ 
  "attachment": {
    "file_url": "http://www.aha.io/", 
    "content_type": "text/html",
    "file_name": "home_page.html"
  }
}

POST /api/v1/comments/:comment_id/attachments

Upload a file to a comment

Parameters

Name Description
comment_id * Numeric ID of the comment the uploaded file should be attached to

POST /api/v1/comments/933135074/attachments

Example CURL command

curl "https://account1.aha.io/api/v1/comments/933135074/attachments" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Accept: application/json
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6580368814617888131",
    "download_url": "http://account1.lvh.me/attachments/6580368814617888131/token/10b5de2e2b156c56ebccba60ca0ae02fb0c3de276998f7e254b73668cbc96fa5.download?size=original",
    "created_at": "2018-07-20T18:31:46.584Z",
    "updated_at": "2018-07-20T18:31:46.584Z",
    "file_size": 27,
    "content_type": "text/plain",
    "file_name": "sample_plain_text.txt"
  }
}

POST /api/v1/comments/:comment_id/attachments

Upload a link to a comment

Parameters

Name Description
comment_id * Numeric ID of the comment the uploaded file should be attached to

POST /api/v1/comments/933135074/attachments

Example CURL command

curl "https://account1.aha.io/api/v1/comments/933135074/attachments" -d 'attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data
Accept: application/json
attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6580368816005114968",
    "download_url": "http://account1.lvh.me/attachments/6580368816005114968/token/be137b1f1cdbb6257df5994e3aa9222b8bf70c2edf623bd742fcbc99cd4da9fb.download?size=original",
    "created_at": "2018-07-20T18:31:46.909Z",
    "updated_at": "2018-07-20T18:31:46.909Z",
    "file_size": 0,
    "content_type": "text/html",
    "file_name": "home_page.html"
  }
}

POST /api/v1/idea_comments/:idea_comment_id/attachments

Upload a file to an idea comment

Parameters

Name Description
idea_comment_id * Numeric ID of the idea comment the uploaded file should be attached to

POST /api/v1/idea_comments/622085811/attachments

Example CURL command

curl "https://account1.aha.io/api/v1/idea_comments/622085811/attachments" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Accept: application/json
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6580368816924048260",
    "download_url": "http://account1.lvh.me/attachments/6580368816924048260/token/697189d68e7091ae9b088933ef24b4adbad6298711ce30105800465456077c13.download?size=original",
    "created_at": "2018-07-20T18:31:47.122Z",
    "updated_at": "2018-07-20T18:31:47.122Z",
    "file_size": 27,
    "content_type": "text/plain",
    "file_name": "sample_plain_text.txt"
  }
}

POST /api/v1/idea_comments/:idea_comment_id/attachments

Upload a link to an idea comment

Parameters

Name Description
idea_comment_id * Numeric ID of the idea comment the uploaded file should be attached to

POST /api/v1/idea_comments/622085811/attachments

Example CURL command

curl "https://account1.aha.io/api/v1/idea_comments/622085811/attachments" -d 'attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data
Accept: application/json
attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6580368817840634697",
    "download_url": "http://account1.lvh.me/attachments/6580368817840634697/token/5e4d4a32fe191ef46c40b0adac6c10277377f52e7f4c74aee08abd9d0aa7ce37.download?size=original",
    "created_at": "2018-07-20T18:31:47.334Z",
    "updated_at": "2018-07-20T18:31:47.334Z",
    "file_size": 0,
    "content_type": "text/html",
    "file_name": "home_page.html"
  }
}

POST /api/v1/tasks/:task_id/attachments

Upload a file to a task

Parameters

Name Description
task_id * Numeric ID of the task the uploaded file should be attached to

POST /api/v1/tasks/1041191038/attachments

Example CURL command

curl "https://account1.aha.io/api/v1/tasks/1041191038/attachments" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Accept: application/json
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6580368818771487432",
    "download_url": "http://account1.lvh.me/attachments/6580368818771487432/token/858a0465e1dd0fc2f979d55146fc4b58604e12572d16a7bd02ac35fc94683c3e.download?size=original",
    "created_at": "2018-07-20T18:31:47.551Z",
    "updated_at": "2018-07-20T18:31:47.551Z",
    "file_size": 27,
    "content_type": "text/plain",
    "file_name": "sample_plain_text.txt"
  }
}

POST /api/v1/tasks/:task_id/attachments

Upload a link to a task

Parameters

Name Description
task_id * Numeric ID of the task the uploaded file should be attached to

POST /api/v1/tasks/1041191038/attachments

Example CURL command

curl "https://account1.aha.io/api/v1/tasks/1041191038/attachments" -d 'attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data
Accept: application/json
attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6580368819876846150",
    "download_url": "http://account1.lvh.me/attachments/6580368819876846150/token/99f9cb3e6dcaeb2f55f74b19f6e1f44da92265a9f279cb2b5735a7353407d014.download?size=original",
    "created_at": "2018-07-20T18:31:47.809Z",
    "updated_at": "2018-07-20T18:31:47.809Z",
    "file_size": 0,
    "content_type": "text/html",
    "file_name": "home_page.html"
  }
}

POST /api/v1/custom_fields/:custom_field_id/attachments

Upload a file to a custom note field

Parameters

Name Description
custom_field_id * Numeric ID of the custom field the uploaded file should be attached to

POST /api/v1/custom_fields/432637490/attachments

Example CURL command

curl "https://account1.aha.io/api/v1/custom_fields/432637490/attachments" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Accept: application/json
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6580368820803497355",
    "download_url": "http://account1.lvh.me/attachments/6580368820803497355/token/52348cc974a15258a82ffcaaca0ebac80aff20a880a2a8fb3e95f677a0d995cc.download?size=original",
    "created_at": "2018-07-20T18:31:48.029Z",
    "updated_at": "2018-07-20T18:31:48.029Z",
    "file_size": 27,
    "content_type": "text/plain",
    "file_name": "sample_plain_text.txt"
  }
}

POST /api/v1/custom_fields/:custom_field_id/attachments

Upload a link to a custom note field

Parameters

Name Description
custom_field_id * Numeric ID of the custom field the uploaded file should be attached to

POST /api/v1/custom_fields/432637490/attachments

Example CURL command

curl "https://account1.aha.io/api/v1/custom_fields/432637490/attachments" -d 'attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data
Accept: application/json
attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6580368822011107434",
    "download_url": "http://account1.lvh.me/attachments/6580368822011107434/token/dfe497e5529a4dc0c19aba42fb86369e20ddfe4bf9efbc97c054856e8a991a96.download?size=original",
    "created_at": "2018-07-20T18:31:48.307Z",
    "updated_at": "2018-07-20T18:31:48.307Z",
    "file_size": 0,
    "content_type": "text/html",
    "file_name": "home_page.html"
  }
}

POST /api/v1/notes/:note_id/attachments

Upload a file to a note (description, theme, etc)

Parameters

Name Description
note_id * Numeric ID of the note the uploaded file should be attached to

POST /api/v1/notes/793547626/attachments

Example CURL command

curl "https://account1.aha.io/api/v1/notes/793547626/attachments" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Accept: application/json
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6580368823068748520",
    "download_url": "http://account1.lvh.me/attachments/6580368823068748520/token/b340e1930722c32ab4204e43e6a3fe6548398325b4d730e79aba897edb8dc6d2.download?size=original",
    "created_at": "2018-07-20T18:31:48.552Z",
    "updated_at": "2018-07-20T18:31:48.552Z",
    "file_size": 27,
    "content_type": "text/plain",
    "file_name": "sample_plain_text.txt"
  }
}

POST /api/v1/notes/:note_id/attachments

Upload a link to a note (description, theme, etc)

Parameters

Name Description
note_id * Numeric ID of the note the uploaded file should be attached to

POST /api/v1/notes/793547626/attachments

Example CURL command

curl "https://account1.aha.io/api/v1/notes/793547626/attachments" -d 'attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data
Accept: application/json
attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6580368824357279819",
    "download_url": "http://account1.lvh.me/attachments/6580368824357279819/token/2717c144b273470e8d98fa5a3cb21b4aa9a8ce787923c1e23190455474ada420.download?size=original",
    "created_at": "2018-07-20T18:31:48.851Z",
    "updated_at": "2018-07-20T18:31:48.851Z",
    "file_size": 0,
    "content_type": "text/html",
    "file_name": "home_page.html"
  }
}

Comments API


Comments can be added to and listed as a sub-resource on any resource that supports them. These resources support comments:

They can be listed product-wide, or retrieved from anywhere in the system using the root comments resource.

POST /api/v1/features/:feature_id/comments

Create a comment for a feature

Parameters

Name Description
feature_id * Numeric ID or key of the feature the comment should be created for

POST /api/v1/features/1007868956/comments

Example CURL command

curl "https://account1.aha.io/api/v1/features/1007868956/comments" -d '{"comment":{"body":"\u003cp\u003eThis is the comment body for a feature.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for a feature.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6580368828304953184",
    "body": "<p>This is the comment body for a feature.</p>",
    "created_at": "2018-07-20T18:31:49.773Z",
    "updated_at": "2018-07-20T18:31:49.773Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "attachments": [

    ],
    "url": "http://account1.example.org/comments/6580368828304953184",
    "resource": "http://account1.example.org/api/v1/comments/6580368828304953184",
    "commentable": {
      "type": "Feature",
      "id": "1007868956",
      "url": "http://account1.example.org/features/PRJ1-1",
      "product_id": 131414752,
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1"
    }
  }
}

POST /api/v1/master_features/:master_feature_id/comments

Create a comment for a master feature

Parameters

Name Description
master_feature_id * Numeric ID or key of the master feature feature the comment should be created for

POST /api/v1/master_features/999605892/comments

Example CURL command

curl "https://account1.aha.io/api/v1/master_features/999605892/comments" -d '{"comment":{"body":"\u003cp\u003eThis is the comment body for a master feature.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for a master feature.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6580368829870824605",
    "body": "<p>This is the comment body for a master feature.</p>",
    "created_at": "2018-07-20T18:31:50.138Z",
    "updated_at": "2018-07-20T18:31:50.138Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "attachments": [

    ],
    "url": "http://account1.example.org/comments/6580368829870824605",
    "resource": "http://account1.example.org/api/v1/comments/6580368829870824605",
    "commentable": {
      "type": "Epic",
      "id": "999605892",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "product_id": 131414752,
      "resource": "http://account1.example.org/api/v1/epics/PRJ1-E-1"
    }
  }
}

POST /api/v1/requirements/:requirement_id/comments

Create a comment for a requirement

Parameters

Name Description
requirement_id * Numeric ID or key of the requirement the comment should be created for

POST /api/v1/requirements/483368544/comments

Example CURL command

curl "https://account1.aha.io/api/v1/requirements/483368544/comments" -d '{"comment":{"body":"\u003cp\u003eThis is the comment body for a requirement.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for a requirement.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6580368831013732689",
    "body": "<p>This is the comment body for a requirement.</p>",
    "created_at": "2018-07-20T18:31:50.404Z",
    "updated_at": "2018-07-20T18:31:50.404Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "attachments": [

    ],
    "url": "http://account1.example.org/comments/6580368831013732689",
    "resource": "http://account1.example.org/api/v1/comments/6580368831013732689",
    "commentable": {
      "type": "Requirement",
      "id": "483368544",
      "url": "http://account1.example.org/requirements/PRJ1-1-1",
      "product_id": 131414752,
      "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1"
    }
  }
}

POST /api/v1/ideas/:idea_id/comments

Create a private comment for an idea

Parameters

Name Description
idea_id * Numeric ID or key of the idea the comment should be created for

POST /api/v1/ideas/58056975/comments

Example CURL command

curl "https://account1.aha.io/api/v1/ideas/58056975/comments" -d '{"comment":{"body":"\u003cp\u003eThis is the comment body for an idea.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for an idea.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6580368833351729495",
    "body": "<p>This is the comment body for an idea.</p>",
    "created_at": "2018-07-20T18:31:50.943Z",
    "updated_at": "2018-07-20T18:31:50.943Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "attachments": [

    ],
    "url": "http://account1.example.org/comments/6580368833351729495",
    "resource": "http://account1.example.org/api/v1/comments/6580368833351729495",
    "commentable": {
      "type": "Ideas::Idea",
      "id": "58056975",
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "product_id": 131414752,
      "resource": "http://account1.example.org/api/v1/ideas/ideas/PRJ1-I-1"
    }
  }
}

POST /api/v1/initiatives/:initiative_id/comments

Create a comment for an initiative

Parameters

Name Description
initiative_id * Numeric ID or key of the initiative the comment should be created for

POST /api/v1/initiatives/423077122/comments

Example CURL command

curl "https://account1.aha.io/api/v1/initiatives/423077122/comments" -d '{"comment":{"body":"\u003cp\u003eThis is the comment body for an initiative.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for an initiative.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6580368834223256703",
    "body": "<p>This is the comment body for an initiative.</p>",
    "created_at": "2018-07-20T18:31:51.146Z",
    "updated_at": "2018-07-20T18:31:51.146Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "attachments": [

    ],
    "url": "http://account1.example.org/comments/6580368834223256703",
    "resource": "http://account1.example.org/api/v1/comments/6580368834223256703",
    "commentable": {
      "type": "Initiative",
      "id": "423077122",
      "url": "http://account1.example.org/initiatives/423077122",
      "product_id": 131414752,
      "resource": "http://account1.example.org/api/v1/initiatives/423077122"
    }
  }
}

POST /api/v1/goals/:goal_id/comments

Create a comment for a goal

Parameters

Name Description
goal_id * Numeric ID or key of the goal the comment should be created for

POST /api/v1/goals/602095703/comments

Example CURL command

curl "https://account1.aha.io/api/v1/goals/602095703/comments" -d '{"comment":{"body":"\u003cp\u003eThis is the comment body for a goal.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for a goal.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6580368835103333063",
    "body": "<p>This is the comment body for a goal.</p>",
    "created_at": "2018-07-20T18:31:51.356Z",
    "updated_at": "2018-07-20T18:31:51.356Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "attachments": [

    ],
    "url": "http://account1.example.org/comments/6580368835103333063",
    "resource": "http://account1.example.org/api/v1/comments/6580368835103333063",
    "commentable": {
      "type": "StrategicImperative",
      "id": "602095703",
      "url": "http://account1.example.org/strategic_imperatives/602095703",
      "product_id": 131414752,
      "resource": "http://account1.example.org/api/v1/goals/602095703"
    }
  }
}

GET /api/v1/products/:project_id/comments

Get all comments on a product

Parameters

Name Description
project_id * Numeric ID of the product to get comments for

GET /api/v1/products/131414752/comments

Example CURL command

curl -g "https://account1.aha.io/api/v1/products/131414752/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [
    {
      "id": "55160124",
      "body": "Comment on project",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/55160124",
      "resource": "http://account1.example.org/api/v1/comments/55160124",
      "commentable": {
        "type": "Task",
        "id": "748715293",
        "url": "http://account1.example.org/tasks/748715293",
        "product_id": null,
        "resource": "http://account1.example.org/api/v1/tasks/748715293"
      }
    },
    {
      "id": "933135074",
      "body": "Comment on project",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [
        {
          "id": "229957526",
          "download_url": "http://account1.lvh.me/attachments/229957526/token/d1ffd233f9e481c33f21e294c4d69c983e77eb291f5605b654bee683b066d035.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:31:51.579Z",
          "file_size": 123,
          "content_type": "image/png",
          "file_name": "not-a-mockup.png"
        },
        {
          "id": "221084308",
          "download_url": "http://account1.lvh.me/attachments/221084308/token/366bb3c1eb691589628d107ef806f496f81a6d558e256ffffc4e68c36f2bb3bd.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:31:51.596Z",
          "file_size": 123,
          "content_type": "image/png",
          "file_name": "Mockup.png"
        },
        {
          "id": "896530823",
          "download_url": "http://account1.lvh.me/attachments/896530823/token/6790f0d0bdc020e3ca7011ececbc31e1e8137e2d1629789260e47e1e0460cfaf.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:31:51.623Z",
          "content_type": "application/pdf",
          "file_name": "google_doc.pdf",
          "file_size": null
        },
        {
          "id": "744925247",
          "download_url": "http://account1.lvh.me/attachments/744925247/token/84f7360a4482b6008b7c605ae8006a7e9a0106cc96f89e9a1abafd62973d9e41.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:31:51.711Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ],
      "url": "http://account1.example.org/comments/933135074",
      "resource": "http://account1.example.org/api/v1/comments/933135074",
      "commentable": {
        "type": "Project",
        "id": "131414752",
        "url": "http://account1.example.org/projects/PRJ1",
        "resource": "http://account1.example.org/api/v1/products/PRJ1"
      }
    },
    {
      "id": "781701978",
      "body": "Comment on feature",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/781701978",
      "resource": "http://account1.example.org/api/v1/comments/781701978",
      "commentable": {
        "type": "Feature",
        "id": "1007868956",
        "url": "http://account1.example.org/features/PRJ1-1",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1"
      }
    },
    {
      "id": "428925905",
      "body": "Comment on release",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "601067208",
        "name": "Jeremy Smith",
        "email": "jeremy.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/428925905",
      "resource": "http://account1.example.org/api/v1/comments/428925905",
      "commentable": {
        "type": "Release",
        "id": "278327321",
        "url": "http://account1.example.org/releases/PRJ1-R-1",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1"
      }
    },
    {
      "id": "133461614",
      "body": "Comment on initiative",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "601067208",
        "name": "Jeremy Smith",
        "email": "jeremy.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/133461614",
      "resource": "http://account1.example.org/api/v1/comments/133461614",
      "commentable": {
        "type": "Initiative",
        "id": "423077122",
        "url": "http://account1.example.org/initiatives/423077122",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/initiatives/423077122"
      }
    },
    {
      "id": "821249787",
      "body": "Comment on goal",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "601067208",
        "name": "Jeremy Smith",
        "email": "jeremy.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/821249787",
      "resource": "http://account1.example.org/api/v1/comments/821249787",
      "commentable": {
        "type": "StrategicImperative",
        "id": "602095703",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/goals/602095703"
      }
    },
    {
      "id": "110125740",
      "body": "Comment on competitor 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/110125740",
      "resource": "http://account1.example.org/api/v1/comments/110125740",
      "commentable": {
        "type": "Competitor",
        "id": "892399625",
        "url": "http://account1.example.org/competitors/892399625",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/competitors/892399625"
      }
    },
    {
      "id": "340318108",
      "body": "This feature is integrated",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/340318108",
      "resource": "http://account1.example.org/api/v1/comments/340318108",
      "commentable": {
        "type": "Feature",
        "id": "303873333",
        "url": "http://account1.example.org/features/PRJ1-3",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/features/PRJ1-3"
      }
    },
    {
      "id": "971503243",
      "body": "This is a requirement comment",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/971503243",
      "resource": "http://account1.example.org/api/v1/comments/971503243",
      "commentable": {
        "type": "Requirement",
        "id": "483368544",
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1"
      }
    }
  ],
  "pagination": {
    "total_records": 9,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features/:feature_id/comments

Get all comments on a feature

Parameters

Name Description
feature_id * Numeric ID of the feature to get comments for

GET /api/v1/features/1007868956/comments

Example CURL command

curl -g "https://account1.aha.io/api/v1/features/1007868956/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [
    {
      "id": "781701978",
      "body": "Comment on feature",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/781701978",
      "resource": "http://account1.example.org/api/v1/comments/781701978",
      "commentable": {
        "type": "Feature",
        "id": "1007868956",
        "url": "http://account1.example.org/features/PRJ1-1",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/requirements/:requirement_id/comments

Get all comments on a requirement

Parameters

Name Description
requirement_id * Numeric ID of the requirement to get comments for

GET /api/v1/requirements/483368544/comments

Example CURL command

curl -g "https://account1.aha.io/api/v1/requirements/483368544/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [
    {
      "id": "971503243",
      "body": "This is a requirement comment",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/971503243",
      "resource": "http://account1.example.org/api/v1/comments/971503243",
      "commentable": {
        "type": "Requirement",
        "id": "483368544",
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas/:idea_id/comments

Get all comments on an idea

Parameters

Name Description
idea_id * Numeric ID of the idea to get comments for

GET /api/v1/ideas/58056975/comments

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/58056975/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [

  ],
  "pagination": {
    "total_records": 0,
    "total_pages": 0,
    "current_page": 1
  }
}

GET /api/v1/initiatives/:initiative_id/comments

Get all comments on an initiative

Parameters

Name Description
initiative_id * Numeric ID of the initiative to get comments for

GET /api/v1/initiatives/423077122/comments

Example CURL command

curl -g "https://account1.aha.io/api/v1/initiatives/423077122/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [
    {
      "id": "133461614",
      "body": "Comment on initiative",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "601067208",
        "name": "Jeremy Smith",
        "email": "jeremy.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/133461614",
      "resource": "http://account1.example.org/api/v1/comments/133461614",
      "commentable": {
        "type": "Initiative",
        "id": "423077122",
        "url": "http://account1.example.org/initiatives/423077122",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/initiatives/423077122"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/goals/:goal_id/comments

Get all comments on a goal

Parameters

Name Description
goal_id * Numeric ID of the goal to get comments for

GET /api/v1/goals/602095703/comments

Example CURL command

curl -g "https://account1.aha.io/api/v1/goals/602095703/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [
    {
      "id": "821249787",
      "body": "Comment on goal",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "user": {
        "id": "601067208",
        "name": "Jeremy Smith",
        "email": "jeremy.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "attachments": [

      ],
      "url": "http://account1.example.org/comments/821249787",
      "resource": "http://account1.example.org/api/v1/comments/821249787",
      "commentable": {
        "type": "StrategicImperative",
        "id": "602095703",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "product_id": 131414752,
        "resource": "http://account1.example.org/api/v1/goals/602095703"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

DELETE /api/v1/comments/:id

Delete comment

Parameters

Name Description
id * Numeric ID of the comment to be deleted

DELETE /api/v1/comments/55160124

Example CURL command

curl "https://account1.aha.io/api/v1/comments/55160124" -d '' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Competitors API


GET /api/v1/products/:product_id/competitors

Get a list of all of the competitors in a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve competitors for

GET /api/v1/products/PRJ1/competitors

Example CURL command

curl -g "https://account1.aha.io/api/v1/products/PRJ1/competitors" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "competitors": [
    {
      "id": "457085224",
      "name": "JIRA",
      "created_at": "2018-07-20T18:31:42.000Z"
    },
    {
      "id": "892399625",
      "name": "ProductPlan",
      "created_at": "2018-07-20T18:31:42.000Z"
    },
    {
      "id": "741974453",
      "name": "Roadmunk",
      "created_at": "2018-07-20T18:31:42.000Z"
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/competitors/:id

Get specific competitor

Parameters

Name Description
id * Numeric ID of the competitor to be retrieved

GET /api/v1/competitors/892399625

Example CURL command

curl -g "https://account1.aha.io/api/v1/competitors/892399625" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "persona": {
    "id": "892399625",
    "name": "ProductPlan",
    "color": 29647,
    "created_at": "2018-07-20T18:31:42.000Z",
    "updated_at": "2018-07-20T18:31:42.000Z",
    "url": "http://account1.example.org/competitors/892399625",
    "resource": "http://account1.example.org/competitors/892399625",
    "custom_fields": [

    ],
    "comments_count": 1
  }
}

GET /api/v1/competitors

Search for competitors by name

Parameters

Name Description
q Sub-string to match against competitor name

GET /api/v1/competitors?q=Roadmunk

Example CURL command

curl -g "https://account1.aha.io/api/v1/competitors?q=Roadmunk" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "competitors": [
    {
      "id": "741974453",
      "name": "Roadmunk",
      "created_at": "2018-07-20T18:31:42.000Z"
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

POST /api/v1/products/:product_id/competitors

Create a competitor

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the competitor in
name * Name of the competitor
color * Hex color of the competitor in the Aha! UI

POST /api/v1/products/PRJ1/competitors

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/competitors" -d '{"competitor":{"name":"Trello","color":29647}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "competitor": {
    "name": "Trello",
    "color": 29647
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "persona": {
    "id": "6580368845930477321",
    "name": "Trello",
    "color": 29647,
    "created_at": "2018-07-20T18:31:53.874Z",
    "updated_at": "2018-07-20T18:31:53.975Z",
    "url": "http://account1.example.org/competitors/6580368845930477321",
    "resource": "http://account1.example.org/competitors/6580368845930477321",
    "custom_fields": [

    ],
    "comments_count": 0
  }
}

PUT /api/v1/products/:product_id/competitors/:id

Update a competitor

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the competitor in
id * Numeric ID, or key of the competitor to be updated
name Name of the competitor
color Hex color of the competitor in the Aha! UI

PUT /api/v1/products/PRJ1/competitors/892399625

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/competitors/892399625" -d '{"competitor":{"name":"Julie"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "competitor": {
    "name": "Julie"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "persona": {
    "id": "892399625",
    "name": "Julie",
    "color": 29647,
    "created_at": "2018-07-20T18:31:42.000Z",
    "updated_at": "2018-07-20T18:31:54.336Z",
    "url": "http://account1.example.org/competitors/892399625",
    "resource": "http://account1.example.org/competitors/892399625",
    "custom_fields": [

    ],
    "comments_count": 1
  }
}

DELETE /api/v1/products/:product_id/competitors/:id

Delete competitor

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the competitor in
id * Numeric ID, or key of the competitor to be deleted

DELETE /api/v1/products/PRJ1/competitors/892399625

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/competitors/892399625" -d '' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Custom Object Links API


Resources that can be linked to records from a Custom Table (called custom objects in the API) can be manipulated in a bulk id-list format. To use Custom Objects Links you must first add a Many-to-Many custom field definition to the resource. When you pass the IDs of custom object records to link to the feature, the existing list of links will be replaced.

Examples of linking custom objects to resources with a Many-to-Many customer field:

Custom Tables are an Enterprise+ exclusive feature.

PUT /api/v1/products/:id

Link custom object records to a product

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the product to be edited

PUT /api/v1/products/PRJ1

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1" -d '{"product":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "product": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "product": {
    "id": "131414752",
    "reference_prefix": "PRJ1",
    "name": "Project 1",
    "product_line": false,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:31:55.808Z",
    "description": {
      "id": "21164619",
      "body": "",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "url": "http://account1.example.org/projects/PRJ1",
    "resource": "http://account1.example.org/projects/PRJ1",
    "children": [

    ],
    "custom_fields": [

    ],
    "screen_definitions": [
      {
        "id": 524951996,
        "screenable_type": "Project",
        "name": "Screen Definition 1",
        "custom_field_definitions": [
          {
            "id": 807801664,
            "key": "name",
            "position": 1,
            "name": "Name",
            "type": "CustomFieldDefinitions::TextField",
            "api_type": "string",
            "required": false,
            "options": [

            ]
          },
          {
            "id": 221120583,
            "key": "website",
            "position": 2,
            "name": "Website",
            "type": "CustomFieldDefinitions::UrlField",
            "api_type": "url",
            "required": false,
            "options": [

            ]
          }
        ]
      },
      {
        "id": 826556567,
        "screenable_type": "Competitor",
        "name": "Screen Definition 3",
        "custom_field_definitions": [

        ]
      },
      {
        "id": 647403809,
        "screenable_type": "Release",
        "name": "Screen Definition 8",
        "custom_field_definitions": [
          {
            "id": 3228193,
            "key": "release_custom_date",
            "position": 1,
            "name": "Release custom date",
            "type": "CustomFieldDefinitions::DateField",
            "api_type": "date",
            "required": false,
            "options": [

            ]
          }
        ]
      },
      {
        "id": 405267877,
        "screenable_type": "Ideas::Idea",
        "name": "Screen Definition 5",
        "custom_field_definitions": [
          {
            "id": 711072024,
            "key": "customers_table",
            "position": 1,
            "name": "Customers for custom table",
            "type": "CustomFieldDefinitions::LinkMany",
            "api_type": "array",
            "required": false,
            "options": [
              {
                "id": 1059223798,
                "label": "Acme Corp"
              }
            ]
          }
        ]
      },
      {
        "id": 908690576,
        "screenable_type": "Epic",
        "name": "Screen Definition 7",
        "custom_field_definitions": [
          {
            "id": 919440521,
            "key": "master_feature_custom_date",
            "position": 1,
            "name": "Master feature custom date",
            "type": "CustomFieldDefinitions::DateField",
            "api_type": "date",
            "required": false,
            "options": [

            ]
          }
        ]
      },
      {
        "id": 19837977,
        "screenable_type": "Feature",
        "name": "Screen Definition 6",
        "custom_field_definitions": [
          {
            "id": 141558949,
            "key": "customers_table",
            "position": 1,
            "name": "Customers for custom table",
            "type": "CustomFieldDefinitions::LinkMany",
            "api_type": "array",
            "required": false,
            "options": [

            ]
          }
        ]
      }
    ],
    "custom_object_links": [

    ],
    "has_ideas": true,
    "has_master_features": false,
    "epic_workflow": {
      "id": 499195972,
      "name": "Default features workflow",
      "statusable_type": "Feature",
      "workflow_type": "epic"
    },
    "feature_workflow": {
      "id": 499195972,
      "name": "Default features workflow",
      "statusable_type": "Feature",
      "workflow_type": "feature"
    },
    "initiative_workflow": {
      "id": 61191651,
      "name": "Default initiatives workflow",
      "statusable_type": "Initiative",
      "workflow_type": "initiative"
    },
    "idea_workflow": {
      "id": 80245244,
      "name": "Default ideas workflow",
      "statusable_type": "Idea",
      "workflow_type": "idea"
    },
    "release_workflow": {
      "id": 717623509,
      "name": "Default releases workflow",
      "statusable_type": "Release",
      "workflow_type": "release"
    },
    "strategic_imperative_workflow": {
      "id": 883066232,
      "name": "Default goals workflow",
      "statusable_type": "StrategicImperative",
      "workflow_type": "strategic_imperative"
    },
    "requirement_workflow": {
      "id": 499195972,
      "name": "Default features workflow",
      "statusable_type": "Feature",
      "workflow_type": "requirement"
    },
    "capacity_planning_enabled": false,
    "default_capacity_units": 10
  }
}

PUT /api/v1/releases/:id

Link custom object records to a release

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the release to be edited

PUT /api/v1/releases/PRJ1-R-1

Example CURL command

curl "https://account1.aha.io/api/v1/releases/PRJ1-R-1" -d '{"release":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "release": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release": {
    "id": "278327321",
    "product_id": 131414752,
    "reference_num": "PRJ1-R-1",
    "name": "Release 1",
    "start_date": "2018-07-27",
    "development_started_on": "2018-06-20",
    "release_date": "2018-07-27",
    "external_release_date": "2018-07-27",
    "external_release_date_description": "Jul 27, 2018",
    "external_date_resolution": "exact",
    "released": false,
    "parking_lot": false,
    "master_release": false,
    "created_at": "2018-07-20T18:31:42.000Z",
    "updated_at": "2018-07-20T18:31:42.000Z",
    "position": null,
    "theme": {
      "id": "522610666",
      "body": "Theme of the release",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "url": "http://account1.example.org/releases/PRJ1-R-1",
    "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
    "integration_fields": [
      {
        "id": "68217473",
        "name": "id",
        "value": "777",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "text_field",
        "name": "TextField",
        "value": "Acme Corp",
        "type": "string"
      },
      {
        "key": "note",
        "name": "Note",
        "id": "432637490",
        "body": "<p>sample text</p>",
        "created_at": "2018-07-20T18:31:42.000Z",
        "attachments": [

        ],
        "value": "<p>sample text</p>",
        "type": "note"
      }
    ],
    "custom_object_links": [

    ],
    "comments_count": 1,
    "workflow_status": {
      "id": "738862546",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "owner": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "initiatives": [
      {
        "id": "423077122",
        "name": "Initiative 1",
        "url": "http://account1.example.org/initiatives/423077122",
        "resource": "http://account1.example.org/api/v1/initiatives/423077122",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "1007208146",
          "body": "Description of project1_initiative1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "integration_fields": [
          {
            "id": "213995437",
            "name": "id",
            "value": "9913333",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "365436441",
            "name": "key",
            "value": "JRA-987222",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ]
      }
    ],
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    }
  }
}

PUT /api/v1/features/:id

Link custom object records to a feature

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the feature to be edited

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:31:56.930Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/fdd584bc79fbec9390cb43f55f63835a3b2ffe3d723aebc7f05b3bf6e8920841.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:31:57.044Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:56.979Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "custom_object_links": [
      {
        "key": "customers",
        "name": "Customers",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          640362830
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/ideas/:id

Link custom object records to an idea

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the idea to be edited

PUT /api/v1/ideas/PRJ1-I-1

Example CURL command

curl "https://account1.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "58056975",
    "name": "Idea 1",
    "reference_num": "PRJ1-I-1",
    "score": 15,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:31:57.707Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:57.730Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 1,
    "comments_count": 0,
    "score_facts": [
      {
        "id": "244026645",
        "value": 10,
        "name": "Effort"
      },
      {
        "id": "394452137",
        "value": 5,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/initiatives/:id

Link custom object records to an initiative

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the initiative to be edited

PUT /api/v1/initiatives/423077122

Example CURL command

curl "https://account1.aha.io/api/v1/initiatives/423077122" -d '{"initiative":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "initiative": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "initiative": {
    "id": "423077122",
    "name": "Initiative 1",
    "status": "not_started",
    "effort": 10,
    "value": 70,
    "presented": true,
    "start_date": "2018-06-20",
    "end_date": "2018-08-03",
    "position": 1,
    "created_at": "2018-07-20T18:31:42.000Z",
    "updated_at": "2018-07-20T18:31:42.000Z",
    "product_id": 131414752,
    "url": "http://account1.example.org/initiatives/423077122",
    "resource": "http://account1.example.org/api/v1/initiatives/423077122",
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "workflow_status": {
      "id": "53968949",
      "name": "Not Started",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "1007208146",
      "body": "Description of project1_initiative1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "comments_count": 1,
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "features": [
      {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
        "product_id": 131414752
      }
    ],
    "master_features": [
      {
        "id": "362457003",
        "reference_num": "PRJ1-E-3",
        "name": "And a third",
        "created_at": "2018-07-20T18:31:42.000Z",
        "url": "http://account1.example.org/epics/PRJ1-E-3",
        "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-3"
      },
      {
        "id": "580753216",
        "reference_num": "PRJ1-E-2",
        "name": "Here's another epic",
        "created_at": "2018-07-20T18:31:42.000Z",
        "url": "http://account1.example.org/epics/PRJ1-E-2",
        "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-2"
      },
      {
        "id": "999605892",
        "reference_num": "PRJ1-E-1",
        "name": "Epic 1",
        "created_at": "2018-07-20T18:31:42.000Z",
        "url": "http://account1.example.org/epics/PRJ1-E-1",
        "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
      }
    ],
    "releases": [
      {
        "id": "278327321",
        "reference_num": "PRJ1-R-1",
        "name": "Release 1",
        "start_date": "2018-07-27",
        "release_date": "2018-07-27",
        "parking_lot": false,
        "created_at": "2018-07-20T18:31:42.000Z",
        "product_id": 131414752,
        "integration_fields": [
          {
            "id": "68217473",
            "name": "id",
            "value": "777",
            "integration_id": 204584239,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "url": "http://account1.example.org/releases/PRJ1-R-1",
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "john.smith@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2018-07-20T18:31:43.000Z"
        }
      },
      {
        "id": "161456549",
        "reference_num": "PRJ1-R-2",
        "name": "Release 2",
        "start_date": "2018-06-20",
        "release_date": "2018-08-03",
        "parking_lot": false,
        "created_at": "2018-07-20T18:31:42.000Z",
        "product_id": 131414752,
        "integration_fields": [

        ],
        "url": "http://account1.example.org/releases/PRJ1-R-2",
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-2",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "john.smith@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2018-07-20T18:31:43.000Z"
        }
      }
    ],
    "integration_fields": [
      {
        "id": "213995437",
        "name": "id",
        "value": "9913333",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "365436441",
        "name": "key",
        "value": "JRA-987222",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/goals/:id

Link custom object records to a goal

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the goal to be edited

PUT /api/v1/goals/602095703

Example CURL command

curl "https://account1.aha.io/api/v1/goals/602095703" -d '{"goal":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "goal": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "goal": {
    "id": "602095703",
    "name": "Goal 1",
    "effort": 10,
    "value": 70,
    "position": 1,
    "created_at": "2018-07-20T18:31:42.000Z",
    "updated_at": "2018-07-20T18:31:42.000Z",
    "product_id": 131414752,
    "url": "http://account1.example.org/strategic_imperatives/602095703",
    "resource": "http://account1.example.org/strategic_imperatives/602095703",
    "description": {
      "id": "166463080",
      "body": "Description of goal 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "success_metric": {
      "name": "Metric 1",
      "description": {
        "id": "546284368",
        "body": "Description of goal 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      }
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "initiatives": [
      {
        "id": "423077122",
        "name": "Initiative 1",
        "url": "http://account1.example.org/initiatives/423077122",
        "resource": "http://account1.example.org/api/v1/initiatives/423077122",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "673273729",
          "body": "Description of initiative 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "integration_fields": [
          {
            "id": "365436441",
            "name": "key",
            "value": "JRA-987222",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "213995437",
            "name": "id",
            "value": "9913333",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ]
      }
    ],
    "comments_count": 1,
    "features": [
      {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
        "product_id": 131414752
      }
    ],
    "releases": [
      {
        "id": "278327321",
        "reference_num": "PRJ1-R-1",
        "name": "Release 1",
        "start_date": "2018-07-27",
        "release_date": "2018-07-27",
        "parking_lot": false,
        "created_at": "2018-07-20T18:31:42.000Z",
        "product_id": 131414752,
        "integration_fields": [
          {
            "id": "68217473",
            "name": "id",
            "value": "777",
            "integration_id": 204584239,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "url": "http://account1.example.org/releases/PRJ1-R-1",
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "john.smith@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2018-07-20T18:31:43.000Z"
        }
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/custom_object_records/:id

Link custom table records to another custom table record

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID of the custom object record to be updated

PUT /api/v1/custom_object_records/640362830

Example CURL command

curl "https://account1.aha.io/api/v1/custom_object_records/640362830" -d '{"custom_object_record":{"custom_object_links":{"custom_table_name_submitters":[136661093]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "custom_object_record": {
    "custom_object_links": {
      "custom_table_name_submitters": [
        136661093
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "custom_object_record": {
    "id": "640362830",
    "key": "customers",
    "custom_fields": [
      {
        "key": "website",
        "name": "Website",
        "value": "www.acme.com",
        "type": "url"
      },
      {
        "key": "name",
        "name": "Name",
        "value": "Acme Corp",
        "type": "string"
      }
    ],
    "custom_object_links": [
      {
        "key": "custom_table_name_link_many",
        "name": "Custom Table Linked Records",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          1059223798
        ]
      },
      {
        "key": "custom_table_name_submitters",
        "name": "Custom Table Linked Submitters",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          136661093
        ]
      }
    ]
  }
}

Custom Object Records API


Custom Tables have a different set of custom objects for each Product. This means that if you want to create one or list them you must scope them to a product.

Once you have the id of a specific custom object record, you can inspect, modify, or delete them on the root custom objects resource.

Custom Tables are an Enterprise+ exclusive feature.

POST /api/v1/products/:product_id/custom_objects/:key/records

Create a custom object record

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the record in
key * API key of the custom object type to create

POST /api/v1/products/PRJ1/custom_objects/customers/records

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/custom_objects/customers/records" -d '{"custom_object_record":{"custom_fields":{"name":"Major conglomerate","website":"www.conglom.com"}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "custom_object_record": {
    "custom_fields": {
      "name": "Major conglomerate",
      "website": "www.conglom.com"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "custom_object_record": {
    "id": "6580368870975025803",
    "key": "customers",
    "custom_fields": [
      {
        "key": "website",
        "name": "Website",
        "value": "www.conglom.com",
        "type": "url"
      },
      {
        "key": "name",
        "name": "Name",
        "value": "Major conglomerate",
        "type": "string"
      }
    ],
    "custom_object_links": [
      {
        "key": "custom_table_name_link_many",
        "name": "Custom Table Linked Records",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      },
      {
        "key": "custom_table_name_submitters",
        "name": "Custom Table Linked Submitters",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      }
    ]
  }
}

GET /api/v1/products/:product_id/custom_objects/:key/records

Get all objects from a custom table

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
product_id * Numeric ID, or key of the product to get page for
key * API key of the custom object to get records for

GET /api/v1/products/PRJ1/custom_objects/customers/records

Example CURL command

curl -g "https://account1.aha.io/api/v1/products/PRJ1/custom_objects/customers/records" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "custom_object_records": [
    {
      "id": "640362830",
      "key": "customers",
      "custom_fields": [
        {
          "key": "website",
          "name": "Website",
          "value": "www.acme.com",
          "type": "url"
        },
        {
          "key": "name",
          "name": "Name",
          "value": "Acme Corp",
          "type": "string"
        }
      ],
      "custom_object_links": [
        {
          "key": "custom_table_name_link_many",
          "name": "Custom Table Linked Records",
          "record_type": "CustomObjectRecord",
          "record_ids": [
            1059223798
          ]
        },
        {
          "key": "custom_table_name_submitters",
          "name": "Custom Table Linked Submitters",
          "record_type": "CustomObjectRecord",
          "record_ids": [

          ]
        }
      ]
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/custom_object_records/:id

Get a specific custom object record

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID of the custom object record to be retrieved

GET /api/v1/custom_object_records/640362830

Example CURL command

curl -g "https://account1.aha.io/api/v1/custom_object_records/640362830" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "custom_object_record": {
    "id": "640362830",
    "key": "customers",
    "custom_fields": [
      {
        "key": "website",
        "name": "Website",
        "value": "www.acme.com",
        "type": "url"
      },
      {
        "key": "name",
        "name": "Name",
        "value": "Acme Corp",
        "type": "string"
      }
    ],
    "custom_object_links": [
      {
        "key": "custom_table_name_link_many",
        "name": "Custom Table Linked Records",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          1059223798
        ]
      },
      {
        "key": "custom_table_name_submitters",
        "name": "Custom Table Linked Submitters",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      }
    ]
  }
}

PUT /api/v1/custom_object_records/:id

Update a custom object record

Parameters

Name Description
id * Numeric ID of the custom object record to be updated

PUT /api/v1/custom_object_records/640362830

Example CURL command

curl "https://account1.aha.io/api/v1/custom_object_records/640362830" -d '{"custom_object_record":{"custom_fields":{"name":"Acme parent corp","website":"www.acmeparent.com"}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "custom_object_record": {
    "custom_fields": {
      "name": "Acme parent corp",
      "website": "www.acmeparent.com"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "custom_object_record": {
    "id": "640362830",
    "key": "customers",
    "custom_fields": [
      {
        "key": "website",
        "name": "Website",
        "value": "www.acmeparent.com",
        "type": "url"
      },
      {
        "key": "name",
        "name": "Name",
        "value": "Acme parent corp",
        "type": "string"
      }
    ],
    "custom_object_links": [
      {
        "key": "custom_table_name_link_many",
        "name": "Custom Table Linked Records",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          1059223798
        ]
      },
      {
        "key": "custom_table_name_submitters",
        "name": "Custom Table Linked Submitters",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      }
    ]
  }
}

DELETE /api/v1/custom_object_records/:id

Delete a custom object record

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID of the custom object record to be deleted

DELETE /api/v1/custom_object_records/640362830

Example CURL command

curl "https://account1.aha.io/api/v1/custom_object_records/640362830" -d '' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Custom Pivot API


The custom pivots API allows you to take existing list and pivot reports and represent them as JSON. This enables developers to pull related data from multiple types of records in a single API query.

There are two types of reports that you can pull via this API: list or pivot. See the documentation below for a full explanation of their formats.

The :report_id parameter is the ID of a saved view in Aha!. To find the ID of an existing report, choose the report from the Views -> Saved views dropdown in Aha!. Then take the large number of the end of the URL that looks like: /bookmarks/custom_pivots/6434552458299516367. In this case the :report_id is 6434552458299516367.

GET /api/v1/bookmarks/custom_pivots/:report_id

List view

The list view responds with a JSON object with three attributes: pagination, columns, and rows.

The columns attribute is an array of objects that give detailed information about the columns of the list. The objects include the name of the table, the field, and a human readable title attribute.

The rows attribute is an of array of arrays. Each object within the inner array contains the value of that for a specific column. Each object contains attributes for various representations of the data. The fields are:

  • id: The unique id of the object
  • plain_value: A string representation of the object
  • html_value: An HTML representation of the object. This is the same HTML that is used in Aha! to represent the value in our reports.
  • rich_value: If the object is a reference to another object (such as a tag), the, this will be the object representation. For instance, a tag would be representated as: { id: "6013053275679792248", name: "API" }

The third attribute is pagination. This works like everywhere else in the Aha! API and is documented here.

Parameters

Name Description
report_id The ID of the saved view in Aha! to return data for.
view The type of API response you want. This should either be list or pivot. It defaults to list

GET /api/v1/bookmarks/custom_pivots/801750833?view=list

Example CURL command

curl -g "https://account1.aha.io/api/v1/bookmarks/custom_pivots/801750833?view=list" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "pagination": [
    {
      "total_records": 4,
      "total_pages": 1,
      "current_page": 1
    }
  ],
  "columns": [
    {
      "table": "projects",
      "field": "name",
      "title": "Product name"
    },
    {
      "table": "releases",
      "field": "name",
      "title": "Release name"
    },
    {
      "table": "features",
      "field": "name",
      "title": "Feature name"
    },
    {
      "table": "features",
      "field": "reference_num",
      "title": "Feature reference #"
    },
    {
      "table": "features",
      "field": "status",
      "title": "Feature status"
    },
    {
      "table": "ideas",
      "field": "created_by_user_id",
      "title": "Idea created by"
    }
  ],
  "rows": [
    [
      {
        "id": 131414752,
        "plain_value": "Project 1",
        "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
        "rich_value": "Project 1"
      },
      {
        "id": 278327321,
        "plain_value": "Release 1",
        "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
        "rich_value": "Release 1"
      },
      {
        "id": 303873333,
        "plain_value": "Another Third Feature",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-3\" href=\"/features/PRJ1-3\">Another Third Feature</a>",
        "rich_value": "Another Third Feature"
      },
      {
        "id": 303873333,
        "plain_value": "PRJ1-3",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-3\" href=\"/features/PRJ1-3\">PRJ1-3</a>",
        "rich_value": "PRJ1-3"
      },
      {
        "id": 303873333,
        "plain_value": "Designed",
        "html_value": "<span class=\"status-pill\" style=\"border-color: #ecdd8f; background-color: #f7f1d2; color: #5e5839;\">Designed</span>",
        "rich_value": {
          "id": 962984386,
          "name": "Designed",
          "color": "727272"
        }
      },
      {
        "id": null,
        "plain_value": null,
        "html_value": null,
        "rich_value": null
      }
    ],
    [
      {
        "id": 131414752,
        "plain_value": "Project 1",
        "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
        "rich_value": "Project 1"
      },
      {
        "id": 278327321,
        "plain_value": "Release 1",
        "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
        "rich_value": "Release 1"
      },
      {
        "id": 622562724,
        "plain_value": "Another Feature",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-2\" href=\"/features/PRJ1-2\">Another Feature</a>",
        "rich_value": "Another Feature"
      },
      {
        "id": 622562724,
        "plain_value": "PRJ1-2",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-2\" href=\"/features/PRJ1-2\">PRJ1-2</a>",
        "rich_value": "PRJ1-2"
      },
      {
        "id": 622562724,
        "plain_value": "Designed",
        "html_value": "<span class=\"status-pill\" style=\"border-color: #ecdd8f; background-color: #f7f1d2; color: #5e5839;\">Designed</span>",
        "rich_value": {
          "id": 962984386,
          "name": "Designed",
          "color": "727272"
        }
      },
      {
        "id": null,
        "plain_value": null,
        "html_value": null,
        "rich_value": null
      }
    ],
    [
      {
        "id": 131414752,
        "plain_value": "Project 1",
        "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
        "rich_value": "Project 1"
      },
      {
        "id": 278327321,
        "plain_value": "Release 1",
        "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
        "rich_value": "Release 1"
      },
      {
        "id": 1007868956,
        "plain_value": "Feature 1",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">Feature 1</a>",
        "rich_value": "Feature 1"
      },
      {
        "id": 1007868956,
        "plain_value": "PRJ1-1",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">PRJ1-1</a>",
        "rich_value": "PRJ1-1"
      },
      {
        "id": 1007868956,
        "plain_value": "New",
        "html_value": "<span class=\"status-pill\" style=\"border-color: #dce7c6; background-color: #f1f5e8; color: #585c4f;\">New</span>",
        "rich_value": {
          "id": 934242751,
          "name": "New",
          "color": "727272"
        }
      },
      {
        "id": 444379319,
        "plain_value": "John Long (john@long.com)",
        "html_value": "John Long (john@long.com)",
        "rich_value": {
          "id": 646391926,
          "name": "John Long (john@long.com)"
        }
      }
    ],
    [
      {
        "id": 131414752,
        "plain_value": "Project 1",
        "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
        "rich_value": "Project 1"
      },
      {
        "id": 278327321,
        "plain_value": "Release 1",
        "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
        "rich_value": "Release 1"
      },
      {
        "id": 1007868956,
        "plain_value": "Feature 1",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">Feature 1</a>",
        "rich_value": "Feature 1"
      },
      {
        "id": 1007868956,
        "plain_value": "PRJ1-1",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">PRJ1-1</a>",
        "rich_value": "PRJ1-1"
      },
      {
        "id": 1007868956,
        "plain_value": "New",
        "html_value": "<span class=\"status-pill\" style=\"border-color: #dce7c6; background-color: #f1f5e8; color: #585c4f;\">New</span>",
        "rich_value": {
          "id": 934242751,
          "name": "New",
          "color": "727272"
        }
      },
      {
        "id": 1055237874,
        "plain_value": "John Long (john@long.com)",
        "html_value": "John Long (john@long.com)",
        "rich_value": {
          "id": 646391926,
          "name": "John Long (john@long.com)"
        }
      }
    ]
  ]
}

GET /api/v1/bookmarks/custom_pivots/:report_id

Pivot view

The pivot view is similar to the list view, but is more referential. There are six attributes in the JSON response: top_level_columns, columns, top_level_rows, rows, cells, field_definitions.

The columns attribute is an object where the keys are the unique id of column within the report. Rows and field_definitions have the same referential treamtment. The attributes are the id in order to ease lookup.

Since pivot reports are referential in nature and can be nested, there are top_level_rows and top_level_columns. This allows you to easily iterate throught the nested structure. Each column and row object contain a reference to their parent object (parent_ref). They also contain a set of references to their direct children (child_refs). They also, along with cells, contain a reference to their field definition (via field_definitions_refs).

The field definitions object is an object that acts as a map to look up the definitions of the fields used within the report. Similarly to the list view, these contain table, field, and title attributes.

The cells attribute is a set of nested arrays. The lowest level array is a list of the fields for a specific value. Each element in this set has a row_ref, column_ref, and field_definition_ref which can be used to lookup which column and row this value is representing. Just like the list view, there are multiple formats of the value:

  • id: The unique id of the object
  • plain_value: A string representation of the object
  • html_value: An HTML representation of the object. This is the same HTML that is used in Aha! to represent the value in our reports.
  • rich_value: If the object is a reference to another object (such as a tag), the, this will be the object representation.

There is no pagination with pivot report.

Parameters

Name Description
report_id The ID of the saved view in Aha! to return data for.
view The type of API response you want. This should either be list or pivot. It defaults to list

GET /api/v1/bookmarks/custom_pivots/801750833?view=pivot

Example CURL command

curl -g "https://account1.aha.io/api/v1/bookmarks/custom_pivots/801750833?view=pivot" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "top_level_columns": [
    1
  ],
  "columns": {
    "1": {
      "ref": 1,
      "parent_ref": null,
      "child_refs": [

      ],
      "id": 131414752,
      "plain_value": "Project 1",
      "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
      "rich_value": "Project 1",
      "field_definition_ref": 3
    }
  },
  "top_level_rows": [
    2
  ],
  "rows": {
    "2": {
      "ref": 2,
      "parent_ref": null,
      "child_refs": [

      ],
      "id": 278327321,
      "plain_value": "Release 1",
      "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
      "rich_value": "Release 1",
      "field_definition_ref": 4
    }
  },
  "cells": [
    [
      [
        [
          {
            "id": 1007868956,
            "plain_value": "PRJ1-1",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">PRJ1-1</a>",
            "rich_value": "PRJ1-1",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 5
          },
          {
            "id": 1007868956,
            "plain_value": "Feature 1",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">Feature 1</a>",
            "rich_value": "Feature 1",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 6
          },
          {
            "id": 1007868956,
            "plain_value": "New",
            "html_value": "<span class=\"status-pill\" style=\"border-color: #dce7c6; background-color: #f1f5e8; color: #585c4f;\">New</span>",
            "rich_value": {
              "id": 934242751,
              "name": "New",
              "color": "727272"
            },
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 7
          },
          {
            "id": 1055237874,
            "plain_value": "John Long (john@long.com)",
            "html_value": "John Long (john@long.com)",
            "rich_value": {
              "id": 646391926,
              "name": "John Long (john@long.com)"
            },
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 8
          }
        ],
        [
          {
            "id": 622562724,
            "plain_value": "PRJ1-2",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-2\" href=\"/features/PRJ1-2\">PRJ1-2</a>",
            "rich_value": "PRJ1-2",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 5
          },
          {
            "id": 622562724,
            "plain_value": "Another Feature",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-2\" href=\"/features/PRJ1-2\">Another Feature</a>",
            "rich_value": "Another Feature",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 6
          },
          {
            "id": 622562724,
            "plain_value": "Designed",
            "html_value": "<span class=\"status-pill\" style=\"border-color: #ecdd8f; background-color: #f7f1d2; color: #5e5839;\">Designed</span>",
            "rich_value": {
              "id": 962984386,
              "name": "Designed",
              "color": "727272"
            },
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 7
          },
          {
            "id": null,
            "plain_value": null,
            "html_value": null,
            "rich_value": null,
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 8
          }
        ],
        [
          {
            "id": 303873333,
            "plain_value": "PRJ1-3",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-3\" href=\"/features/PRJ1-3\">PRJ1-3</a>",
            "rich_value": "PRJ1-3",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 5
          },
          {
            "id": 303873333,
            "plain_value": "Another Third Feature",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-3\" href=\"/features/PRJ1-3\">Another Third Feature</a>",
            "rich_value": "Another Third Feature",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 6
          },
          {
            "id": 303873333,
            "plain_value": "Designed",
            "html_value": "<span class=\"status-pill\" style=\"border-color: #ecdd8f; background-color: #f7f1d2; color: #5e5839;\">Designed</span>",
            "rich_value": {
              "id": 962984386,
              "name": "Designed",
              "color": "727272"
            },
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 7
          },
          {
            "id": null,
            "plain_value": null,
            "html_value": null,
            "rich_value": null,
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 8
          }
        ]
      ]
    ]
  ],
  "field_definitions": {
    "3": {
      "ref": 3,
      "table": "projects",
      "field": "name",
      "title": "Product name"
    },
    "4": {
      "ref": 4,
      "table": "releases",
      "field": "name",
      "title": "Release name"
    },
    "5": {
      "ref": 5,
      "table": "features",
      "field": "reference_num",
      "title": "Feature reference #"
    },
    "6": {
      "ref": 6,
      "table": "features",
      "field": "name",
      "title": "Feature name"
    },
    "7": {
      "ref": 7,
      "table": "features",
      "field": "status",
      "title": "Feature status"
    },
    "8": {
      "ref": 8,
      "table": "ideas",
      "field": "created_by_user_id",
      "title": "Idea created by"
    }
  }
}

Features API


Features belong to Releases. This means that if you want to create one you must scope them to a release.

You can list them all at once, or filter by release , product , or master feature. All these means of listing features can be further filtered by specific critera like name, modification date, tag, or assignee.

Once you have the id of a specific feature, you can inspect, modify, or delete them on the root features resource.

POST /api/v1/releases/:release_id/features

Create a feature

When creating a feature at least the name, workflow_kind and workflow_status must be specified.

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://account1.aha.io/api/v1/releases/PRJ1-R-1/features" -d '{"feature":{"name":"New name","workflow_kind":"new","workflow_status":{"name":"Designed"},"description":"\u003cp\u003eThis is the description\u003c/p\u003e","assigned_to_user":{"email":"henry.humpty@account1.com"}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New name",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "description": "<p>This is the description</p>",
    "assigned_to_user": {
      "email": "henry.humpty@account1.com"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6580368911284713699",
    "name": "New name",
    "reference_num": "PRJ1-3",
    "position": 1,
    "score": 2,
    "created_at": "2018-07-20T18:32:09.092Z",
    "updated_at": "2018-07-20T18:32:09.176Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6580368911357515315",
      "body": "<p>This is the description</p>",
      "created_at": "2018-07-20T18:32:09.109Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://account1.example.org/features/PRJ1-3",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

POST /api/v1/releases/:release_id/features

Create a feature with assignee

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://account1.aha.io/api/v1/releases/PRJ1-R-1/features" -d '{"feature":{"name":"New feature","workflow_kind":"new","workflow_status":{"name":"Designed"},"assigned_to_user":"henry.humpty@account1.com"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New feature",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "assigned_to_user": "henry.humpty@account1.com"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6580368912791655172",
    "name": "New feature",
    "reference_num": "PRJ1-3",
    "position": 1,
    "score": 2,
    "created_at": "2018-07-20T18:32:09.442Z",
    "updated_at": "2018-07-20T18:32:09.527Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6580368912921408720",
      "body": "",
      "created_at": "2018-07-20T18:32:09.473Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://account1.example.org/features/PRJ1-3",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

POST /api/v1/releases/:release_id/features

Create a feature with tags

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://account1.aha.io/api/v1/releases/PRJ1-R-1/features" -d '{"feature":{"name":"New feature","workflow_kind":"new","workflow_status":{"name":"Designed"},"tags":"tag1, tag2"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New feature",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "tags": "tag1, tag2"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6580368915584484953",
    "name": "New feature",
    "reference_num": "PRJ1-3",
    "position": 1,
    "score": 2,
    "created_at": "2018-07-20T18:32:10.095Z",
    "updated_at": "2018-07-20T18:32:10.174Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6580368915661327558",
      "body": "",
      "created_at": "2018-07-20T18:32:10.111Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://account1.example.org/features/PRJ1-3",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": true
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [
      "tag1",
      "tag2"
    ],
    "full_tags": [
      {
        "id": "6580368915484475521",
        "name": "tag1",
        "color": "#52e077"
      },
      {
        "id": "6580368915506392271",
        "name": "tag2",
        "color": "#52d3e0"
      }
    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

POST /api/v1/releases/:release_id/features

Create a feature with watchers

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://account1.aha.io/api/v1/releases/PRJ1-R-1/features" -d '{"fields":"*,watchers","feature":{"name":"New feature","workflow_kind":"new","workflow_status":{"name":"Designed"},"watchers":"689956296,16338845"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "fields": "*,watchers",
  "feature": {
    "name": "New feature",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "watchers": "689956296,16338845"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6580368918906696188",
    "name": "New feature",
    "reference_num": "PRJ1-3",
    "position": 1,
    "score": 2,
    "created_at": "2018-07-20T18:32:10.866Z",
    "updated_at": "2018-07-20T18:32:10.983Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6580368919125283748",
      "body": "",
      "created_at": "2018-07-20T18:32:10.917Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://account1.example.org/features/PRJ1-3",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": true
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null,
    "watchers": [
      {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "689956296",
        "name": "Henry Humpty",
        "email": "henry.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      }
    ]
  }
}

POST /api/v1/releases/:release_id/features

Create a feature with goals

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://account1.aha.io/api/v1/releases/PRJ1-R-1/features" -d '{"fields":"*,goals","feature":{"name":"New feature","workflow_kind":"new","workflow_status":{"name":"Designed"},"goals":"602095703,988418543"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "fields": "*,goals",
  "feature": {
    "name": "New feature",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "goals": "602095703,988418543"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6580368920628183743",
    "name": "New feature",
    "reference_num": "PRJ1-3",
    "position": 1,
    "score": 2,
    "created_at": "2018-07-20T18:32:11.269Z",
    "updated_at": "2018-07-20T18:32:11.381Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6580368920713884445",
      "body": "",
      "created_at": "2018-07-20T18:32:11.290Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://account1.example.org/features/PRJ1-3",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": true
    },
    "requirements": [

    ],
    "goals": [
      {
        "id": "988418543",
        "name": "Goal 2",
        "url": "http://account1.example.org/strategic_imperatives/988418543",
        "resource": "http://account1.example.org/api/v1/goals/988418543",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "1055602421",
          "body": "Description of goal 2",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      },
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

POST /api/v1/releases/:release_id/features

Create a feature with a score

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://account1.aha.io/api/v1/releases/PRJ1-R-1/features" -d '{"feature":{"name":"New feature","workflow_kind":"new","workflow_status":{"name":"Designed"},"score_facts":[{"name":"Benefit","value":12},{"name":"Effort","value":-3}]}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New feature",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "score_facts": [
      {
        "name": "Benefit",
        "value": 12
      },
      {
        "name": "Effort",
        "value": -3
      }
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6580368922443282226",
    "name": "New feature",
    "reference_num": "PRJ1-3",
    "position": 1,
    "score": 9,
    "created_at": "2018-07-20T18:32:11.693Z",
    "updated_at": "2018-07-20T18:32:11.796Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6580368922597381979",
      "body": "",
      "created_at": "2018-07-20T18:32:11.724Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://account1.example.org/features/PRJ1-3",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": true
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [
      {
        "id": "6580368922793187852",
        "value": -3,
        "name": "Effort"
      },
      {
        "id": "6580368922536272064",
        "value": 12,
        "name": "Benefit"
      }
    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

POST /api/v1/products/:product_id/features

Create a feature in the default release

Parameters

Name Alias Description
product_id * Numeric ID, or key of the product the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

POST /api/v1/products/PRJ1/features

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/features" -d '{"feature":{"name":"New name","workflow_kind":"new","workflow_status":{"name":"Designed"}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New name",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6580368924212877487",
    "name": "New name",
    "reference_num": "PRJ1-3",
    "position": 1,
    "score": 2,
    "created_at": "2018-07-20T18:32:12.099Z",
    "updated_at": "2018-07-20T18:32:12.188Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6580368924330951880",
      "body": "",
      "created_at": "2018-07-20T18:32:12.127Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://account1.example.org/features/PRJ1-3",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
    "release": {
      "id": "292454904",
      "reference_num": "PRJ1-MR-1",
      "name": "Master Release 1",
      "start_date": "2018-06-20",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [

      ],
      "url": "http://account1.example.org/master_releases/PRJ1-MR-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-MR-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": true
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

GET /api/v1/features

Get all features

Parameters

Name Description
q Sub-string to match against feature name or ID

GET /api/v1/features?q=fea

Example CURL command

curl -g "https://account1.aha.io/api/v1/features?q=fea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-3",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-2",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/master_features/:master_feature_id/features

Get all features for a master feature

Parameters

Name Description
master_feature_id * Numeric ID, or key of the master feature to retrieve features for

GET /api/v1/master_features/PRJ1-E-1/features

Example CURL command

curl -g "https://account1.aha.io/api/v1/master_features/PRJ1-E-1/features" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/releases/:release_id/features

Get all features for a release

Parameters

Name Description
release_id * Numeric ID, or key of the release to retrieve features for

GET /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl -g "https://account1.aha.io/api/v1/releases/PRJ1-R-1/features" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-3",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-2",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/products/:product_id/features

Get all features for a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve features for

GET /api/v1/products/PRJ1/features

Example CURL command

curl -g "https://account1.aha.io/api/v1/products/PRJ1/features" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-3",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-2",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/goals/:goal_id/features

Get all features associated with a goal

Parameters

Name Description
goal_id * Numeric ID of the goal to get features for

GET /api/v1/goals/602095703/features

Example CURL command

curl -g "https://account1.aha.io/api/v1/goals/602095703/features" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/initiatives/:initiative_id/features

Get all features associated with an initiative

Parameters

Name Description
initiative_id * Numeric ID of the initiative to get features for

GET /api/v1/initiatives/423077122/features

Example CURL command

curl -g "https://account1.aha.io/api/v1/initiatives/423077122/features" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features

Search features by name or ID

Parameters

Name Description
q Sub-string to match against feature name or ID

GET /api/v1/features?q=fea

Example CURL command

curl -g "https://account1.aha.io/api/v1/features?q=fea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-3",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-2",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/products/:product_id/features

Search product for features by name or ID

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve features for
q Sub-string to match against feature name or ID

GET /api/v1/products/PRJ1/features?q=fea

Example CURL command

curl -g "https://account1.aha.io/api/v1/products/PRJ1/features?q=fea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-3",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-2",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/releases/:release_id/features

Search release for features by name or ID

Parameters

Name Description
release_id * Numeric ID, or key of the release to retrieve features for
q Sub-string to match against feature name or ID

GET /api/v1/releases/PRJ1-R-1/features?q=fea

Example CURL command

curl -g "https://account1.aha.io/api/v1/releases/PRJ1-R-1/features?q=fea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-3",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-2",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features

Search features by modification date

Parameters

Name Description
updated_since UTC timestamp (in ISO8601 format) that the updated_at field must be larger than.

GET /api/v1/features?updated_since=2014-06-01T22%3A43%3A42Z

Example CURL command

curl -g "https://account1.aha.io/api/v1/features?updated_since=2014-06-01T22%3A43%3A42Z" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-3",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-2",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features

Search features by tag

Parameters

Name Description
tag A string tag value.

GET /api/v1/features?tag=Infrastructure

Example CURL command

curl -g "https://account1.aha.io/api/v1/features?tag=Infrastructure" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features

Search features by assignee

Parameters

Name Description
assigned_to_user The ID or email address of user to return assigned features for.

GET /api/v1/features?assigned_to_user=john.smith%40account1.com

Example CURL command

curl -g "https://account1.aha.io/api/v1/features?assigned_to_user=john.smith%40account1.com" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "url": "http://account1.example.org/features/PRJ1-1",
      "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features/:id

Get a specific feature

Parameters

Name Description
id * Numeric ID, or key of the feature to be retrieved

GET /api/v1/features/PRJ1-1

Example CURL command

curl -g "https://account1.aha.io/api/v1/features/PRJ1-1" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:31:43.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/14879fc2e0b290f0f5eb8b46e635a74a8e34f71c516c5906eb84e25ee0254361.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:15.494Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"name":"New name","description":"New description"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New name",
    "description": "New description"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "New name",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:32:16.427Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "New description",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/b9adb11ecdfd8cce4ce255d8e549c1de8e0e16d8a205b6f4de878049ac6ca796.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:16.508Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "New name",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "New name",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's custom fields

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"custom_fields":{"priority":"P3"}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "custom_fields": {
      "priority": "P3"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:32:17.085Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/5447c9a22a6d3a9bd2a6aa5be3572eaad34ddee670e7bd325e3f1c94dd041f55.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:17.143Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "priority",
        "name": "Priority",
        "value": "P3",
        "type": "string"
      },
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's custom fields with tag-like value

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"custom_fields":{"tags":["tag2","tag,3"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "custom_fields": {
      "tags": [
        "tag2",
        "tag,3"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:32:17.638Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/73e70b5353f698661aab788aea33cb354d48b23e95a87f4acd0ba2e69d9a93f9.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:17.684Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "tags",
        "name": "Tags",
        "value": [
          "tag2",
          "tag,3"
        ],
        "type": "array"
      },
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's tags with comma-separated values

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"tags":"tag2, tag3"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "tags": "tag2, tag3"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:32:18.099Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/930bdc366993cb3a83fccaef3531786865bef3d7ab20f0ee6363ce168090249d.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:18.163Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "tag2",
      "tag3"
    ],
    "full_tags": [
      {
        "id": "6580368949743219196",
        "name": "tag2",
        "color": "#52d3e0"
      },
      {
        "id": "6580368949761673635",
        "name": "tag3",
        "color": "#bb52e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's tags with an array

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"tags":["tag2","tag3"]}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "tags": [
      "tag2",
      "tag3"
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:32:18.572Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/a323e090ab29982b0532efb1a556683b4bf26278e511a5247005ed9d6e52277d.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:18.635Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "tag2",
      "tag3"
    ],
    "full_tags": [
      {
        "id": "6580368951766436086",
        "name": "tag2",
        "color": "#52d3e0"
      },
      {
        "id": "6580368951795267280",
        "name": "tag3",
        "color": "#bb52e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's watchers

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"watchers":[689956296]}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "watchers": [
      689956296
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:32:19.437Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/d51c6da0e37b11ea511f4e17e151ff7553483dbd8d5b6c380fd873e66145d6d4.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:19.485Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's goals

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"goals":[602095703]}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "goals": [
      602095703
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:31:43.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/d86c5b6bf041f9d0e8ae709296e3e7371326def2ae004c7def61080a92b86ba4.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:19.911Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's score

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"score_facts":[{"name":"Benefit","value":4},{"name":"Effort","value":-5}]}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "score_facts": [
      {
        "name": "Benefit",
        "value": 4
      },
      {
        "name": "Effort",
        "value": -5
      }
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": -1,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:32:20.344Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/4d4d2728d6d7ed0640857a6cd95fb75b9689d25e2147e5509c7ae88496d3be25.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:20.405Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "6580368959535904405",
        "value": -5,
        "name": "Effort"
      },
      {
        "id": "6580368959423672828",
        "value": 4,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Add a feature to a master feature

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"master_feature":"PRJ1-E-1"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "master_feature": "PRJ1-E-1"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:31:43.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/d294eee6dfe7a18617fde6690e492b9e14ef88a122a0994204dae1c9a70213b1.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:20.797Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2018-07-27",
      "release_date": "2018-07-27",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Move a feature to a different release

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
start_date Date that work will start on the feature in format YYYY-MM-DD
due_date Date that work is due to be completed on the feature in format YYYY-MM-DD
release_phase Name or id of release phase which the feature belongs to
initiative Name or id of initiative which the feature belongs to
master_feature Name or id of master feature which the feature belongs to

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"release":"PRJ1-R-2"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "release": "PRJ1-R-2"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 0,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:32:21.151Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://account1.lvh.me/attachments/724655692/token/87389748572f09f7c1e15b5ed4b6d8d19aef183b741890a27a0c959ebca57dc4.download?size=original",
          "created_at": "2018-07-20T18:31:43.000Z",
          "updated_at": "2018-07-20T18:32:21.242Z",
          "file_size": 123,
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt"
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "url": "http://account1.example.org/features/PRJ1-1",
    "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
    "release": {
      "id": "161456549",
      "reference_num": "PRJ1-R-2",
      "name": "Release 2",
      "start_date": "2018-06-20",
      "release_date": "2018-08-03",
      "parking_lot": false,
      "created_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "integration_fields": [

      ],
      "url": "http://account1.example.org/releases/PRJ1-R-2",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-2",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2018-07-20T18:31:42.000Z",
      "url": "http://account1.example.org/epics/PRJ1-E-1",
      "resource": "http://account1.example.org/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2018-07-20T18:31:43.000Z",
        "updated_at": "2018-07-20T18:31:43.000Z",
        "release_id": 161456549,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://account1.example.org/requirements/PRJ1-1-1",
        "resource": "http://account1.example.org/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "689956296",
          "name": "Henry Humpty",
          "email": "henry.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z",
          "default_assignee": true
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "mary.humpty@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": null,
            "type": "date"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "comments_count": 1
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://account1.example.org/initiatives/423077122",
      "resource": "http://account1.example.org/api/v1/initiatives/423077122",
      "created_at": "2018-07-20T18:31:42.000Z",
      "description": {
        "id": "673273729",
        "body": "Description of initiative 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2018-07-20T18:31:42.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://account1.example.org/strategic_imperatives/602095703",
        "resource": "http://account1.example.org/api/v1/goals/602095703",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "166463080",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": null,
        "type": "date"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2018-07-20T18:31:43.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-2",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

DELETE /api/v1/features/:id

Delete a feature

Parameters

Name Description
id * Numeric ID, or key of the feature to be deleted

DELETE /api/v1/features/PRJ1-1

Example CURL command

curl "https://account1.aha.io/api/v1/features/PRJ1-1" -d '' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Goals API


POST /api/v1/products/:product_id/goals

Create a goal

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the goal in
project_id * Numeric ID, or key of the project the goals should be created in
name * Name of the goal
description Description of the goal and it can include HTML formatting.
effort Value between 1 and 100 describing the goal's position on the effort axis in the goal chart
value Value between 1 and 100 describing the goal's position on the value axis in the goal chart
parent_id ID of a goal to roll up to in the product line, Roll up a goal to a product line goal by 1) creating a goal for the product line 2) choosing that goal in this control. You can then visualize how releases relate to your strategic goals throughout Aha!
success_metric_name * Name of the Metric that will be used to measure this goal's success
success_metric_description * Description of the success metric
success_metric_status * Status of the success metric for the goal

POST /api/v1/products/PRJ1/goals

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/goals" -d '{"goal":{"name":"Goal 3","success_metric":{"name":"FooBar","description":"Foo Bar","workflow_status":"Not Started"},"time_frame":{"name":"2015"},"description":"Our first big goal","effort":15,"value":5}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "goal": {
    "name": "Goal 3",
    "success_metric": {
      "name": "FooBar",
      "description": "Foo Bar",
      "workflow_status": "Not Started"
    },
    "time_frame": {
      "name": "2015"
    },
    "description": "Our first big goal",
    "effort": 15,
    "value": 5
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "goal": {
    "id": "6580369185445415787",
    "name": "Goal 3",
    "effort": 15,
    "value": 5,
    "position": 6,
    "created_at": "2018-07-20T18:33:12.924Z",
    "updated_at": "2018-07-20T18:33:12.924Z",
    "product_id": 131414752,
    "url": "http://account1.example.org/strategic_imperatives/6580369185445415787",
    "resource": "http://account1.example.org/strategic_imperatives/6580369185445415787",
    "description": {
      "id": "6580369185483528547",
      "body": "Our first big goal",
      "created_at": "2018-07-20T18:33:12.933Z",
      "attachments": [

      ]
    },
    "success_metric": {
      "name": "FooBar",
      "description": {
        "id": "6580369185577875770",
        "body": "Foo Bar",
        "created_at": "2018-07-20T18:33:12.958Z",
        "attachments": [

        ]
      },
      "workflow_status": {
        "id": "412273758",
        "name": "Not Started",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      }
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "initiatives": [

    ],
    "comments_count": 0,
    "features": [

    ],
    "releases": [

    ],
    "custom_fields": [

    ]
  }
}

POST /api/v1/products/:product_id/goals

Create a goal with watchers

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the goal in
project_id * Numeric ID, or key of the project the goals should be created in
name * Name of the goal
description Description of the goal and it can include HTML formatting.
effort Value between 1 and 100 describing the goal's position on the effort axis in the goal chart
value Value between 1 and 100 describing the goal's position on the value axis in the goal chart
parent_id ID of a goal to roll up to in the product line, Roll up a goal to a product line goal by 1) creating a goal for the product line 2) choosing that goal in this control. You can then visualize how releases relate to your strategic goals throughout Aha!
success_metric_name * Name of the Metric that will be used to measure this goal's success
success_metric_description * Description of the success metric
success_metric_status * Status of the success metric for the goal

POST /api/v1/products/PRJ1/goals

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/goals" -d '{"fields":"*,watchers","goal":{"name":"Goal 3","success_metric":{"name":"FooBar","description":"Foo Bar","workflow_status":"Not Started"},"watchers":"689956296,16338845"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "fields": "*,watchers",
  "goal": {
    "name": "Goal 3",
    "success_metric": {
      "name": "FooBar",
      "description": "Foo Bar",
      "workflow_status": "Not Started"
    },
    "watchers": "689956296,16338845"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "goal": {
    "id": "6580369186955982580",
    "name": "Goal 3",
    "effort": 95,
    "value": 33,
    "position": 6,
    "created_at": "2018-07-20T18:33:13.277Z",
    "updated_at": "2018-07-20T18:33:13.277Z",
    "product_id": 131414752,
    "url": "http://account1.example.org/strategic_imperatives/6580369186955982580",
    "resource": "http://account1.example.org/strategic_imperatives/6580369186955982580",
    "description": {
      "id": "6580369187002419211",
      "body": "",
      "created_at": "2018-07-20T18:33:13.287Z",
      "attachments": [

      ]
    },
    "success_metric": {
      "name": "FooBar",
      "description": {
        "id": "6580369187063394331",
        "body": "Foo Bar",
        "created_at": "2018-07-20T18:33:13.301Z",
        "attachments": [

        ]
      },
      "workflow_status": {
        "id": "412273758",
        "name": "Not Started",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      }
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "initiatives": [

    ],
    "comments_count": 0,
    "features": [

    ],
    "releases": [

    ],
    "custom_fields": [

    ],
    "watchers": [
      {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "689956296",
        "name": "Henry Humpty",
        "email": "henry.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      }
    ]
  }
}

POST /api/v1/products/:product_id/goals

Create a goal should set a strategic imperative metric

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the goal in
project_id * Numeric ID, or key of the project the goals should be created in
name * Name of the goal
description Description of the goal and it can include HTML formatting.
effort Value between 1 and 100 describing the goal's position on the effort axis in the goal chart
value Value between 1 and 100 describing the goal's position on the value axis in the goal chart
parent_id ID of a goal to roll up to in the product line, Roll up a goal to a product line goal by 1) creating a goal for the product line 2) choosing that goal in this control. You can then visualize how releases relate to your strategic goals throughout Aha!
success_metric_name * Name of the Metric that will be used to measure this goal's success
success_metric_description * Description of the success metric
success_metric_status * Status of the success metric for the goal

POST /api/v1/products/PRJ1/goals

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/goals" -d '{"goal":{"name":"Goal 3418271","success_metric":{"name":"FooBar","description":"Foo Bar","workflow_status":"Not Started"},"time_frame":{"name":"2015"},"description":"Our first big goal","effort":15,"value":5}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "goal": {
    "name": "Goal 3418271",
    "success_metric": {
      "name": "FooBar",
      "description": "Foo Bar",
      "workflow_status": "Not Started"
    },
    "time_frame": {
      "name": "2015"
    },
    "description": "Our first big goal",
    "effort": 15,
    "value": 5
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "goal": {
    "id": "6580369188377521974",
    "name": "Goal 3418271",
    "effort": 15,
    "value": 5,
    "position": 6,
    "created_at": "2018-07-20T18:33:13.609Z",
    "updated_at": "2018-07-20T18:33:13.609Z",
    "product_id": 131414752,
    "url": "http://account1.example.org/strategic_imperatives/6580369188377521974",
    "resource": "http://account1.example.org/strategic_imperatives/6580369188377521974",
    "description": {
      "id": "6580369188405507281",
      "body": "Our first big goal",
      "created_at": "2018-07-20T18:33:13.613Z",
      "attachments": [

      ]
    },
    "success_metric": {
      "name": "FooBar",
      "description": {
        "id": "6580369188459343666",
        "body": "Foo Bar",
        "created_at": "2018-07-20T18:33:13.630Z",
        "attachments": [

        ]
      },
      "workflow_status": {
        "id": "412273758",
        "name": "Not Started",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      }
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "initiatives": [

    ],
    "comments_count": 0,
    "features": [

    ],
    "releases": [

    ],
    "custom_fields": [

    ]
  }
}

POST /api/v1/products/:product_id/goals

Create a goal without all params should 400

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the goal in
project_id * Numeric ID, or key of the project the goals should be created in
name * Name of the goal
description Description of the goal and it can include HTML formatting.
effort Value between 1 and 100 describing the goal's position on the effort axis in the goal chart
value Value between 1 and 100 describing the goal's position on the value axis in the goal chart
parent_id ID of a goal to roll up to in the product line, Roll up a goal to a product line goal by 1) creating a goal for the product line 2) choosing that goal in this control. You can then visualize how releases relate to your strategic goals throughout Aha!
success_metric_name * Name of the Metric that will be used to measure this goal's success
success_metric_description * Description of the success metric
success_metric_status * Status of the success metric for the goal

POST /api/v1/products/PRJ1/goals

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/goals" -d '{"goal":{"name":"Goal 3418271","time_frame":{"name":"2015"},"description":"Our first big goal","effort":15,"value":5}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "goal": {
    "name": "Goal 3418271",
    "time_frame": {
      "name": "2015"
    },
    "description": "Our first big goal",
    "effort": 15,
    "value": 5
  }
}

Response

Status: 400 Bad Request
  Content-Type: application/json; charset=utf-8
{
  "error": "Required parameter missing: success_metric"
}

GET /api/v1/products/:product_id/goals

Get all goals for a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to get goals for

GET /api/v1/products/PRJ1/goals

Example CURL command

curl -g "https://account1.aha.io/api/v1/products/PRJ1/goals" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "goals": [
    {
      "id": "602095703",
      "name": "Goal 1",
      "effort": 10,
      "value": 70,
      "position": 1,
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "url": "http://account1.example.org/strategic_imperatives/602095703",
      "resource": "http://account1.example.org/strategic_imperatives/602095703",
      "description": {
        "id": "166463080",
        "body": "Description of goal 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "success_metric": {
        "name": "Metric 1",
        "description": {
          "id": "546284368",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "workflow_status": {
          "id": "1009437757",
          "name": "In progress",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f"
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      },
      "initiatives": [
        {
          "id": "423077122",
          "name": "Initiative 1",
          "url": "http://account1.example.org/initiatives/423077122",
          "resource": "http://account1.example.org/api/v1/initiatives/423077122",
          "created_at": "2018-07-20T18:31:42.000Z",
          "description": {
            "id": "673273729",
            "body": "Description of initiative 1",
            "created_at": "2018-07-20T18:31:43.000Z",
            "attachments": [

            ]
          },
          "integration_fields": [
            {
              "id": "365436441",
              "name": "key",
              "value": "JRA-987222",
              "integration_id": 342659513,
              "service_name": "jira",
              "created_at": "2018-07-20T18:31:42.000Z"
            },
            {
              "id": "213995437",
              "name": "id",
              "value": "9913333",
              "integration_id": 342659513,
              "service_name": "jira",
              "created_at": "2018-07-20T18:31:42.000Z"
            }
          ]
        }
      ],
      "comments_count": 1,
      "features": [
        {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        }
      ],
      "releases": [
        {
          "id": "278327321",
          "reference_num": "PRJ1-R-1",
          "name": "Release 1",
          "start_date": "2018-07-27",
          "release_date": "2018-07-27",
          "parking_lot": false,
          "created_at": "2018-07-20T18:31:42.000Z",
          "product_id": 131414752,
          "integration_fields": [
            {
              "id": "68217473",
              "name": "id",
              "value": "777",
              "integration_id": 204584239,
              "service_name": "jira",
              "created_at": "2018-07-20T18:31:42.000Z"
            }
          ],
          "url": "http://account1.example.org/releases/PRJ1-R-1",
          "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
          "owner": {
            "id": "16338845",
            "name": "John Smith",
            "email": "john.smith@account1.com",
            "created_at": "2018-07-20T18:31:42.000Z",
            "updated_at": "2018-07-20T18:31:42.000Z"
          },
          "project": {
            "id": "131414752",
            "reference_prefix": "PRJ1",
            "name": "Project 1",
            "product_line": false,
            "created_at": "2018-07-20T18:31:43.000Z"
          }
        }
      ],
      "custom_fields": [

      ]
    },
    {
      "id": "988418543",
      "name": "Goal 2",
      "effort": 40,
      "value": 30,
      "position": 2,
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "url": "http://account1.example.org/strategic_imperatives/988418543",
      "resource": "http://account1.example.org/strategic_imperatives/988418543",
      "description": {
        "id": "1055602421",
        "body": "Description of goal 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "success_metric": {
        "name": "Metric 2",
        "description": {
          "id": "394826695",
          "body": "Description of goal 2",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "workflow_status": {
          "id": "1009437757",
          "name": "In progress",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f"
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      },
      "initiatives": [

      ],
      "comments_count": 0,
      "features": [

      ],
      "releases": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "712130641",
      "name": "Goal 3",
      "effort": 40,
      "value": 30,
      "position": 2,
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "url": "http://account1.example.org/strategic_imperatives/712130641",
      "resource": "http://account1.example.org/strategic_imperatives/712130641",
      "description": {
        "id": "568840458",
        "body": "Description of project1_strategic_imperative3_no_epoch",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "success_metric": {
        "name": "Metric 3",
        "description": {
          "id": "668008103",
          "body": "Description of project1_strategic_imperative3_no_epoch_strategic_imperative_metric",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "workflow_status": {
          "id": "1009437757",
          "name": "In progress",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f"
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      },
      "initiatives": [

      ],
      "comments_count": 0,
      "features": [

      ],
      "releases": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "926116263",
      "name": "Goal 4",
      "effort": 40,
      "value": 30,
      "position": 2,
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "url": "http://account1.example.org/strategic_imperatives/926116263",
      "resource": "http://account1.example.org/strategic_imperatives/926116263",
      "description": {
        "id": "308494954",
        "body": "Description of project1_strategic_imperative4_active_epoch",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "success_metric": {
        "name": "Metric 4",
        "description": {
          "id": "330355042",
          "body": "Description of project1_strategic_imperative4_active_epoch_strategic_imperative_metric",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "workflow_status": {
          "id": "1009437757",
          "name": "In progress",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f"
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      },
      "time_frame": {
        "id": 273422810,
        "name": "2017"
      },
      "initiatives": [

      ],
      "comments_count": 0,
      "features": [

      ],
      "releases": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "111739083",
      "name": "Goal 5",
      "effort": 40,
      "value": 30,
      "position": 2,
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "url": "http://account1.example.org/strategic_imperatives/111739083",
      "resource": "http://account1.example.org/strategic_imperatives/111739083",
      "description": {
        "id": "996214770",
        "body": "Description of project1_strategic_imperative5_archived_epoch",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "success_metric": {
        "name": "Metric 5",
        "description": {
          "id": "429990377",
          "body": "Description of project1_strategic_imperative5_archived_epoch_strategic_imperative_metric",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "workflow_status": {
          "id": "1009437757",
          "name": "In progress",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f"
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      },
      "time_frame": {
        "id": 834757622,
        "name": "2018"
      },
      "initiatives": [

      ],
      "comments_count": 0,
      "features": [

      ],
      "releases": [

      ],
      "custom_fields": [

      ]
    }
  ],
  "pagination": {
    "total_records": 5,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/initiatives/:initiative_id/goals

Get all goals associated with an initiative

Parameters

Name Description
initiative_id * Numeric ID of the initiative to get goals for

GET /api/v1/initiatives/423077122/goals

Example CURL command

curl -g "https://account1.aha.io/api/v1/initiatives/423077122/goals" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "goals": [
    {
      "id": "602095703",
      "name": "Goal 1",
      "effort": 10,
      "value": 70,
      "position": 1,
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z",
      "product_id": 131414752,
      "url": "http://account1.example.org/strategic_imperatives/602095703",
      "resource": "http://account1.example.org/strategic_imperatives/602095703",
      "description": {
        "id": "166463080",
        "body": "Description of goal 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "success_metric": {
        "name": "Metric 1",
        "description": {
          "id": "546284368",
          "body": "Description of goal 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "workflow_status": {
          "id": "1009437757",
          "name": "In progress",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f"
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      },
      "initiatives": [
        {
          "id": "423077122",
          "name": "Initiative 1",
          "url": "http://account1.example.org/initiatives/423077122",
          "resource": "http://account1.example.org/api/v1/initiatives/423077122",
          "created_at": "2018-07-20T18:31:42.000Z",
          "description": {
            "id": "673273729",
            "body": "Description of initiative 1",
            "created_at": "2018-07-20T18:31:43.000Z",
            "attachments": [

            ]
          },
          "integration_fields": [
            {
              "id": "365436441",
              "name": "key",
              "value": "JRA-987222",
              "integration_id": 342659513,
              "service_name": "jira",
              "created_at": "2018-07-20T18:31:42.000Z"
            },
            {
              "id": "213995437",
              "name": "id",
              "value": "9913333",
              "integration_id": 342659513,
              "service_name": "jira",
              "created_at": "2018-07-20T18:31:42.000Z"
            }
          ]
        }
      ],
      "comments_count": 1,
      "features": [
        {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "url": "http://account1.example.org/features/PRJ1-1",
          "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
          "product_id": 131414752
        }
      ],
      "releases": [
        {
          "id": "278327321",
          "reference_num": "PRJ1-R-1",
          "name": "Release 1",
          "start_date": "2018-07-27",
          "release_date": "2018-07-27",
          "parking_lot": false,
          "created_at": "2018-07-20T18:31:42.000Z",
          "product_id": 131414752,
          "integration_fields": [
            {
              "id": "68217473",
              "name": "id",
              "value": "777",
              "integration_id": 204584239,
              "service_name": "jira",
              "created_at": "2018-07-20T18:31:42.000Z"
            }
          ],
          "url": "http://account1.example.org/releases/PRJ1-R-1",
          "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
          "owner": {
            "id": "16338845",
            "name": "John Smith",
            "email": "john.smith@account1.com",
            "created_at": "2018-07-20T18:31:42.000Z",
            "updated_at": "2018-07-20T18:31:42.000Z"
          },
          "project": {
            "id": "131414752",
            "reference_prefix": "PRJ1",
            "name": "Project 1",
            "product_line": false,
            "created_at": "2018-07-20T18:31:43.000Z"
          }
        }
      ],
      "custom_fields": [

      ]
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/goals/:id

Get a specific goal

Parameters

Name Description
id * Numeric ID of the goal to be retrieved

GET /api/v1/goals/602095703

Example CURL command

curl -g "https://account1.aha.io/api/v1/goals/602095703" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "goal": {
    "id": "602095703",
    "name": "Goal 1",
    "effort": 10,
    "value": 70,
    "position": 1,
    "created_at": "2018-07-20T18:31:42.000Z",
    "updated_at": "2018-07-20T18:31:42.000Z",
    "product_id": 131414752,
    "url": "http://account1.example.org/strategic_imperatives/602095703",
    "resource": "http://account1.example.org/strategic_imperatives/602095703",
    "description": {
      "id": "166463080",
      "body": "Description of goal 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "success_metric": {
      "name": "Metric 1",
      "description": {
        "id": "546284368",
        "body": "Description of goal 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      }
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "initiatives": [
      {
        "id": "423077122",
        "name": "Initiative 1",
        "url": "http://account1.example.org/initiatives/423077122",
        "resource": "http://account1.example.org/api/v1/initiatives/423077122",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "673273729",
          "body": "Description of initiative 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "integration_fields": [
          {
            "id": "365436441",
            "name": "key",
            "value": "JRA-987222",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "213995437",
            "name": "id",
            "value": "9913333",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ]
      }
    ],
    "comments_count": 1,
    "features": [
      {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
        "product_id": 131414752
      }
    ],
    "releases": [
      {
        "id": "278327321",
        "reference_num": "PRJ1-R-1",
        "name": "Release 1",
        "start_date": "2018-07-27",
        "release_date": "2018-07-27",
        "parking_lot": false,
        "created_at": "2018-07-20T18:31:42.000Z",
        "product_id": 131414752,
        "integration_fields": [
          {
            "id": "68217473",
            "name": "id",
            "value": "777",
            "integration_id": 204584239,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "url": "http://account1.example.org/releases/PRJ1-R-1",
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "john.smith@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2018-07-20T18:31:43.000Z"
        }
      }
    ],
    "custom_fields": [

    ]
  }
}

PUT /api/v1/products/:product_id/goals/:id

Update a goal

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the goal in
id * Numeric ID, or key of the goal to be updated
project_id Numeric ID, or key of the project the goals should be created in
name Name of the goal
description Description of the goal and it can include HTML formatting.
effort Value between 1 and 100 describing the goal's position on the effort axis in the goal chart
value Value between 1 and 100 describing the goal's position on the value axis in the goal chart
parent_id ID of a goal to roll up to in the product line, Roll up a goal to a product line goal by 1) creating a goal for the product line 2) choosing that goal in this control. You can then visualize how releases relate to your strategic goals throughout Aha!
success_metric_name Name of the Metric that will be used to measure this goal's success
success_metric_description Description of the success metric
success_metric_status Status of the success metric for the goal

PUT /api/v1/products/PRJ1/goals/602095703

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/goals/602095703" -d '{"goal":{"description":"An even smarter goal.","workflow_status":"On Track"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "goal": {
    "description": "An even smarter goal.",
    "workflow_status": "On Track"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "goal": {
    "id": "602095703",
    "name": "Goal 1",
    "effort": 10,
    "value": 70,
    "position": 1,
    "created_at": "2018-07-20T18:31:42.000Z",
    "updated_at": "2018-07-20T18:31:42.000Z",
    "product_id": 131414752,
    "url": "http://account1.example.org/strategic_imperatives/602095703",
    "resource": "http://account1.example.org/strategic_imperatives/602095703",
    "description": {
      "id": "166463080",
      "body": "An even smarter goal.",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "success_metric": {
      "name": "Metric 1",
      "description": {
        "id": "546284368",
        "body": "Description of goal 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "workflow_status": {
        "id": "396368932",
        "name": "On Track",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      }
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "initiatives": [
      {
        "id": "423077122",
        "name": "Initiative 1",
        "url": "http://account1.example.org/initiatives/423077122",
        "resource": "http://account1.example.org/api/v1/initiatives/423077122",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "673273729",
          "body": "Description of initiative 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "integration_fields": [
          {
            "id": "365436441",
            "name": "key",
            "value": "JRA-987222",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "213995437",
            "name": "id",
            "value": "9913333",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ]
      }
    ],
    "comments_count": 1,
    "features": [
      {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
        "product_id": 131414752
      }
    ],
    "releases": [
      {
        "id": "278327321",
        "reference_num": "PRJ1-R-1",
        "name": "Release 1",
        "start_date": "2018-07-27",
        "release_date": "2018-07-27",
        "parking_lot": false,
        "created_at": "2018-07-20T18:31:42.000Z",
        "product_id": 131414752,
        "integration_fields": [
          {
            "id": "68217473",
            "name": "id",
            "value": "777",
            "integration_id": 204584239,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "url": "http://account1.example.org/releases/PRJ1-R-1",
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "john.smith@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2018-07-20T18:31:43.000Z"
        }
      }
    ],
    "custom_fields": [

    ]
  }
}

PUT /api/v1/products/:product_id/goals/:id

Update a goal's watchers

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the goal in
id * Numeric ID, or key of the goal to be updated
project_id Numeric ID, or key of the project the goals should be created in
name Name of the goal
description Description of the goal and it can include HTML formatting.
effort Value between 1 and 100 describing the goal's position on the effort axis in the goal chart
value Value between 1 and 100 describing the goal's position on the value axis in the goal chart
parent_id ID of a goal to roll up to in the product line, Roll up a goal to a product line goal by 1) creating a goal for the product line 2) choosing that goal in this control. You can then visualize how releases relate to your strategic goals throughout Aha!
success_metric_name Name of the Metric that will be used to measure this goal's success
success_metric_description Description of the success metric
success_metric_status Status of the success metric for the goal

PUT /api/v1/products/PRJ1/goals/602095703

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/goals/602095703" -d '{"goal":{"watchers":[689956296]}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "goal": {
    "watchers": [
      689956296
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "goal": {
    "id": "602095703",
    "name": "Goal 1",
    "effort": 10,
    "value": 70,
    "position": 1,
    "created_at": "2018-07-20T18:31:42.000Z",
    "updated_at": "2018-07-20T18:31:42.000Z",
    "product_id": 131414752,
    "url": "http://account1.example.org/strategic_imperatives/602095703",
    "resource": "http://account1.example.org/strategic_imperatives/602095703",
    "description": {
      "id": "166463080",
      "body": "Description of goal 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "success_metric": {
      "name": "Metric 1",
      "description": {
        "id": "546284368",
        "body": "Description of goal 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      }
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "initiatives": [
      {
        "id": "423077122",
        "name": "Initiative 1",
        "url": "http://account1.example.org/initiatives/423077122",
        "resource": "http://account1.example.org/api/v1/initiatives/423077122",
        "created_at": "2018-07-20T18:31:42.000Z",
        "description": {
          "id": "673273729",
          "body": "Description of initiative 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "integration_fields": [
          {
            "id": "365436441",
            "name": "key",
            "value": "JRA-987222",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          },
          {
            "id": "213995437",
            "name": "id",
            "value": "9913333",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ]
      }
    ],
    "comments_count": 1,
    "features": [
      {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
        "product_id": 131414752
      }
    ],
    "releases": [
      {
        "id": "278327321",
        "reference_num": "PRJ1-R-1",
        "name": "Release 1",
        "start_date": "2018-07-27",
        "release_date": "2018-07-27",
        "parking_lot": false,
        "created_at": "2018-07-20T18:31:42.000Z",
        "product_id": 131414752,
        "integration_fields": [
          {
            "id": "68217473",
            "name": "id",
            "value": "777",
            "integration_id": 204584239,
            "service_name": "jira",
            "created_at": "2018-07-20T18:31:42.000Z"
          }
        ],
        "url": "http://account1.example.org/releases/PRJ1-R-1",
        "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "john.smith@account1.com",
          "created_at": "2018-07-20T18:31:42.000Z",
          "updated_at": "2018-07-20T18:31:42.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2018-07-20T18:31:43.000Z"
        }
      }
    ],
    "custom_fields": [

    ]
  }
}

DELETE /api/v1/products/:product_id/goals/:id

Delete a goal

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the goal in
id * Numeric ID, or key of the goal to be deleted

DELETE /api/v1/products/PRJ1/goals/602095703

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/goals/602095703" -d '' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Idea Categories API


GET /api/v1/products/:product_id/idea_categories

Get all idea categories for a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to get categories for

GET /api/v1/products/PRJ1/idea_categories

Example CURL command

curl -g "https://account1.aha.io/api/v1/products/PRJ1/idea_categories" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_categories": [
    {
      "id": "552935478",
      "name": "Storage",
      "parent_id": null,
      "created_at": "2018-07-20T18:31:42.000Z"
    },
    {
      "id": "972845454",
      "name": "Hard disk drive",
      "parent_id": 552935478,
      "created_at": "2018-07-20T18:31:42.000Z"
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

Idea Comments API


POST /api/v1/ideas/:idea_id/idea_comments

Create a public comment for an idea

Parameters

Name Description
idea_id * Numeric ID or key of the idea the comment should be created for

POST /api/v1/ideas/PRJ1-I-1/idea_comments

Example CURL command

curl "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/idea_comments" -d '{"idea_comment":{"body":"\u003cp\u003eThis is the comment body.\u003c/p\u003e","portal_user":{"email":"new_email@address.com"}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea_comment": {
    "body": "<p>This is the comment body.</p>",
    "portal_user": {
      "email": "new_email@address.com"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_comment": {
    "id": "6580368972792167605",
    "idea_id": "58056975",
    "body": "<p>This is the comment body.</p>",
    "created_at": "2018-07-20T18:32:23.412Z",
    "idea_commenter_portal_user": {
      "id": "6580368972656145181",
      "name": "new_email@address.com",
      "email": "new_email@address.com",
      "created_at": "2018-07-20T18:32:23.381Z"
    },
    "idea": {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    },
    "attachments": [

    ]
  }
}

GET /api/v1/ideas/:idea_id/idea_comments

Get public comments for an idea

Parameters

Name Description
idea_id * Numeric ID or key of the idea the expected comment

GET /api/v1/ideas/58056975/idea_comments

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/58056975/idea_comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_comments": [
    {
      "id": "622085811",
      "idea_id": "58056975",
      "body": "This is a great idea! We'll get started right away.",
      "created_at": "2018-07-20T18:31:42.000Z",
      "idea_commenter_user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      "idea": {
        "id": "58056975",
        "reference_num": "PRJ1-I-1",
        "name": "Idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "workflow_status": {
          "id": "3259216",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "description": {
          "id": "103757394",
          "body": "Description of idea 1",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
        "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
      },
      "attachments": [

      ]
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

Idea Endorsements API


POST /api/v1/ideas/:idea_id/endorsements

Create an idea endorsement

Parameters

Name Description
idea_id * Numeric ID, or key of the idea to endorse
value Dollar value of the idea endorsement, numeric

POST /api/v1/ideas/PRJ1-I-1/endorsements

Example CURL command

curl "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/endorsements" -d '{"idea_endorsement":{"email":"henry.humpty@account1.com","value":2}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea_endorsement": {
    "email": "henry.humpty@account1.com",
    "value": 2
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_endorsement": {
    "id": "6580368975763031212",
    "idea_id": "58056975",
    "created_at": "2018-07-20T18:32:24.103Z",
    "value": "2.0",
    "endorsed_by_portal_user": {
      "id": "6580368975598398216",
      "name": "henry.humpty@account1.com",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:32:24.064Z"
    },
    "integration_fields": [

    ],
    "idea": {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  }
}

POST /api/v1/ideas/:idea_id/endorsements?multiple_endorsements=true

Create multiple endorsements for a user

Parameters

Name Description
idea_id * Numeric ID, or key of the idea to endorse
value Dollar value of the idea endorsement, numeric

POST /api/v1/ideas/PRJ1-I-1/endorsements?multiple_endorsements=true

Example CURL command

curl "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/endorsements?multiple_endorsements=true" -d '{"idea_endorsement":{"email":"henry.humpty@account1.com"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea_endorsement": {
    "email": "henry.humpty@account1.com"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_endorsement": {
    "id": "6580368978617148420",
    "idea_id": "58056975",
    "created_at": "2018-07-20T18:32:24.770Z",
    "value": null,
    "endorsed_by_portal_user": {
      "id": "6580368978477447675",
      "name": "henry.humpty@account1.com",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:32:24.736Z"
    },
    "integration_fields": [

    ],
    "idea": {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  }
}

POST /api/v1/ideas/PRJ1-I-1/endorsements?multiple_endorsements=true

Example CURL command

curl "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/endorsements?multiple_endorsements=true" -d '{"idea_endorsement":{"email":"henry.humpty@account1.com"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea_endorsement": {
    "email": "henry.humpty@account1.com"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_endorsement": {
    "id": "6580368979058230472",
    "idea_id": "58056975",
    "created_at": "2018-07-20T18:32:24.870Z",
    "value": null,
    "endorsed_by_portal_user": {
      "id": "6580368978477447675",
      "name": "henry.humpty@account1.com",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:32:24.736Z"
    },
    "integration_fields": [

    ],
    "idea": {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  }
}

GET /api/v1/ideas/:idea_id/endorsements

Get all endorsements for an idea

Parameters

Name Description
idea_id * Numeric ID, or key of the idea to get endorsements for

GET /api/v1/ideas/PRJ1-I-1/endorsements

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/endorsements" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_endorsements": [
    {
      "id": "53377392",
      "idea_id": "58056975",
      "created_at": "2018-07-20T18:31:42.000Z",
      "value": null,
      "endorsed_by_portal_user": {
        "id": "646391926",
        "name": "John Long",
        "email": "john@long.com",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas/:idea_id/endorsements/:id

Get a specific endorsement for an idea

Parameters

Name Description
idea_id * Numeric ID, or key of the idea to get endorsement for
id * Id of an idea endorsement

GET /api/v1/ideas/PRJ1-I-1/endorsements/53377392

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/endorsements/53377392" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_endorsement": {
    "id": "53377392",
    "idea_id": "58056975",
    "created_at": "2018-07-20T18:31:42.000Z",
    "value": null,
    "endorsed_by_portal_user": {
      "id": "646391926",
      "name": "John Long",
      "email": "john@long.com",
      "created_at": "2018-07-20T18:31:42.000Z"
    },
    "integration_fields": [
      {
        "id": "975466318",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "idea": {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  }
}

PUT /api/v1/ideas/:idea_id/endorsements/:id

Update an idea endorsement

Parameters

Name Description
idea_id * Numeric ID, or key of the idea to endorse
id * Id of an idea endorsement
value Dollar value of the idea endorsement, numeric

PUT /api/v1/ideas/PRJ1-I-1/endorsements/53377392

Example CURL command

curl "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/endorsements/53377392" -d '{"idea_endorsement":{"value":123.45}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea_endorsement": {
    "value": 123.45
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_endorsement": {
    "id": "53377392",
    "idea_id": "58056975",
    "created_at": "2018-07-20T18:31:42.000Z",
    "value": "123.45",
    "endorsed_by_portal_user": {
      "id": "646391926",
      "name": "John Long",
      "email": "john@long.com",
      "created_at": "2018-07-20T18:31:42.000Z"
    },
    "integration_fields": [
      {
        "id": "975466318",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "idea": {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  }
}

DELETE /api/v1/ideas/:idea_id/endorsements/:id

Delete an idea endorsement

Parameters

Name Description
idea_id * Numeric ID, or key of the idea to remove endorsement from
id * ID of the endorsement to remove

DELETE /api/v1/ideas/PRJ1-I-1/endorsements/53377392

Example CURL command

curl "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/endorsements/53377392" -d '' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Idea Subscriptions API


POST /api/v1/ideas/:idea_id/subscriptions

Create an idea subscription

Parameters

Name Description
idea_id * Numeric ID, or key of the idea to endorse

POST /api/v1/ideas/PRJ1-I-1/subscriptions

Example CURL command

curl "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/subscriptions" -d '{"idea_subscription":{"email":"henry.humpty@account1.com"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea_subscription": {
    "email": "henry.humpty@account1.com"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_subscription": {
    "id": "6580368984680632022",
    "idea_id": "58056975",
    "created_at": "2018-07-20T18:32:26.181Z",
    "portal_user": {
      "id": "6580368984516572987",
      "name": "henry.humpty@account1.com",
      "email": "henry.humpty@account1.com",
      "created_at": "2018-07-20T18:32:26.145Z"
    },
    "idea": {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  }
}

GET /api/v1/ideas/:idea_id/subscriptions

Get all subscriptions for an idea

Parameters

Name Description
idea_id * Numeric ID, or key of the idea to get subscriptions for

GET /api/v1/ideas/PRJ1-I-1/subscriptions

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/subscriptions" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_subscriptions": [
    {
      "id": "783147498",
      "idea_id": "58056975",
      "created_at": "2018-07-20T18:31:42.000Z",
      "portal_user": {
        "id": "646391926",
        "name": "John Long",
        "email": "john@long.com",
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas/:idea_id/subscriptions/:id

Get a specific subscription for an idea

Parameters

Name Description
idea_id * Numeric ID, or key of the idea to get subscription for
id * Id of an idea subscription

GET /api/v1/ideas/PRJ1-I-1/subscriptions/783147498

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/subscriptions/783147498" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea_subscription": {
    "id": "783147498",
    "idea_id": "58056975",
    "created_at": "2018-07-20T18:31:42.000Z",
    "portal_user": {
      "id": "646391926",
      "name": "John Long",
      "email": "john@long.com",
      "created_at": "2018-07-20T18:31:42.000Z"
    },
    "idea": {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  }
}

DELETE /api/v1/ideas/:idea_id/subscriptions/:id

Delete an idea subscription

Parameters

Name Description
idea_id * Numeric ID, or key of the idea to remove subscription from
id * ID of the subscription to remove

DELETE /api/v1/ideas/PRJ1-I-1/subscriptions/783147498

Example CURL command

curl "https://account1.aha.io/api/v1/ideas/PRJ1-I-1/subscriptions/783147498" -d '' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Ideas API


POST /api/v1/products/:product_id/ideas

Create an idea

Parameters

Name Description
product_id * Numeric ID, or key of the product the idea should be created in
name * Name of the idea
description Description of the idea and it can include HTML formatting.
workflow_status Status of the idea and it must be one of the valid status values for the selected product.
tags Tags can be automatically assigned to the new idea. If more than one tag is used then tags should be separated by commas
categories Names of the existing categories the idea should be assigned to. If more than one category is used then categories should be separated by commas - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature Feature ID of the feature that the idea was promoted to
initiative Initiative ID of the initiative that the idea was promoted to
master_feature Master feature ID of the master feature that the idea was promoted to
initial_votes Number of votes to seed the vote count with when importing from other systems
visibility Initial visibility of the idea ('aha', 'employee', or 'public' - 'aha' is the default)

POST /api/v1/products/PRJ1/ideas

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/ideas" -d '{"idea":{"name":"New idea","description":"\u003cp\u003eThis is the description\u003c/p\u003e","initial_votes":3}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea": {
    "name": "New idea",
    "description": "<p>This is the description</p>",
    "initial_votes": 3
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6580368989590085394",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 2,
    "created_at": "2018-07-20T18:32:27.324Z",
    "updated_at": "2018-07-20T18:32:27.382Z",
    "product_id": 131414752,
    "votes": 3,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "6580368989669495585",
      "body": "<p>This is the description</p>",
      "created_at": "2018-07-20T18:32:27.345Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:32:27.389Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 0,
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

POST /api/v1/products/:product_id/ideas

Create an idea created by a Idea Portal user

Parameters

Name Description
product_id * Numeric ID, or key of the product the idea should be created in
name * Name of the idea
description Description of the idea and it can include HTML formatting.
workflow_status Status of the idea and it must be one of the valid status values for the selected product.
tags Tags can be automatically assigned to the new idea. If more than one tag is used then tags should be separated by commas
categories Names of the existing categories the idea should be assigned to. If more than one category is used then categories should be separated by commas - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature Feature ID of the feature that the idea was promoted to
initiative Initiative ID of the initiative that the idea was promoted to
master_feature Master feature ID of the master feature that the idea was promoted to
initial_votes Number of votes to seed the vote count with when importing from other systems
visibility Initial visibility of the idea ('aha', 'employee', or 'public' - 'aha' is the default)

POST /api/v1/products/PRJ1/ideas

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/ideas" -d '{"idea":{"name":"New idea","created_by_portal_user":{"id":646391926,"name":"John Long"}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea": {
    "name": "New idea",
    "created_by_portal_user": {
      "id": 646391926,
      "name": "John Long"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6580368992503082571",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 2,
    "created_at": "2018-07-20T18:32:28.004Z",
    "updated_at": "2018-07-20T18:32:28.280Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "6580368992586581259",
      "body": "",
      "created_at": "2018-07-20T18:32:28.023Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_portal_user": {
      "id": "646391926",
      "name": "John Long",
      "email": "john@long.com",
      "created_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 0,
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

POST /api/v1/products/:product_id/ideas

Create an idea with comma-separated tags

Parameters

Name Description
product_id * Numeric ID, or key of the product the idea should be created in
name * Name of the idea
description Description of the idea and it can include HTML formatting.
workflow_status Status of the idea and it must be one of the valid status values for the selected product.
tags Tags can be automatically assigned to the new idea. If more than one tag is used then tags should be separated by commas
categories Names of the existing categories the idea should be assigned to. If more than one category is used then categories should be separated by commas - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature Feature ID of the feature that the idea was promoted to
initiative Initiative ID of the initiative that the idea was promoted to
master_feature Master feature ID of the master feature that the idea was promoted to
initial_votes Number of votes to seed the vote count with when importing from other systems
visibility Initial visibility of the idea ('aha', 'employee', or 'public' - 'aha' is the default)

POST /api/v1/products/PRJ1/ideas

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/ideas" -d '{"idea":{"name":"New idea","tags":"tag1, tag2"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea": {
    "name": "New idea",
    "tags": "tag1, tag2"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6580368995286061934",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 2,
    "created_at": "2018-07-20T18:32:28.652Z",
    "updated_at": "2018-07-20T18:32:28.722Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "6580368995442935547",
      "body": "",
      "created_at": "2018-07-20T18:32:28.688Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:32:28.731Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 0,
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [
      "tag1",
      "tag2"
    ],
    "full_tags": [
      {
        "id": "6580368995000410879",
        "name": "tag1",
        "color": "#52e077"
      },
      {
        "id": "6580368995028294366",
        "name": "tag2",
        "color": "#52d3e0"
      }
    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

POST /api/v1/products/:product_id/ideas

Create an idea with watchers

Parameters

Name Description
product_id * Numeric ID, or key of the product the idea should be created in
name * Name of the idea
description Description of the idea and it can include HTML formatting.
workflow_status Status of the idea and it must be one of the valid status values for the selected product.
tags Tags can be automatically assigned to the new idea. If more than one tag is used then tags should be separated by commas
categories Names of the existing categories the idea should be assigned to. If more than one category is used then categories should be separated by commas - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature Feature ID of the feature that the idea was promoted to
initiative Initiative ID of the initiative that the idea was promoted to
master_feature Master feature ID of the master feature that the idea was promoted to
initial_votes Number of votes to seed the vote count with when importing from other systems
visibility Initial visibility of the idea ('aha', 'employee', or 'public' - 'aha' is the default)

POST /api/v1/products/PRJ1/ideas

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/ideas" -d '{"fields":"*,watchers","idea":{"name":"New idea","watchers":"689956296,16338845"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "fields": "*,watchers",
  "idea": {
    "name": "New idea",
    "watchers": "689956296,16338845"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6580369001062560966",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 2,
    "created_at": "2018-07-20T18:32:29.996Z",
    "updated_at": "2018-07-20T18:32:30.055Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "6580369001190719398",
      "body": "",
      "created_at": "2018-07-20T18:32:30.023Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:32:30.064Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 0,
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ],
    "watchers": [
      {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "689956296",
        "name": "Henry Humpty",
        "email": "henry.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      },
      {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "mary.humpty@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:32:30.064Z"
      }
    ]
  }
}

POST /api/v1/products/:product_id/ideas

Create an idea with a score

Parameters

Name Description
product_id * Numeric ID, or key of the product the idea should be created in
name * Name of the idea
description Description of the idea and it can include HTML formatting.
workflow_status Status of the idea and it must be one of the valid status values for the selected product.
tags Tags can be automatically assigned to the new idea. If more than one tag is used then tags should be separated by commas
categories Names of the existing categories the idea should be assigned to. If more than one category is used then categories should be separated by commas - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature Feature ID of the feature that the idea was promoted to
initiative Initiative ID of the initiative that the idea was promoted to
master_feature Master feature ID of the master feature that the idea was promoted to
initial_votes Number of votes to seed the vote count with when importing from other systems
visibility Initial visibility of the idea ('aha', 'employee', or 'public' - 'aha' is the default)

POST /api/v1/products/PRJ1/ideas

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/ideas" -d '{"idea":{"name":"New idea","score_facts":[{"name":"Benefit","value":12},{"name":"Effort","value":3}]}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea": {
    "name": "New idea",
    "score_facts": [
      {
        "name": "Benefit",
        "value": 12
      },
      {
        "name": "Effort",
        "value": 3
      }
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6580369002480388517",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 15,
    "created_at": "2018-07-20T18:32:30.322Z",
    "updated_at": "2018-07-20T18:32:30.425Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "6580369002658957775",
      "body": "",
      "created_at": "2018-07-20T18:32:30.365Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:32:30.429Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 0,
    "comments_count": 0,
    "score_facts": [
      {
        "id": "6580369002828543838",
        "value": 3,
        "name": "Effort"
      },
      {
        "id": "6580369002549876349",
        "value": 12,
        "name": "Benefit"
      }
    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

POST /api/v1/products/:product_id/ideas

Create an idea with custom fields

Parameters

Name Description
product_id * Numeric ID, or key of the product the idea should be created in
name * Name of the idea
description Description of the idea and it can include HTML formatting.
workflow_status Status of the idea and it must be one of the valid status values for the selected product.
tags Tags can be automatically assigned to the new idea. If more than one tag is used then tags should be separated by commas
categories Names of the existing categories the idea should be assigned to. If more than one category is used then categories should be separated by commas - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature Feature ID of the feature that the idea was promoted to
initiative Initiative ID of the initiative that the idea was promoted to
master_feature Master feature ID of the master feature that the idea was promoted to
initial_votes Number of votes to seed the vote count with when importing from other systems
visibility Initial visibility of the idea ('aha', 'employee', or 'public' - 'aha' is the default)

POST /api/v1/products/PRJ1/ideas

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/ideas" -d '{"idea":{"name":"New idea","custom_fields":{"priority":"P3"}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea": {
    "name": "New idea",
    "custom_fields": {
      "priority": "P3"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6580369004190136784",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 2,
    "created_at": "2018-07-20T18:32:30.721Z",
    "updated_at": "2018-07-20T18:32:30.782Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "6580369004245110082",
      "body": "",
      "created_at": "2018-07-20T18:32:30.737Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:32:30.790Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 0,
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "categories": [

    ],
    "custom_fields": [
      {
        "key": "priority",
        "name": "Priority",
        "value": "P3",
        "type": "string"
      }
    ]
  }
}

POST /api/v1/products/:product_id/ideas

Create an idea with a specific visiblity

Parameters

Name Description
product_id * Numeric ID, or key of the product the idea should be created in
name * Name of the idea
description Description of the idea and it can include HTML formatting.
workflow_status Status of the idea and it must be one of the valid status values for the selected product.
tags Tags can be automatically assigned to the new idea. If more than one tag is used then tags should be separated by commas
categories Names of the existing categories the idea should be assigned to. If more than one category is used then categories should be separated by commas - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature Feature ID of the feature that the idea was promoted to
initiative Initiative ID of the initiative that the idea was promoted to
master_feature Master feature ID of the master feature that the idea was promoted to
initial_votes Number of votes to seed the vote count with when importing from other systems
visibility Initial visibility of the idea ('aha', 'employee', or 'public' - 'aha' is the default)

POST /api/v1/products/PRJ1/ideas

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/ideas" -d '{"idea":{"name":"New idea","visibility":"public"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea": {
    "name": "New idea",
    "visibility": "public"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6580369005613253720",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 2,
    "created_at": "2018-07-20T18:32:31.053Z",
    "updated_at": "2018-07-20T18:32:31.105Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "6580369005681022413",
      "body": "",
      "created_at": "2018-07-20T18:32:31.069Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:32:31.115Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 0,
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

POST /api/v1/products/:product_id/ideas

Create an idea with a creation date

Parameters

Name Description
product_id * Numeric ID, or key of the product the idea should be created in
name * Name of the idea
description Description of the idea and it can include HTML formatting.
workflow_status Status of the idea and it must be one of the valid status values for the selected product.
tags Tags can be automatically assigned to the new idea. If more than one tag is used then tags should be separated by commas
categories Names of the existing categories the idea should be assigned to. If more than one category is used then categories should be separated by commas - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature Feature ID of the feature that the idea was promoted to
initiative Initiative ID of the initiative that the idea was promoted to
master_feature Master feature ID of the master feature that the idea was promoted to
initial_votes Number of votes to seed the vote count with when importing from other systems
visibility Initial visibility of the idea ('aha', 'employee', or 'public' - 'aha' is the default)

POST /api/v1/products/PRJ1/ideas

Example CURL command

curl "https://account1.aha.io/api/v1/products/PRJ1/ideas" -d '{"idea":{"name":"New idea","created_at":"2014-01-11T00:01:02Z"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea": {
    "name": "New idea",
    "created_at": "2014-01-11T00:01:02Z"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6580369010122087057",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 2,
    "created_at": "2014-01-11T00:01:02.000Z",
    "updated_at": "2018-07-20T18:32:32.166Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "6580369010233605166",
      "body": "",
      "created_at": "2018-07-20T18:32:32.129Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:32:32.172Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 0,
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

GET /api/v1/ideas

Get all ideas

Parameters

Name Description
q Sub-string to match against idea name or ID
spam When 'true', shows ideas that have been marked as spam. By default, no spam ideas will be shown.
workflow_status When present, filters to ideas with the provided workflow status ID or name

GET /api/v1/ideas

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "506957205",
        "body": "Description of idea 3",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "478357480",
        "body": "Description of idea custom tables",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    },
    {
      "id": "397084149",
      "reference_num": "PRJ1-I-6",
      "name": "Some idea name 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "868056987",
        "body": "Description of idea endorsement 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-6",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-6"
    },
    {
      "id": "290908627",
      "reference_num": "PRJ1-I-9",
      "name": "Some idea name 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "6580369012658381112",
        "body": "",
        "created_at": "2018-07-20T18:32:32.695Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-9",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-9"
    },
    {
      "id": "245519441",
      "reference_num": "PRJ1-I-7",
      "name": "Some idea name 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "716451363",
        "body": "Description of idea endorsement 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-7",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-7"
    },
    {
      "id": "140490859",
      "reference_num": "PRJ1-I-8",
      "name": "Some idea name 3",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "6580369012871242895",
        "body": "",
        "created_at": "2018-07-20T18:32:32.745Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-8",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-8"
    }
  ],
  "pagination": {
    "total_records": 8,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas

Get all ideas with a particular workflow status by ID

Parameters

Name Description
q Sub-string to match against idea name or ID
spam When 'true', shows ideas that have been marked as spam. By default, no spam ideas will be shown.
workflow_status When present, filters to ideas with the provided workflow status ID or name

GET /api/v1/ideas

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "506957205",
        "body": "Description of idea 3",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "478357480",
        "body": "Description of idea custom tables",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    },
    {
      "id": "397084149",
      "reference_num": "PRJ1-I-6",
      "name": "Some idea name 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "868056987",
        "body": "Description of idea endorsement 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-6",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-6"
    },
    {
      "id": "290908627",
      "reference_num": "PRJ1-I-9",
      "name": "Some idea name 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "6580369014065864176",
        "body": "",
        "created_at": "2018-07-20T18:32:33.021Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-9",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-9"
    },
    {
      "id": "245519441",
      "reference_num": "PRJ1-I-7",
      "name": "Some idea name 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "716451363",
        "body": "Description of idea endorsement 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-7",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-7"
    },
    {
      "id": "140490859",
      "reference_num": "PRJ1-I-8",
      "name": "Some idea name 3",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "6580369014283043444",
        "body": "",
        "created_at": "2018-07-20T18:32:33.074Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-8",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-8"
    }
  ],
  "pagination": {
    "total_records": 8,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas?workflow_status=1009437757&fields=*%2Cworkflow_status

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas?workflow_status=1009437757&fields=*%2Cworkflow_status" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "1055237874",
      "name": "Idea 3 Merged",
      "reference_num": "PRJ1-I-3",
      "score": 0,
      "created_at": "2018-07-20T18:31:43.000Z",
      "updated_at": "2018-07-20T18:31:43.000Z",
      "product_id": 131414752,
      "votes": 0,
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "506957205",
        "body": "Description of idea 3",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "visibility": "Visible to anyone",
      "duplicate_of": {
        "id": "444379319",
        "reference_num": "PRJ1-I-2",
        "name": "Idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "workflow_status": {
          "id": "1009437757",
          "name": "In progress",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f"
        },
        "description": {
          "id": "378547141",
          "body": "Description of idea 2",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
        "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3",
      "product": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      },
      "created_by_portal_user": {
        "id": "646391926",
        "name": "John Long",
        "email": "john@long.com",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      "assigned_to_user": null,
      "feature": {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
        "product_id": 131414752
      },
      "endorsements_count": 0,
      "comments_count": 0,
      "score_facts": [

      ],
      "tags": [

      ],
      "full_tags": [

      ],
      "categories": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "444379319",
      "name": "Idea 2",
      "reference_num": "PRJ1-I-2",
      "score": 0,
      "created_at": "2018-07-20T18:31:43.000Z",
      "updated_at": "2018-07-20T18:31:43.000Z",
      "product_id": 131414752,
      "votes": 0,
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "visibility": "Visible to anyone",
      "duplicates": [
        {
          "id": "1055237874",
          "reference_num": "PRJ1-I-3",
          "name": "Idea 3 Merged",
          "created_at": "2018-07-20T18:31:43.000Z",
          "workflow_status": {
            "id": "1009437757",
            "name": "In progress",
            "position": 2,
            "complete": false,
            "color": "#ecdd8f"
          },
          "description": {
            "id": "506957205",
            "body": "Description of idea 3",
            "created_at": "2018-07-20T18:31:43.000Z",
            "attachments": [

            ]
          },
          "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
          "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
        }
      ],
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
      "product": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      },
      "created_by_portal_user": {
        "id": "646391926",
        "name": "John Long",
        "email": "john@long.com",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      "assigned_to_user": null,
      "feature": {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
        "product_id": 131414752
      },
      "endorsements_count": 1,
      "comments_count": 0,
      "score_facts": [

      ],
      "tags": [

      ],
      "full_tags": [

      ],
      "categories": [

      ],
      "custom_fields": [

      ]
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas

Get all ideas with a particular workflow status by name

Parameters

Name Description
q Sub-string to match against idea name or ID
spam When 'true', shows ideas that have been marked as spam. By default, no spam ideas will be shown.
workflow_status When present, filters to ideas with the provided workflow status ID or name

GET /api/v1/ideas

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "506957205",
        "body": "Description of idea 3",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "478357480",
        "body": "Description of idea custom tables",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    },
    {
      "id": "397084149",
      "reference_num": "PRJ1-I-6",
      "name": "Some idea name 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "868056987",
        "body": "Description of idea endorsement 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-6",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-6"
    },
    {
      "id": "290908627",
      "reference_num": "PRJ1-I-9",
      "name": "Some idea name 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "6580369016379165000",
        "body": "",
        "created_at": "2018-07-20T18:32:33.563Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-9",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-9"
    },
    {
      "id": "245519441",
      "reference_num": "PRJ1-I-7",
      "name": "Some idea name 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "716451363",
        "body": "Description of idea endorsement 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-7",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-7"
    },
    {
      "id": "140490859",
      "reference_num": "PRJ1-I-8",
      "name": "Some idea name 3",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "6580369016660501818",
        "body": "",
        "created_at": "2018-07-20T18:32:33.629Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-8",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-8"
    }
  ],
  "pagination": {
    "total_records": 8,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas?workflow_status=In+progress&fields=*%2Cworkflow_status

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas?workflow_status=In+progress&fields=*%2Cworkflow_status" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "1055237874",
      "name": "Idea 3 Merged",
      "reference_num": "PRJ1-I-3",
      "score": 0,
      "created_at": "2018-07-20T18:31:43.000Z",
      "updated_at": "2018-07-20T18:31:43.000Z",
      "product_id": 131414752,
      "votes": 0,
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "506957205",
        "body": "Description of idea 3",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "visibility": "Visible to anyone",
      "duplicate_of": {
        "id": "444379319",
        "reference_num": "PRJ1-I-2",
        "name": "Idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "workflow_status": {
          "id": "1009437757",
          "name": "In progress",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f"
        },
        "description": {
          "id": "378547141",
          "body": "Description of idea 2",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
        "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3",
      "product": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      },
      "created_by_portal_user": {
        "id": "646391926",
        "name": "John Long",
        "email": "john@long.com",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      "assigned_to_user": null,
      "feature": {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
        "product_id": 131414752
      },
      "endorsements_count": 0,
      "comments_count": 0,
      "score_facts": [

      ],
      "tags": [

      ],
      "full_tags": [

      ],
      "categories": [

      ],
      "custom_fields": [

      ]
    },
    {
      "id": "444379319",
      "name": "Idea 2",
      "reference_num": "PRJ1-I-2",
      "score": 0,
      "created_at": "2018-07-20T18:31:43.000Z",
      "updated_at": "2018-07-20T18:31:43.000Z",
      "product_id": 131414752,
      "votes": 0,
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "visibility": "Visible to anyone",
      "duplicates": [
        {
          "id": "1055237874",
          "reference_num": "PRJ1-I-3",
          "name": "Idea 3 Merged",
          "created_at": "2018-07-20T18:31:43.000Z",
          "workflow_status": {
            "id": "1009437757",
            "name": "In progress",
            "position": 2,
            "complete": false,
            "color": "#ecdd8f"
          },
          "description": {
            "id": "506957205",
            "body": "Description of idea 3",
            "created_at": "2018-07-20T18:31:43.000Z",
            "attachments": [

            ]
          },
          "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
          "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
        }
      ],
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
      "product": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2018-07-20T18:31:43.000Z"
      },
      "created_by_portal_user": {
        "id": "646391926",
        "name": "John Long",
        "email": "john@long.com",
        "created_at": "2018-07-20T18:31:42.000Z"
      },
      "assigned_to_user": null,
      "feature": {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "url": "http://account1.example.org/features/PRJ1-1",
        "resource": "http://account1.example.org/api/v1/features/PRJ1-1",
        "product_id": 131414752
      },
      "endorsements_count": 1,
      "comments_count": 0,
      "score_facts": [

      ],
      "tags": [

      ],
      "full_tags": [

      ],
      "categories": [

      ],
      "custom_fields": [

      ]
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/products/:product_id/ideas

Get all ideas for a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve ideas for
sort Sorting of the list of ideas, can be either recent, trending, popular

GET /api/v1/products/PRJ1/ideas?sort=trending

Example CURL command

curl -g "https://account1.aha.io/api/v1/products/PRJ1/ideas?sort=trending" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "506957205",
        "body": "Description of idea 3",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "478357480",
        "body": "Description of idea custom tables",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas

Get ideas created after a certain time

Parameters

Name Description
created_since Filter all ideas created after this DateTime. Should be specified as an ISO8601 string

GET /api/v1/ideas?created_since=2017-07-20T18%3A32%3A34Z

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas?created_since=2017-07-20T18%3A32%3A34Z" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "506957205",
        "body": "Description of idea 3",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "478357480",
        "body": "Description of idea custom tables",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "397084149",
      "reference_num": "PRJ1-I-6",
      "name": "Some idea name 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "868056987",
        "body": "Description of idea endorsement 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-6",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-6"
    },
    {
      "id": "290908627",
      "reference_num": "PRJ1-I-9",
      "name": "Some idea name 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "6580369019865229378",
        "body": "",
        "created_at": "2018-07-20T18:32:34.373Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-9",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-9"
    },
    {
      "id": "245519441",
      "reference_num": "PRJ1-I-7",
      "name": "Some idea name 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "716451363",
        "body": "Description of idea endorsement 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-7",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-7"
    },
    {
      "id": "140490859",
      "reference_num": "PRJ1-I-8",
      "name": "Some idea name 3",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "6580369020121713136",
        "body": "",
        "created_at": "2018-07-20T18:32:34.432Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-8",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-8"
    }
  ],
  "pagination": {
    "total_records": 7,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas

Get ideas created before a certain time

Parameters

Name Description
created_before Filter all ideas created before this DateTime. Should be specified as an ISO8601 string

GET /api/v1/ideas?created_before=2017-07-20T18%3A32%3A34Z

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas?created_before=2017-07-20T18%3A32%3A34Z" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2016-07-20T18:32:34.614Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas

Search ideas by name or ID

Parameters

Name Description
q Sub-string to match against idea name or ID

GET /api/v1/ideas?q=dea

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas?q=dea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "506957205",
        "body": "Description of idea 3",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "478357480",
        "body": "Description of idea custom tables",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    },
    {
      "id": "397084149",
      "reference_num": "PRJ1-I-6",
      "name": "Some idea name 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "868056987",
        "body": "Description of idea endorsement 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-6",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-6"
    },
    {
      "id": "290908627",
      "reference_num": "PRJ1-I-9",
      "name": "Some idea name 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "6580369022143943811",
        "body": "",
        "created_at": "2018-07-20T18:32:34.901Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-9",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-9"
    },
    {
      "id": "245519441",
      "reference_num": "PRJ1-I-7",
      "name": "Some idea name 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "716451363",
        "body": "Description of idea endorsement 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-7",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-7"
    },
    {
      "id": "140490859",
      "reference_num": "PRJ1-I-8",
      "name": "Some idea name 3",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "6580369022318916174",
        "body": "",
        "created_at": "2018-07-20T18:32:34.945Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-8",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-8"
    }
  ],
  "pagination": {
    "total_records": 8,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/products/:product_id/ideas

Search product for ideas by name or ID

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve ideas for
q Sub-string to match against idea name or ID

GET /api/v1/products/PRJ1/ideas?q=dea

Example CURL command

curl -g "https://account1.aha.io/api/v1/products/PRJ1/ideas?q=dea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "506957205",
        "body": "Description of idea 3",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "478357480",
        "body": "Description of idea custom tables",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas

Search ideas by tag

Parameters

Name Description
tag A string tag value.

GET /api/v1/ideas?tag=Infrastructure

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas?tag=Infrastructure" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6"
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2018-07-20T18:31:43.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas/:id

Get a specific idea

Parameters

Name Description
id * Numeric ID, or key of the idea to be retrieved

GET /api/v1/ideas/PRJ1-I-1

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-1" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "58056975",
    "name": "Idea 1",
    "reference_num": "PRJ1-I-1",
    "score": 15,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:31:43.000Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 1,
    "comments_count": 0,
    "score_facts": [
      {
        "id": "244026645",
        "value": 10,
        "name": "Effort"
      },
      {
        "id": "394452137",
        "value": 5,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/PRJ1-I-1

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-1" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "58056975",
    "name": "Idea 1",
    "reference_num": "PRJ1-I-1",
    "score": 15,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:32:35.789Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "admin_response": {
      "id": "6580369025849092534",
      "body": "This is a great idea! We'll get started right away.",
      "created_at": "2018-07-20T18:32:35.765Z",
      "attachments": [

      ],
      "responded_by_user": {
        "id": "869174989",
        "name": "Dirk Gently",
        "email": "dirk.gently@account1.com",
        "created_at": "2018-07-20T18:31:42.000Z",
        "updated_at": "2018-07-20T18:31:42.000Z"
      }
    },
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:32:35.797Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 1,
    "comments_count": 0,
    "score_facts": [
      {
        "id": "244026645",
        "value": 10,
        "name": "Effort"
      },
      {
        "id": "394452137",
        "value": 5,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/:id

Ensure visibility is present

Parameters

Name Description
id * Numeric ID, or key of the idea to be retrieved

GET /api/v1/ideas/PRJ1-I-1

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-1" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "58056975",
    "name": "Idea 1",
    "reference_num": "PRJ1-I-1",
    "score": 15,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:31:43.000Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 1,
    "comments_count": 0,
    "score_facts": [
      {
        "id": "244026645",
        "value": 10,
        "name": "Effort"
      },
      {
        "id": "394452137",
        "value": 5,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/PRJ1-I-1

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-1" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "58056975",
    "name": "Idea 1",
    "reference_num": "PRJ1-I-1",
    "score": 15,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:31:43.000Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 1,
    "comments_count": 0,
    "score_facts": [
      {
        "id": "244026645",
        "value": 10,
        "name": "Effort"
      },
      {
        "id": "394452137",
        "value": 5,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/:id

Get duplicates of a specific idea

Parameters

Name Description
id * Numeric ID, or key of the idea to be retrieved
duplicates * whether duplicates are returned in the response

GET /api/v1/ideas/PRJ1-I-1?duplicates=true

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-1?duplicates=true" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "58056975",
    "name": "Idea 1",
    "reference_num": "PRJ1-I-1",
    "score": 15,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:31:43.000Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:31:42.000Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 1,
    "comments_count": 0,
    "score_facts": [
      {
        "id": "244026645",
        "value": 10,
        "name": "Effort"
      },
      {
        "id": "394452137",
        "value": 5,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/PRJ1-I-1?duplicates=true

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-1?duplicates=true" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "58056975",
    "name": "Idea 1",
    "reference_num": "PRJ1-I-1",
    "score": 15,
    "created_at": "2018-07-20T18:31:43.000Z",
    "updated_at": "2018-07-20T18:32:37.115Z",
    "product_id": 131414752,
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2018-07-20T18:31:43.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "duplicates": [
      {
        "id": "444379319",
        "reference_num": "PRJ1-I-2",
        "name": "Idea 2",
        "created_at": "2018-07-20T18:31:43.000Z",
        "workflow_status": {
          "id": "3259216",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "description": {
          "id": "378547141",
          "body": "Description of idea 2",
          "created_at": "2018-07-20T18:31:43.000Z",
          "attachments": [

          ]
        },
        "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
        "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
      }
    ],
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2018-07-20T18:31:43.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2018-07-20T18:31:42.000Z",
      "updated_at": "2018-07-20T18:32:37.124Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 1,
    "comments_count": 0,
    "score_facts": [
      {
        "id": "244026645",
        "value": 10,
        "name": "Effort"
      },
      {
        "id": "394452137",
        "value": 5,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2018-07-20T18:31:42.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/:id

Get ideas that a specific idea duplicates

Parameters

Name Description
id * Numeric ID, or key of the idea to be retrieved
duplicates * whether duplicates are returned in the response

GET /api/v1/ideas/PRJ1-I-2?duplicates=true

Example CURL command

curl -g "https://account1.aha.io/api/v1/ideas/PRJ1-I-2?duplicates=true" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-