Notes
List notes for a product
Changed on"Notes" in the web interface are referenced as "pages" from API endpoints.
get/products/{product_id}/pages
Request
- Base URLhttps://company.aha.io/api/v1
- Auth
- OAuth 2Authorization codehttps://{account-domain}.aha.io/oauth/authorizeToken URLhttps://{account-domain}.aha.io/oauth/token
- or HTTP bearer
- or API key in cookie session
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
product_idstring required
ProductId identifier
Query parameters
pagestring
per_pagestring
Response
Successful operation
Example response
{
"pages": [
{
"id": "123524136",
"name": "Title of the meeting note",
"title": "PRJ1-N-9 Title of the meeting note",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-9",
"url": "https://company.aha.io/pages/PRJ1-N-9",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-9"
},
{
"id": "199011658",
"name": "Title of the child note",
"title": "PRJ1-N-4 Title of the child note",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": 702939369,
"reference_num": "PRJ1-N-4",
"url": "https://company.aha.io/pages/PRJ1-N-4",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-4"
},
{
"id": "249102634",
"name": null,
"title": "PRJ1-N-7 Untitled",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-7",
"url": "https://company.aha.io/pages/PRJ1-N-7",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-7"
},
{
"id": "256116692",
"name": "Shared page title",
"title": "PRJ1-N-10 Shared page title",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-10",
"url": "https://company.aha.io/pages/PRJ1-N-10",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-10"
},
{
"id": "280859787",
"name": "External link",
"title": "PRJ1-N-6 External link",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-6",
"url": "https://company.aha.io/pages/PRJ1-N-6",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-6"
},
{
"id": "549832152",
"name": "Title of the second whiteboard",
"title": "PRJ1-N-6 Title of the second whiteboard",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-6",
"url": "https://company.aha.io/pages/PRJ1-N-6",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-6"
},
{
"id": "666543134",
"name": "Title of the second note",
"title": "PRJ1-N-2 Title of the second note",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-2",
"url": "https://company.aha.io/pages/PRJ1-N-2",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-2"
},
{
"id": "702939369",
"name": "Title of the parent note",
"title": "PRJ1-N-3 Title of the parent note",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-3",
"url": "https://company.aha.io/pages/PRJ1-N-3",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-3"
},
{
"id": "819124458",
"name": "Title of the first prototype",
"title": "PRJ1-N-14 Title of the first prototype",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-14",
"url": "https://company.aha.io/pages/PRJ1-N-14",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-14"
},
{
"id": "969708644",
"name": "Title of the first whiteboard",
"title": "PRJ1-N-5 Title of the first whiteboard",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-5",
"url": "https://company.aha.io/pages/PRJ1-N-5",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-5"
},
{
"id": "970863041",
"name": null,
"title": "PRJ1-N-8 Untitled",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-8",
"url": "https://company.aha.io/pages/PRJ1-N-8",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-8"
},
{
"id": "1051981226",
"name": "Title of the first note",
"title": "PRJ1-N-1 Title of the first note",
"created_at": "2019-01-01T00:00:00.000Z",
"parent_id": null,
"reference_num": "PRJ1-N-1",
"url": "https://company.aha.io/pages/PRJ1-N-1",
"resource": "https://company.aha.io/api/v1/pages/PRJ1-N-1"
}
],
"pagination": {
"total_records": 12,
"total_pages": 1,
"current_page": 1
}
}Changes
- info
added the new optional
queryrequest parameterpage - info
added the new optional
queryrequest parameterper_page
- info
- info
endpoint added
- info