Ideas API
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. |
| 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) |
Example Request
POST /api/v1/products/PRJ1/ideas
Example CURL command
curl "https://company.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": "6743665276499463894",
"name": "New idea",
"reference_num": "PRJ1-I-10",
"score": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 3,
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665276544624971",
"body": "<p>This is the description</p>",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-10",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-10",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": null,
"endorsements_count": 0,
"comments_count": 0,
"score_facts": [
],
"tags": [
],
"full_tags": [
],
"categories": [
],
"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. |
| 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) |
Example Request
POST /api/v1/products/PRJ1/ideas
Example CURL command
curl "https://company.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": "6743665278389798938",
"name": "New idea",
"reference_num": "PRJ1-I-10",
"score": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 0,
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665278445198043",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-10",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-10",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_portal_user": {
"id": "646391926",
"name": "John Long",
"email": "john@long.com",
"created_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": null,
"endorsements_count": 0,
"comments_count": 0,
"score_facts": [
],
"tags": [
],
"full_tags": [
],
"categories": [
],
"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. |
| 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) |
Example Request
POST /api/v1/products/PRJ1/ideas
Example CURL command
curl "https://company.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": "6743665283905582278",
"name": "New idea",
"reference_num": "PRJ1-I-10",
"score": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 0,
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665284211030450",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-10",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-10",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "689956296",
"name": "Henry Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
}
]
}
}
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. |
| 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) |
Example Request
POST /api/v1/products/PRJ1/ideas
Example CURL command
curl "https://company.aha.io/api/v1/products/PRJ1/ideas" -d '{"idea":{"name":"New idea","score_facts":[{"name":"Benefit","value":10},{"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": 10
},
{
"name": "Effort",
"value": 3
}
]
}
}
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"idea": {
"id": "6743665285252997353",
"name": "New idea",
"reference_num": "PRJ1-I-10",
"score": 13,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 0,
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665285348589563",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-10",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-10",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": null,
"endorsements_count": 0,
"comments_count": 0,
"score_facts": [
{
"id": "6743665285446300161",
"value": 3,
"name": "Effort"
},
{
"id": "6743665285292234365",
"value": 10,
"name": "Benefit"
}
],
"tags": [
],
"full_tags": [
],
"categories": [
],
"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. |
| 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) |
Example Request
POST /api/v1/products/PRJ1/ideas
Example CURL command
curl "https://company.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": "6743665286412082063",
"name": "New idea",
"reference_num": "PRJ1-I-10",
"score": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 0,
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665286450214513",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-10",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-10",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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"
}
]
}
}
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. |
| 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) |
Example Request
POST /api/v1/products/PRJ1/ideas
Example CURL command
curl "https://company.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": "6743665287441763553",
"name": "New idea",
"reference_num": "PRJ1-I-10",
"score": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 0,
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665287480781051",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-10",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-10",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": null,
"endorsements_count": 0,
"comments_count": 0,
"score_facts": [
],
"tags": [
],
"full_tags": [
],
"categories": [
],
"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. |
| 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) |
Example Request
POST /api/v1/products/PRJ1/ideas
Example CURL command
curl "https://company.aha.io/api/v1/products/PRJ1/ideas" -d '{"idea":{"name":"New idea","created_at":"2019-01-01T00:00:00Z"}}' -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": "2019-01-01T00:00:00Z"
}
}
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"idea": {
"id": "6743665290280566736",
"name": "New idea",
"reference_num": "PRJ1-I-10",
"score": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 0,
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665290316704919",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-10",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-10",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": null,
"endorsements_count": 0,
"comments_count": 0,
"score_facts": [
],
"tags": [
],
"full_tags": [
],
"categories": [
],
"custom_fields": [
]
}
}
Parameters
| Name | Description |
|---|---|
| q | Sub-string to match against idea name |
| 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 |
Example Request
GET /api/v1/ideas
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
},
{
"id": "857675141",
"reference_num": "PRJ1-I-11",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665291673630411",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-11",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-11"
},
{
"id": "849214356",
"reference_num": "PRJ2-I-1",
"name": "Idea 1 project 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "5445688",
"body": "Description of idea 1 project2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ2-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-1"
},
{
"id": "731163180",
"reference_num": "PRJ2-I-2",
"name": "Idea 2 project 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "928262307",
"body": "Description of idea 2 project2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ2-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-2"
},
{
"id": "444379319",
"reference_num": "PRJ1-I-2",
"name": "Idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2"
},
{
"id": "162120796",
"reference_num": "PRJ1-I-5",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "478357480",
"body": "Description of idea custom tables",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-5",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-5"
},
{
"id": "68691224",
"reference_num": "PRJ1-I-12",
"name": "Idea 5",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665292036439086",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-12",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-12"
},
{
"id": "58056975",
"reference_num": "PRJ1-I-1",
"name": "Idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
},
{
"id": "397084149",
"reference_num": "PRJ1-I-6",
"name": "Some idea name 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "868056987",
"body": "Description of idea endorsement 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-6",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-6"
},
{
"id": "290908627",
"reference_num": "PRJ1-I-9",
"name": "Some idea name 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665292283623289",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-9",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-9"
},
{
"id": "245519441",
"reference_num": "PRJ1-I-7",
"name": "Some idea name 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "716451363",
"body": "Description of idea endorsement 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-7",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-7"
},
{
"id": "140490859",
"reference_num": "PRJ1-I-8",
"name": "Some idea name 3",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665292462536586",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-8",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8"
}
],
"pagination": {
"total_records": 12,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| q | Sub-string to match against idea name |
| 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 |
Example Request
GET /api/v1/ideas
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
},
{
"id": "857675141",
"reference_num": "PRJ1-I-11",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665293395405149",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-11",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-11"
},
{
"id": "849214356",
"reference_num": "PRJ2-I-1",
"name": "Idea 1 project 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "5445688",
"body": "Description of idea 1 project2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ2-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-1"
},
{
"id": "731163180",
"reference_num": "PRJ2-I-2",
"name": "Idea 2 project 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "928262307",
"body": "Description of idea 2 project2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ2-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-2"
},
{
"id": "444379319",
"reference_num": "PRJ1-I-2",
"name": "Idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2"
},
{
"id": "162120796",
"reference_num": "PRJ1-I-5",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "478357480",
"body": "Description of idea custom tables",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-5",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-5"
},
{
"id": "68691224",
"reference_num": "PRJ1-I-12",
"name": "Idea 5",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665293748017975",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-12",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-12"
},
{
"id": "58056975",
"reference_num": "PRJ1-I-1",
"name": "Idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
},
{
"id": "397084149",
"reference_num": "PRJ1-I-6",
"name": "Some idea name 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "868056987",
"body": "Description of idea endorsement 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-6",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-6"
},
{
"id": "290908627",
"reference_num": "PRJ1-I-9",
"name": "Some idea name 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665293983446411",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-9",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-9"
},
{
"id": "245519441",
"reference_num": "PRJ1-I-7",
"name": "Some idea name 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "716451363",
"body": "Description of idea endorsement 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-7",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-7"
},
{
"id": "140490859",
"reference_num": "PRJ1-I-8",
"name": "Some idea name 3",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665294177392926",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-8",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8"
}
],
"pagination": {
"total_records": 12,
"total_pages": 1,
"current_page": 1
}
}
Example Request
GET /api/v1/ideas?workflow_status=1009437757&fields=*%2Cworkflow_status
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 2,
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"duplicate_of": {
"id": "444379319",
"reference_num": "PRJ1-I-2",
"name": "Idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2"
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_portal_user": {
"id": "646391926",
"name": "John Long",
"email": "john@long.com",
"created_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": null,
"feature": {
"id": "1007868956",
"reference_num": "PRJ1-1",
"name": "Feature 1",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/features/PRJ1-1",
"resource": "http://company.aha.io/api/v1/features/PRJ1-1",
"product_id": 131414752
},
"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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 1,
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"duplicates": [
{
"id": "1055237874",
"reference_num": "PRJ1-I-3",
"name": "Idea 3 Merged",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
}
],
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_portal_user": {
"id": "646391926",
"name": "John Long",
"email": "john@long.com",
"created_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": {
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"default_assignee": false
},
"feature": {
"id": "1007868956",
"reference_num": "PRJ1-1",
"name": "Feature 1",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/features/PRJ1-1",
"resource": "http://company.aha.io/api/v1/features/PRJ1-1",
"product_id": 131414752
},
"endorsements_count": 1,
"comments_count": 0,
"score_facts": [
],
"tags": [
],
"full_tags": [
],
"categories": [
],
"custom_fields": [
]
}
],
"pagination": {
"total_records": 2,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| q | Sub-string to match against idea name |
| 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 |
Example Request
GET /api/v1/ideas
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
},
{
"id": "857675141",
"reference_num": "PRJ1-I-11",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665295892763307",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-11",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-11"
},
{
"id": "849214356",
"reference_num": "PRJ2-I-1",
"name": "Idea 1 project 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "5445688",
"body": "Description of idea 1 project2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ2-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-1"
},
{
"id": "731163180",
"reference_num": "PRJ2-I-2",
"name": "Idea 2 project 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "928262307",
"body": "Description of idea 2 project2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ2-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-2"
},
{
"id": "444379319",
"reference_num": "PRJ1-I-2",
"name": "Idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2"
},
{
"id": "162120796",
"reference_num": "PRJ1-I-5",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "478357480",
"body": "Description of idea custom tables",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-5",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-5"
},
{
"id": "68691224",
"reference_num": "PRJ1-I-12",
"name": "Idea 5",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665296299090901",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-12",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-12"
},
{
"id": "58056975",
"reference_num": "PRJ1-I-1",
"name": "Idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
},
{
"id": "397084149",
"reference_num": "PRJ1-I-6",
"name": "Some idea name 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "868056987",
"body": "Description of idea endorsement 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-6",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-6"
},
{
"id": "290908627",
"reference_num": "PRJ1-I-9",
"name": "Some idea name 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665296624215848",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-9",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-9"
},
{
"id": "245519441",
"reference_num": "PRJ1-I-7",
"name": "Some idea name 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "716451363",
"body": "Description of idea endorsement 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-7",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-7"
},
{
"id": "140490859",
"reference_num": "PRJ1-I-8",
"name": "Some idea name 3",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665296821486461",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-8",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8"
}
],
"pagination": {
"total_records": 12,
"total_pages": 1,
"current_page": 1
}
}
Example Request
GET /api/v1/ideas?workflow_status=In+progress&fields=*%2Cworkflow_status
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 2,
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"duplicate_of": {
"id": "444379319",
"reference_num": "PRJ1-I-2",
"name": "Idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2"
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_portal_user": {
"id": "646391926",
"name": "John Long",
"email": "john@long.com",
"created_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": null,
"feature": {
"id": "1007868956",
"reference_num": "PRJ1-1",
"name": "Feature 1",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/features/PRJ1-1",
"resource": "http://company.aha.io/api/v1/features/PRJ1-1",
"product_id": 131414752
},
"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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 1,
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"duplicates": [
{
"id": "1055237874",
"reference_num": "PRJ1-I-3",
"name": "Idea 3 Merged",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
}
],
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_portal_user": {
"id": "646391926",
"name": "John Long",
"email": "john@long.com",
"created_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": {
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"default_assignee": false
},
"feature": {
"id": "1007868956",
"reference_num": "PRJ1-1",
"name": "Feature 1",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/features/PRJ1-1",
"resource": "http://company.aha.io/api/v1/features/PRJ1-1",
"product_id": 131414752
},
"endorsements_count": 1,
"comments_count": 0,
"score_facts": [
],
"tags": [
],
"full_tags": [
],
"categories": [
],
"custom_fields": [
]
}
],
"pagination": {
"total_records": 2,
"total_pages": 1,
"current_page": 1
}
}
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 |
Example Request
GET /api/v1/products/PRJ1/ideas?sort=trending
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
},
{
"id": "857675141",
"reference_num": "PRJ1-I-11",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665298764215899",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-11",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-11"
},
{
"id": "444379319",
"reference_num": "PRJ1-I-2",
"name": "Idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2"
},
{
"id": "162120796",
"reference_num": "PRJ1-I-5",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "478357480",
"body": "Description of idea custom tables",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-5",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-5"
},
{
"id": "68691224",
"reference_num": "PRJ1-I-12",
"name": "Idea 5",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665299025473600",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-12",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-12"
},
{
"id": "58056975",
"reference_num": "PRJ1-I-1",
"name": "Idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
}
],
"pagination": {
"total_records": 6,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| created_since | Filter all ideas created after this DateTime. Should be specified as an ISO8601 string |
Example Request
GET /api/v1/ideas?created_since=2019-01-01T19%3A45%3A32Z
Example CURL command
curl -g "https://company.aha.io/api/v1/ideas?created_since=2019-01-01T19%3A45%3A32Z" -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": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
},
{
"id": "857675141",
"reference_num": "PRJ1-I-11",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665299879270182",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-11",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-11"
},
{
"id": "849214356",
"reference_num": "PRJ2-I-1",
"name": "Idea 1 project 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "5445688",
"body": "Description of idea 1 project2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ2-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-1"
},
{
"id": "731163180",
"reference_num": "PRJ2-I-2",
"name": "Idea 2 project 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "928262307",
"body": "Description of idea 2 project2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ2-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-2"
},
{
"id": "444379319",
"reference_num": "PRJ1-I-2",
"name": "Idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2"
},
{
"id": "162120796",
"reference_num": "PRJ1-I-5",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "478357480",
"body": "Description of idea custom tables",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-5",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-5"
},
{
"id": "68691224",
"reference_num": "PRJ1-I-12",
"name": "Idea 5",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665300242095160",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-12",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-12"
},
{
"id": "397084149",
"reference_num": "PRJ1-I-6",
"name": "Some idea name 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "868056987",
"body": "Description of idea endorsement 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-6",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-6"
},
{
"id": "290908627",
"reference_num": "PRJ1-I-9",
"name": "Some idea name 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665300474791166",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-9",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-9"
},
{
"id": "245519441",
"reference_num": "PRJ1-I-7",
"name": "Some idea name 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "716451363",
"body": "Description of idea endorsement 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-7",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-7"
},
{
"id": "140490859",
"reference_num": "PRJ1-I-8",
"name": "Some idea name 3",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665300663211533",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-8",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8"
}
],
"pagination": {
"total_records": 11,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| created_before | Filter all ideas created before this DateTime. Should be specified as an ISO8601 string |
Example Request
GET /api/v1/ideas?created_before=2019-01-01T19%3A45%3A32Z
Example CURL command
curl -g "https://company.aha.io/api/v1/ideas?created_before=2019-01-01T19%3A45%3A32Z" -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": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
}
],
"pagination": {
"total_records": 1,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| q | Sub-string to match against idea name |
Example Request
GET /api/v1/ideas?q=dea
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
},
{
"id": "857675141",
"reference_num": "PRJ1-I-11",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665302040574366",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-11",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-11"
},
{
"id": "849214356",
"reference_num": "PRJ2-I-1",
"name": "Idea 1 project 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "5445688",
"body": "Description of idea 1 project2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ2-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-1"
},
{
"id": "731163180",
"reference_num": "PRJ2-I-2",
"name": "Idea 2 project 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "928262307",
"body": "Description of idea 2 project2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ2-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-2"
},
{
"id": "444379319",
"reference_num": "PRJ1-I-2",
"name": "Idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2"
},
{
"id": "162120796",
"reference_num": "PRJ1-I-5",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "478357480",
"body": "Description of idea custom tables",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-5",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-5"
},
{
"id": "68691224",
"reference_num": "PRJ1-I-12",
"name": "Idea 5",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665302426045481",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-12",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-12"
},
{
"id": "58056975",
"reference_num": "PRJ1-I-1",
"name": "Idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
},
{
"id": "397084149",
"reference_num": "PRJ1-I-6",
"name": "Some idea name 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "868056987",
"body": "Description of idea endorsement 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-6",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-6"
},
{
"id": "290908627",
"reference_num": "PRJ1-I-9",
"name": "Some idea name 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665302764785410",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-9",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-9"
},
{
"id": "245519441",
"reference_num": "PRJ1-I-7",
"name": "Some idea name 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "716451363",
"body": "Description of idea endorsement 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-7",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-7"
},
{
"id": "140490859",
"reference_num": "PRJ1-I-8",
"name": "Some idea name 3",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665302965150729",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-8",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8"
}
],
"pagination": {
"total_records": 12,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| product_id * | Numeric ID, or key of the product to retrieve ideas for |
| q | Sub-string to match against idea name |
Example Request
GET /api/v1/products/PRJ1/ideas?q=dea
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
},
{
"id": "857675141",
"reference_num": "PRJ1-I-11",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665304068819284",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-11",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-11"
},
{
"id": "444379319",
"reference_num": "PRJ1-I-2",
"name": "Idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2"
},
{
"id": "162120796",
"reference_num": "PRJ1-I-5",
"name": "Idea 4",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "478357480",
"body": "Description of idea custom tables",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-5",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-5"
},
{
"id": "68691224",
"reference_num": "PRJ1-I-12",
"name": "Idea 5",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "6743665304306325132",
"body": "",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-12",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-12"
},
{
"id": "58056975",
"reference_num": "PRJ1-I-1",
"name": "Idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
}
],
"pagination": {
"total_records": 6,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| tag | A string tag value. |
Example Request
GET /api/v1/ideas?tag=Infrastructure
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
}
],
"pagination": {
"total_records": 1,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be retrieved |
Example Request
GET /api/v1/ideas/PRJ1-I-1
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Example Request
GET /api/v1/ideas/PRJ1-I-1
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"admin_response": {
"id": "6743665305839987126",
"body": "This is a great idea! We'll get started right away.",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
],
"responded_by_user": {
"id": "530313708",
"name": "Bill Billings",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
}
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be retrieved |
Example Request
GET /api/v1/ideas/PRJ1-I-1
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Example Request
GET /api/v1/ideas/PRJ1-I-1
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be retrieved |
| duplicates * | whether duplicates are returned in the response |
Example Request
GET /api/v1/ideas/PRJ1-I-1?duplicates=true
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Example Request
GET /api/v1/ideas/PRJ1-I-1?duplicates=true
Example CURL command
curl -g "https://company.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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 1,
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"duplicates": [
{
"id": "444379319",
"reference_num": "PRJ1-I-2",
"name": "Idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2"
}
],
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be retrieved |
| duplicates * | whether duplicates are returned in the response |
Example Request
GET /api/v1/ideas/PRJ1-I-2?duplicates=true
Example CURL command
curl -g "https://company.aha.io/api/v1/ideas/PRJ1-I-2?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": "444379319",
"name": "Idea 2",
"reference_num": "PRJ1-I-2",
"score": 0,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 1,
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"duplicates": [
{
"id": "1055237874",
"reference_num": "PRJ1-I-3",
"name": "Idea 3 Merged",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "1009437757",
"name": "In progress",
"position": 2,
"complete": false,
"color": "#ecdd8f"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
}
],
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_portal_user": {
"id": "646391926",
"name": "John Long",
"email": "john@long.com",
"created_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": {
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"default_assignee": false
},
"feature": {
"id": "1007868956",
"reference_num": "PRJ1-1",
"name": "Feature 1",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/features/PRJ1-1",
"resource": "http://company.aha.io/api/v1/features/PRJ1-1",
"product_id": 131414752
},
"endorsements_count": 1,
"comments_count": 0,
"score_facts": [
],
"tags": [
],
"full_tags": [
],
"categories": [
],
"custom_fields": [
]
}
}
Example Request
GET /api/v1/ideas/PRJ1-I-2?duplicates=true
Example CURL command
curl -g "https://company.aha.io/api/v1/ideas/PRJ1-I-2?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": "444379319",
"name": "Idea 2",
"reference_num": "PRJ1-I-2",
"score": 0,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 2,
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "378547141",
"body": "Description of idea 2",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"duplicates": [
{
"id": "1055237874",
"reference_num": "PRJ1-I-3",
"name": "Idea 3 Merged",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "506957205",
"body": "Description of idea 3",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-3",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3"
}
],
"duplicate_of": {
"id": "58056975",
"reference_num": "PRJ1-I-1",
"name": "Idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-2",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_portal_user": {
"id": "646391926",
"name": "John Long",
"email": "john@long.com",
"created_at": "2019-01-01T00:00:00.000Z"
},
"assigned_to_user": {
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"default_assignee": false
},
"feature": {
"id": "1007868956",
"reference_num": "PRJ1-1",
"name": "Feature 1",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/features/PRJ1-1",
"resource": "http://company.aha.io/api/v1/features/PRJ1-1",
"product_id": 131414752
},
"endorsements_count": 1,
"comments_count": 0,
"score_facts": [
],
"tags": [
],
"full_tags": [
],
"categories": [
],
"custom_fields": [
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be edited |
| 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. |
| 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) |
Example Request
PUT /api/v1/ideas/PRJ1-I-1
Example CURL command
curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"name":"New idea 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
{
"idea": {
"name": "New idea name",
"description": "New description"
}
}
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"idea": {
"id": "58056975",
"name": "New idea name",
"reference_num": "PRJ1-I-1",
"score": 15,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": 131414752,
"votes": 0,
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "New description",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be edited |
| 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. |
| 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) |
Example Request
PUT /api/v1/ideas/PRJ1-I-1
Example CURL command
curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"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
{
"idea": {
"custom_fields": {
"priority": "P3"
}
}
}
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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
},
{
"key": "priority",
"name": "Priority",
"value": "P3",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be edited |
| 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. |
| 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) |
Example Request
PUT /api/v1/ideas/PRJ1-I-1
Example CURL command
curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"custom_fields":[{"key":"priority","value":"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
{
"idea": {
"custom_fields": [
{
"key": "priority",
"value": "P3"
}
]
}
}
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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
},
{
"key": "priority",
"name": "Priority",
"value": "P3",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be edited |
| 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. |
| 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) |
Example Request
PUT /api/v1/ideas/PRJ1-I-1
Example CURL command
curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"visibility":"public"}}' -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": {
"visibility": "public"
}
}
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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be edited |
| 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. |
| 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) |
Example Request
PUT /api/v1/ideas/PRJ1-I-1
Example CURL command
curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"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
{
"idea": {
"watchers": [
689956296
]
}
}
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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be edited |
| 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. |
| 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) |
Example Request
PUT /api/v1/ideas/PRJ1-I-1
Example CURL command
curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"feature":null}}' -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": {
"feature": null
}
}
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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be edited |
| 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. |
| 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) |
Example Request
PUT /api/v1/ideas/PRJ1-I-1
Example CURL command
curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"master_feature":null}}' -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": {
"master_feature": null
}
}
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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be edited |
| 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. |
| 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) |
Example Request
PUT /api/v1/ideas/PRJ1-I-1
Example CURL command
curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"initiative":null}}' -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": {
"initiative": null
}
}
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": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.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": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"visibility": "Visible to all ideas portal users",
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_user": {
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"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": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"key": "component",
"name": "Component",
"value": "web",
"type": "array"
},
{
"key": "custom_scorecard_definition",
"name": "Some custom scorecard definition",
"value": 11,
"type": "scorecard",
"score_facts": [
{
"id": "84642379",
"value": 10,
"name": "Effort"
}
]
},
{
"key": "text_field1",
"name": "TextField1",
"value": "Cairo",
"type": "string"
},
{
"key": "text_field2",
"name": "TextField2",
"value": "Rennes",
"type": "string"
}
],
"custom_object_links": [
{
"key": "customers_table",
"name": "Customers for custom table",
"record_type": "CustomObjectRecord",
"record_ids": [
]
}
]
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID, or key of the idea to be deleted |
Example Request
DELETE /api/v1/ideas/PRJ1-I-1
Example CURL command
curl "https://company.aha.io/api/v1/ideas/PRJ1-I-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