Ideas | API Developer Resources

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

Create an idea

Parameters

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

Example Request

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": "6453124963140069199",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2017-08-11T21:00:38.746Z",
    "updated_at": "2017-08-11T21:00:38.818Z",
    "product_id": "131414752",
    "votes": 3,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6453124963239799748",
      "body": "<p>This is the description</p>",
      "created_at": "2017-08-11T21:00:38.768Z",
      "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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:38.825Z"
    },
    "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	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://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": "6453124965582577771",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2017-08-11T21:00:39.314Z",
    "updated_at": "2017-08-11T21:00:39.444Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6453124965668585439",
      "body": "",
      "created_at": "2017-08-11T21:00:39.333Z",
      "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-08-11T21:00:11.000Z"
    },
    "created_by_portal_user": {
      "id": "646391926",
      "name": "John Long",
      "email": "john@long.com",
      "created_at": "2017-08-11T21:00:10.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	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://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": "6453124967178795741",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2017-08-11T21:00:39.683Z",
    "updated_at": "2017-08-11T21:00:39.786Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6453124967385359789",
      "body": "",
      "created_at": "2017-08-11T21:00:39.733Z",
      "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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:39.793Z"
    },
    "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	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://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": "6453124973409429730",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 9,
    "created_at": "2017-08-11T21:00:41.136Z",
    "updated_at": "2017-08-11T21:00:41.316Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6453124973640431266",
      "body": "",
      "created_at": "2017-08-11T21:00:41.190Z",
      "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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:41.325Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 0,
    "score_facts": [
      {
        "id": "6453124974036329838",
        "value": 3,
        "name": "Effort"
      },
      {
        "id": "6453124973503577261",
        "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	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://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": "6453124975174975599",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2017-08-11T21:00:41.547Z",
    "updated_at": "2017-08-11T21:00:41.636Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6453124975256147320",
      "body": "",
      "created_at": "2017-08-11T21:00:41.564Z",
      "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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:41.645Z"
    },
    "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	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://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": "6453124976564931301",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2017-08-11T21:00:41.871Z",
    "updated_at": "2017-08-11T21:00:41.942Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6453124976643786447",
      "body": "",
      "created_at": "2017-08-11T21:00:41.889Z",
      "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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:41.951Z"
    },
    "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	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://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": "6453124980558336035",
    "name": "New idea",
    "reference_num": "PRJ1-I-2",
    "score": 0,
    "created_at": "2014-01-11T00:01:02.000Z",
    "updated_at": "2017-08-11T21:00:42.876Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "6453124980639925906",
      "body": "",
      "created_at": "2017-08-11T21:00:42.821Z",
      "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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:42.886Z"
    },
    "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.

Example Request

GET /api/v1/ideas

Example CURL command

curl -g "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": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "6453124982457614941",
        "body": "",
        "created_at": "2017-08-11T21:00:43.241Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2017-08-11T21:00:10.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124982876975511",
        "body": "",
        "created_at": "2017-08-11T21:00:43.341Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-08-11T21:00:10.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    },
    {
      "id": "397084149",
      "reference_num": "PRJ1-I-6",
      "name": "Some idea name 1",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124983164206810",
        "body": "",
        "created_at": "2017-08-11T21:00:43.407Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-6",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-6"
    },
    {
      "id": "290908627",
      "reference_num": "PRJ1-I-9",
      "name": "Some idea name 4",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124983543833149",
        "body": "",
        "created_at": "2017-08-11T21:00:43.496Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-9",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-9"
    },
    {
      "id": "245519441",
      "reference_num": "PRJ1-I-7",
      "name": "Some idea name 2",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124983808028480",
        "body": "",
        "created_at": "2017-08-11T21:00:43.558Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-7",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-7"
    },
    {
      "id": "140490859",
      "reference_num": "PRJ1-I-8",
      "name": "Some idea name 3",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124984054548736",
        "body": "",
        "created_at": "2017-08-11T21:00:43.614Z",
        "attachments": [

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

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

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

Example Request

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

Example CURL command

curl -g "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": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "6453124984790661577",
        "body": "",
        "created_at": "2017-08-11T21:00:43.786Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2017-08-11T21:00:10.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124985185153686",
        "body": "",
        "created_at": "2017-08-11T21:00:43.878Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-08-11T21:00:10.000Z",
        "attachments": [

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

GET /api/v1/ideas

Get ideas created after a certain time

Parameters

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

Example Request

GET /api/v1/ideas?created_since=2016-08-11T21%3A00%3A44Z

Example CURL command

curl -g "https://secure.aha.io/api/v1/ideas?created_since=2016-08-11T21%3A00%3A44Z" -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": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "6453124985889981290",
        "body": "",
        "created_at": "2017-08-11T21:00:44.044Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2017-08-11T21:00:10.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124986278335165",
        "body": "",
        "created_at": "2017-08-11T21:00:44.133Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "397084149",
      "reference_num": "PRJ1-I-6",
      "name": "Some idea name 1",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124986478631939",
        "body": "",
        "created_at": "2017-08-11T21:00:44.180Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-6",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-6"
    },
    {
      "id": "290908627",
      "reference_num": "PRJ1-I-9",
      "name": "Some idea name 4",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124986807457654",
        "body": "",
        "created_at": "2017-08-11T21:00:44.253Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-9",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-9"
    },
    {
      "id": "245519441",
      "reference_num": "PRJ1-I-7",
      "name": "Some idea name 2",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124986996023657",
        "body": "",
        "created_at": "2017-08-11T21:00:44.300Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-7",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-7"
    },
    {
      "id": "140490859",
      "reference_num": "PRJ1-I-8",
      "name": "Some idea name 3",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124987204594715",
        "body": "",
        "created_at": "2017-08-11T21:00:44.347Z",
        "attachments": [

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

GET /api/v1/ideas

Get ideas created before a certain time

Parameters

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

Example Request

GET /api/v1/ideas?created_before=2016-08-11T21%3A00%3A44Z

Example CURL command

curl -g "https://secure.aha.io/api/v1/ideas?created_before=2016-08-11T21%3A00%3A44Z" -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-08-11T21:00:44.451Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-08-11T21:00:10.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

Example Request

GET /api/v1/ideas?q=dea

Example CURL command

curl -g "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": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "6453124988383343785",
        "body": "",
        "created_at": "2017-08-11T21:00:44.621Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2017-08-11T21:00:10.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124988936109801",
        "body": "",
        "created_at": "2017-08-11T21:00:44.750Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-08-11T21:00:10.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-1",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-1"
    },
    {
      "id": "397084149",
      "reference_num": "PRJ1-I-6",
      "name": "Some idea name 1",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124989268391379",
        "body": "",
        "created_at": "2017-08-11T21:00:44.826Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-6",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-6"
    },
    {
      "id": "290908627",
      "reference_num": "PRJ1-I-9",
      "name": "Some idea name 4",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124989635952684",
        "body": "",
        "created_at": "2017-08-11T21:00:44.915Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-9",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-9"
    },
    {
      "id": "245519441",
      "reference_num": "PRJ1-I-7",
      "name": "Some idea name 2",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124989879955218",
        "body": "",
        "created_at": "2017-08-11T21:00:44.969Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-7",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-7"
    },
    {
      "id": "140490859",
      "reference_num": "PRJ1-I-8",
      "name": "Some idea name 3",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124990100492245",
        "body": "",
        "created_at": "2017-08-11T21:00:45.023Z",
        "attachments": [

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

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

Search product for ideas by name or ID

Parameters

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

Example Request

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

Example CURL command

curl -g "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": "1055237874",
      "reference_num": "PRJ1-I-3",
      "name": "Idea 3 Merged",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "6453124990780122555",
        "body": "",
        "created_at": "2017-08-11T21:00:45.178Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
    },
    {
      "id": "444379319",
      "reference_num": "PRJ1-I-2",
      "name": "Idea 2",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "1009437757",
        "name": "In progress",
        "complete": false
      },
      "description": {
        "id": "378547141",
        "body": "Description of idea 2",
        "created_at": "2017-08-11T21:00:10.000Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-2",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-2"
    },
    {
      "id": "162120796",
      "reference_num": "PRJ1-I-5",
      "name": "Idea 4",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "6453124991123913683",
        "body": "",
        "created_at": "2017-08-11T21:00:45.261Z",
        "attachments": [

        ]
      },
      "url": "http://account1.example.org/ideas/ideas/PRJ1-I-5",
      "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-5"
    },
    {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-08-11T21:00:10.000Z",
        "attachments": [

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

GET /api/v1/ideas

Search ideas by tag

Parameters

Name	Description
tag	A string tag value.

Example Request

GET /api/v1/ideas?tag=Infrastructure

Example CURL command

curl -g "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-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-08-11T21:00:10.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

Example Request

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

Example CURL command

curl -g "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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:10.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-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:11.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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

Example Request

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

Example CURL command

curl -g "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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:45.681Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-08-11T21:00:10.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "admin_response": {
      "id": "6453124992519182531",
      "body": "This is a great idea! We'll get started right away.",
      "created_at": "2017-08-11T21:00:45.587Z",
      "attachments": [

      ],
      "responded_by_user": {
        "id": "501775768",
        "name": "Frank Sane",
        "email": "frank.sane@account2.com",
        "created_at": "2017-08-11T21:00:11.000Z",
        "updated_at": "2017-08-11T21:00:11.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:45.686Z"
    },
    "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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/:id

Ensure visibility is present

Parameters

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

Example Request

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

Example CURL command

curl -g "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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:10.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-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:11.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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

Example Request

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

Example CURL command

curl -g "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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:10.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-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:11.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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/:id

Get duplicates of a specific idea

Parameters

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

Example Request

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

Example CURL command

curl -g "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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:10.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-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:11.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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

Example Request

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

Example CURL command

curl -g "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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:46.277Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-08-11T21:00:10.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "duplicates": [
      {
        "id": "444379319",
        "reference_num": "PRJ1-I-2",
        "name": "Idea 2",
        "created_at": "2017-08-11T21:00:10.000Z",
        "workflow_status": {
          "id": "3259216",
          "name": "New",
          "complete": false
        },
        "description": {
          "id": "378547141",
          "body": "Description of idea 2",
          "created_at": "2017-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:46.282Z"
    },
    "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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

GET /api/v1/ideas/:id

Get ideas that a specific idea duplicates

Parameters

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

Example Request

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

Example CURL command

curl -g "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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:10.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-08-11T21:00:10.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "duplicates": [
      {
        "id": "1055237874",
        "reference_num": "PRJ1-I-3",
        "name": "Idea 3 Merged",
        "created_at": "2017-08-11T21:00:10.000Z",
        "workflow_status": {
          "id": "1009437757",
          "name": "In progress",
          "complete": false
        },
        "description": {
          "id": "6453124997396865452",
          "body": "",
          "created_at": "2017-08-11T21:00:46.723Z",
          "attachments": [

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

    ],
    "tags": [

    ],
    "categories": [

    ],
    "custom_fields": [

    ]
  }
}

Example Request

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

Example CURL command

curl -g "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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:46.892Z",
    "product_id": "131414752",
    "votes": 1,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "378547141",
      "body": "Description of idea 2",
      "created_at": "2017-08-11T21:00:10.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to anyone",
    "duplicates": [
      {
        "id": "1055237874",
        "reference_num": "PRJ1-I-3",
        "name": "Idea 3 Merged",
        "created_at": "2017-08-11T21:00:10.000Z",
        "workflow_status": {
          "id": "3259216",
          "name": "New",
          "complete": false
        },
        "description": {
          "id": "6453124997396865452",
          "body": "",
          "created_at": "2017-08-11T21:00:46.723Z",
          "attachments": [

          ]
        },
        "url": "http://account1.example.org/ideas/ideas/PRJ1-I-3",
        "resource": "http://account1.example.org/api/v1/ideas/PRJ1-I-3"
      }
    ],
    "duplicate_of": {
      "id": "58056975",
      "reference_num": "PRJ1-I-1",
      "name": "Idea 1",
      "created_at": "2017-08-11T21:00:10.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "complete": false
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "created_at": "2017-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_portal_user": {
      "id": "646391926",
      "name": "John Long",
      "email": "john@long.com",
      "created_at": "2017-08-11T21:00:10.000Z"
    },
    "assigned_to_user": null,
    "comments_count": 0,
    "endorsements_count": 1,
    "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

Example Request

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

Example CURL command

curl -g "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	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://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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:47.381Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "New description",
      "created_at": "2017-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:47.415Z"
    },
    "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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/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	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://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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:47.585Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:47.603Z"
    },
    "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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "priority",
        "name": "Priority",
        "value": "P3",
        "type": "string"
      },
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/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	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://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-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:47.785Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:47.792Z"
    },
    "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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/ideas/:id

Un-promote an idea from a feature

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	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://secure.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"feature":null}}' -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": {
    "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": 0,
    "created_at": "2017-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:47.956Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:47.979Z"
    },
    "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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/ideas/:id

Un-promote an idea from a master feature

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	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://secure.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"master_feature":null}}' -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": {
    "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": 0,
    "created_at": "2017-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:48.143Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:48.161Z"
    },
    "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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/ideas/:id

Un-promote an idea from an initiative

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	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://secure.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"initiative":null}}' -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": {
    "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": 0,
    "created_at": "2017-08-11T21:00:10.000Z",
    "updated_at": "2017-08-11T21:00:48.314Z",
    "product_id": "131414752",
    "votes": 0,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "complete": false
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2017-08-11T21:00:10.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-08-11T21:00:11.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-08-11T21:00:11.000Z",
      "updated_at": "2017-08-11T21:00:48.328Z"
    },
    "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-08-11T21:00:10.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      }
    ],
    "custom_object_links": [

    ]
  }
}

DELETE /api/v1/ideas/:id

Delete an idea

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://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

Ideas API

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

Parameters

Example CURL command

Request

Response

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

Parameters

Example CURL command

Request

Response

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

Parameters

Example CURL command

Request

Response

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

Parameters

Example CURL command

Request

Response

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

Parameters

Example CURL command

Request

Response

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

Parameters

Example CURL command

Request

Response

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

Parameters

Example CURL command

Request

Response

GET /api/v1/ideas

Parameters

Example CURL command

Request

Response

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

Parameters

Example CURL command

Request

Response

GET /api/v1/ideas

Parameters

Example CURL command

Request

Response

GET /api/v1/ideas

Parameters

Example CURL command

Request

Response

GET /api/v1/ideas

Parameters

Example CURL command

Request

Response

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

Parameters

Example CURL command

Request

Response

GET /api/v1/ideas

Parameters

Example CURL command

Request

Response

GET /api/v1/ideas/:id

Parameters

Example CURL command

Request

Response

Example CURL command

Request

Response

GET /api/v1/ideas/:id