Ideas API


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

Create an idea

Parameters

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

POST /api/v1/products/PRJ1/ideas

Example CURL command

curl "https://secure.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 "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": "6411303704000416976",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2017-04-21T04:12:48.063Z",
    "updated_at": "2017-04-21T04:12:48.105Z",
    "product_id": "131414752",
    "votes": 3,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6411303704092503824",
      "body": "<p>This is the description</p>",
      "created_at": "2017-04-21T04:12:48.080Z",
      "attachments": [

      ]
    },
    "visibility": "Not visible in portal",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:48.121Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

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

Create an idea created by a Idea Portal user

Parameters

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

POST /api/v1/products/PRJ1/ideas

Example CURL command

curl "https://secure.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 "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": "6411303705949660837",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2017-04-21T04:12:48.517Z",
    "updated_at": "2017-04-21T04:12:48.556Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6411303706043329515",
      "body": "",
      "created_at": "2017-04-21T04:12:48.533Z",
      "attachments": [

      ]
    },
    "visibility": "Not visible in portal",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_portal_user": {
      "id": "646391926",
      "name": "John Long",
      "email": "john@long.com",
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

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

Create an idea with comma-separated tags

Parameters

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

POST /api/v1/products/PRJ1/ideas

Example CURL command

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

Request

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

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6411303707326997752",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2017-04-21T04:12:48.837Z",
    "updated_at": "2017-04-21T04:12:48.943Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6411303707690574065",
      "body": "",
      "created_at": "2017-04-21T04:12:48.920Z",
      "attachments": [

      ]
    },
    "visibility": "Not visible in portal",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:48.959Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 0,
    "score_facts": [

    ],
    "tags": [
      "tag1",
      "tag2"
    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

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

Create an idea with a score

Parameters

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

POST /api/v1/products/PRJ1/ideas

Example CURL command

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

Request

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

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6411303711648940773",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 9,
    "created_at": "2017-04-21T04:12:49.840Z",
    "updated_at": "2017-04-21T04:12:49.954Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6411303711863975347",
      "body": "",
      "created_at": "2017-04-21T04:12:49.889Z",
      "attachments": [

      ]
    },
    "visibility": "Not visible in portal",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:49.956Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 0,
    "score_facts": [
      {
        "id": "6411303712083086659",
        "value": 3,
        "name": "Effort"
      },
      {
        "id": "6411303711700083226",
        "value": 12,
        "name": "Impact"
      }
    ],
    "tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

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

Create an idea with custom fields

Parameters

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

POST /api/v1/products/PRJ1/ideas

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": "6411303712947169612",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2017-04-21T04:12:50.144Z",
    "updated_at": "2017-04-21T04:12:50.194Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6411303713022165039",
      "body": "",
      "created_at": "2017-04-21T04:12:50.159Z",
      "attachments": [

      ]
    },
    "visibility": "Not visible in portal",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:50.205Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "categories": [

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

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

Create an idea with a specific visiblity

Parameters

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

POST /api/v1/products/PRJ1/ideas

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": "6411303713800571046",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2017-04-21T04:12:50.342Z",
    "updated_at": "2017-04-21T04:12:50.376Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6411303713857529637",
      "body": "",
      "created_at": "2017-04-21T04:12:50.356Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:50.391Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

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

Create an idea with a creation date

Parameters

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

POST /api/v1/products/PRJ1/ideas

Example CURL command

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

Request

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

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "6411303715493152717",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2014-01-11T00:01:02.000Z",
    "updated_at": "2017-04-21T04:12:50.774Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6411303715571800676",
      "body": "",
      "created_at": "2017-04-21T04:12:50.754Z",
      "attachments": [

      ]
    },
    "visibility": "Not visible in portal",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:50.789Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

GET /api/v1/ideas

Get all ideas

Parameters

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

GET /api/v1/ideas

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/products/:product_id/ideas

Get all ideas for a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve ideas for
sort Sorting of the list of ideas, can be either recent, trending, popular

GET /api/v1/products/PRJ1/ideas?sort=trending

Example CURL command

curl "https://secure.aha.io/api/v1/products/PRJ1/ideas?sort=trending" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas

Get ideas created after a certain time

Parameters

Name Description
created_since Filter all ideas created after this DateTime. Should be specified as an ISO8601 string

GET /api/v1/ideas?created_since=2016-04-21T04%3A12%3A51Z

Example CURL command

curl "https://secure.aha.io/api/v1/ideas?created_since=2016-04-21T04%3A12%3A51Z" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas

Get ideas created before a certain time

Parameters

Name Description
created_before Filter all ideas created before this DateTime. Should be specified as an ISO8601 string

GET /api/v1/ideas?created_before=2016-04-21T04%3A12%3A51Z

Example CURL command

curl "https://secure.aha.io/api/v1/ideas?created_before=2016-04-21T04%3A12%3A51Z" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": "2015-04-21T04:12:51.317Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

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

GET /api/v1/ideas

Search ideas by name or ID

Parameters

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

GET /api/v1/ideas?q=dea

Example CURL command

curl "https://secure.aha.io/api/v1/ideas?q=dea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/products/:product_id/ideas

Search product for ideas by name or ID

Parameters

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

GET /api/v1/products/PRJ1/ideas?q=dea

Example CURL command

curl "https://secure.aha.io/api/v1/products/PRJ1/ideas?q=dea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "ideas": [
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas

Search ideas by tag

Parameters

Name Description
tag A string tag value.

GET /api/v1/ideas?tag=Infrastructure

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

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

GET /api/v1/ideas/:id

Get a specific idea

Parameters

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

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

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": 0,
    "created_at": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:25.000Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:25.000Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Infrastructure"
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2017-04-21T04:12:25.000Z"
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

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

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": 0,
    "created_at": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:51.897Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "admin_response": {
      "id": "6411303720112993796",
      "body": "This is a great idea! We'll get started right away.",
      "created_at": "2017-04-21T04:12:51.812Z",
      "attachments": [

      ],
      "responded_by_user": {
        "id": "501775768",
        "name": "Frank Sane",
        "email": "frank.sane@account2.com",
        "created_at": "2017-04-21T04:12:25.000Z",
        "updated_at": "2017-04-21T04:12:25.000Z"
      }
    },
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:51.902Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Infrastructure"
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2017-04-21T04:12:25.000Z"
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/:id

Ensure visibility is present

Parameters

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

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

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": 0,
    "created_at": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:25.000Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:25.000Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Infrastructure"
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2017-04-21T04:12:25.000Z"
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

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

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": 0,
    "created_at": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:25.000Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:25.000Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Infrastructure"
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2017-04-21T04:12:25.000Z"
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/:id

Get duplicates of a specific idea

Parameters

Name Description
id * Numeric ID, or key of the idea to be retrieved
duplicates * whether duplicates are returned in the response

GET /api/v1/ideas/PRJ1-I-1?duplicates=true

Example CURL command

curl "https://secure.aha.io/api/v1/ideas/PRJ1-I-1?duplicates=true" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": 0,
    "created_at": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:25.000Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:25.000Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Infrastructure"
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2017-04-21T04:12:25.000Z"
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/PRJ1-I-1?duplicates=true

Example CURL command

curl "https://secure.aha.io/api/v1/ideas/PRJ1-I-1?duplicates=true" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": 0,
    "created_at": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:52.256Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "duplicates": [
      {
        "id": "444379319",
        "reference_num": "PRJ1-I-2",
        "name": "Idea 2",
        "created_at": "2017-04-21T04:12:25.000Z",
        "workflow_status": {
          "id": "3259216",
          "name": "New",
          "complete": false
        },
        "description": {
          "id": "378547141",
          "body": "Description of idea 2",
          "created_at": "2017-04-21T04:12:25.000Z",
          "attachments": [

          ]
        },
        "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
        "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
      }
    ],
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:52.261Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Infrastructure"
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2017-04-21T04:12:25.000Z"
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/:id

Get ideas that a specific idea duplicates

Parameters

Name Description
id * Numeric ID, or key of the idea to be retrieved
duplicates * whether duplicates are returned in the response

GET /api/v1/ideas/PRJ1-I-2?duplicates=true

Example CURL command

curl "https://secure.aha.io/api/v1/ideas/PRJ1-I-2?duplicates=true" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:25.000Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "1009437757",
      "name": "In progress",
      "complete": false
    },
    "description": {
      "id": "378547141",
      "body": "Description of idea 2",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

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

    ],
    "tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

GET /api/v1/ideas/PRJ1-I-2?duplicates=true

Example CURL command

curl "https://secure.aha.io/api/v1/ideas/PRJ1-I-2?duplicates=true" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:52.572Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "378547141",
      "body": "Description of idea 2",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "duplicate_of": {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-04-21T04:12:25.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    },
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_portal_user": {
      "id": "646391926",
      "name": "John Long",
      "email": "john@long.com",
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

GET /api/v1/ideas/related

Get all ideas related to a specific idea

Parameters

Name Description
q Query string to search against idea name, description or ID

GET /api/v1/ideas/related?q=ideas+are+a+dime+a+dozen

Example CURL command

curl "https://secure.aha.io/api/v1/ideas/related?q=ideas+are+a+dime+a+dozen" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

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

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

PUT /api/v1/ideas/:id

Update an idea

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 - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature_id Feature ID of the feature that the idea was promoted to
initiative_id Initiative ID of the initiative 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)

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

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json
{
  "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": 0,
    "created_at": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:52.886Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "New description",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:52.906Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Infrastructure"
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2017-04-21T04:12:25.000Z"
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/ideas/:id

Update an idea's 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 - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature_id Feature ID of the feature that the idea was promoted to
initiative_id Initiative ID of the initiative 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)

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

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": 0,
    "created_at": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:53.071Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:53.089Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Infrastructure"
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2017-04-21T04:12:25.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "priority",
        "name": "Priority",
        "value": "P3",
        "type": "string"
      }
    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/ideas/:id

Update an idea's visibility

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 - note that in a CSV file quotes must be used around fields that contain commas.
created_by * Email address of user that created the idea. The email address does not need to be for a user of Aha!
assigned_to_user Email address of user that is assigned the idea.
feature_id Feature ID of the feature that the idea was promoted to
initiative_id Initiative ID of the initiative 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)

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

Example CURL command

curl "https://secure.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"visibility":"public"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
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": 0,
    "created_at": "2017-04-21T04:12:25.000Z",
    "updated_at": "2017-04-21T04:12:53.230Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-04-21T04:12:25.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
    "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-04-21T04:12:25.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-04-21T04:12:25.000Z",
      "updated_at": "2017-04-21T04:12:53.238Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 1,
    "score_facts": [

    ],
    "tags": [
      "Infrastructure"
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2017-04-21T04:12:25.000Z"
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

DELETE /api/v1/ideas/:id

Delete an idea

Parameters

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

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

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Overview

API Resources