Aha.io Notes API
The Notes API from Aha.io — 2 operation(s) for notes.
OpenAPI Specification
openapi: 3.1.0
info:
title: Aha! Account backups Notes API
version: 1.0.0
description: Complete API documentation for Aha! generated from actual test responses
contact:
name: Aha! Support
url: https://www.aha.io/support
servers:
- url: https://{account-domain}.aha.io/api/v1
description: Aha! API Server
variables:
account-domain:
description: Your Aha! account domain
default: company
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
tags:
- name: Notes
paths:
/api/v1/products/{product_id}/pages:
post:
summary: Create a note
description: '"Notes" in the web interface are referenced as "pages" from API endpoints.'
tags:
- Notes
parameters:
- name: product_id
in: path
required: true
schema:
type: string
description: ProductId identifier
responses:
'200':
description: Successful operation
headers:
Content-Type:
description: application/json; charset=utf-8
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/NotesPostResponse'
example:
page:
id: '6776881149490967959'
name: null
title: PRJ1-N-11 Untitled
document_title: Untitled | Aha!
updated_at: '2019-01-01T00:00:00.000Z'
reference_num: PRJ1-N-11
emoji_value: null
document_type: 80
document_type_name: internal_link
editor_width: null
type_name: internal link
position: null
created_at: '2019-01-01T00:00:00.000Z'
location: null
edit_locked: false
linked_record_id: 1007868956
linked_record_type: Feature
url: http://company.aha.io/pages/PRJ1-N-11
resource: http://company.aha.io/api/v1/pages/PRJ1-N-11
product_id: '131414752'
description:
id: '6776881149488431496'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
parent_id: null
tags: []
full_tags: []
comments_count: 0
custom_fields: []
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NotesPostRequest'
example:
page:
name: Note 3
description_attributes:
body: <p>An awesome new note</p>
get:
summary: List notes for a product
description: '"Notes" in the web interface are referenced as "pages" from API endpoints.'
tags:
- Notes
parameters:
- name: product_id
in: path
required: true
schema:
type: string
description: ProductId identifier
responses:
'200':
description: Successful operation
headers:
Content-Type:
description: application/json; charset=utf-8
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/NotesGetResponse'
example:
pages:
- id: '123524136'
name: Title of the meeting note
title: PRJ1-N-9 Title of the meeting note
reference_num: PRJ1-N-9
url: http://company.aha.io/pages/PRJ1-N-9
resource: http://company.aha.io/api/v1/pages/PRJ1-N-9
created_at: '2019-01-01T00:00:00.000Z'
parent_id: null
- id: '199011658'
name: Title of the child note
title: PRJ1-N-4 Title of the child note
reference_num: PRJ1-N-4
url: http://company.aha.io/pages/PRJ1-N-4
resource: http://company.aha.io/api/v1/pages/PRJ1-N-4
created_at: '2019-01-01T00:00:00.000Z'
parent_id: 702939369
- id: '249102634'
name: null
title: PRJ1-N-7 Untitled
reference_num: PRJ1-N-7
url: http://company.aha.io/pages/PRJ1-N-7
resource: http://company.aha.io/api/v1/pages/PRJ1-N-7
created_at: '2019-01-01T00:00:00.000Z'
parent_id: null
- id: '256116692'
name: Shared page title
title: PRJ1-N-10 Shared page title
reference_num: PRJ1-N-10
url: http://company.aha.io/pages/PRJ1-N-10
resource: http://company.aha.io/api/v1/pages/PRJ1-N-10
created_at: '2019-01-01T00:00:00.000Z'
parent_id: null
- id: '280859787'
name: External link
title: PRJ1-N-6 External link
reference_num: PRJ1-N-6
url: http://company.aha.io/pages/PRJ1-N-6
resource: http://company.aha.io/api/v1/pages/PRJ1-N-6
created_at: '2019-01-01T00:00:00.000Z'
parent_id: null
- id: '549832152'
name: Title of the second whiteboard
title: PRJ1-N-6 Title of the second whiteboard
reference_num: PRJ1-N-6
url: http://company.aha.io/pages/PRJ1-N-6
resource: http://company.aha.io/api/v1/pages/PRJ1-N-6
created_at: '2019-01-01T00:00:00.000Z'
parent_id: null
- id: '666543134'
name: Title of the second note
title: PRJ1-N-2 Title of the second note
reference_num: PRJ1-N-2
url: http://company.aha.io/pages/PRJ1-N-2
resource: http://company.aha.io/api/v1/pages/PRJ1-N-2
created_at: '2019-01-01T00:00:00.000Z'
parent_id: null
- id: '702939369'
name: Title of the parent note
title: PRJ1-N-3 Title of the parent note
reference_num: PRJ1-N-3
url: http://company.aha.io/pages/PRJ1-N-3
resource: http://company.aha.io/api/v1/pages/PRJ1-N-3
created_at: '2019-01-01T00:00:00.000Z'
parent_id: null
- id: '969708644'
name: Title of the first whiteboard
title: PRJ1-N-5 Title of the first whiteboard
reference_num: PRJ1-N-5
url: http://company.aha.io/pages/PRJ1-N-5
resource: http://company.aha.io/api/v1/pages/PRJ1-N-5
created_at: '2019-01-01T00:00:00.000Z'
parent_id: null
- id: '970863041'
name: null
title: PRJ1-N-8 Untitled
reference_num: PRJ1-N-8
url: http://company.aha.io/pages/PRJ1-N-8
resource: http://company.aha.io/api/v1/pages/PRJ1-N-8
created_at: '2019-01-01T00:00:00.000Z'
parent_id: null
- id: '1051981226'
name: Title of the first note
title: PRJ1-N-1 Title of the first note
reference_num: PRJ1-N-1
url: http://company.aha.io/pages/PRJ1-N-1
resource: http://company.aha.io/api/v1/pages/PRJ1-N-1
created_at: '2019-01-01T00:00:00.000Z'
parent_id: null
pagination:
total_records: 11
total_pages: 1
current_page: 1
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
/api/v1/pages/{id}:
get:
summary: Get a specific note
description: '"Notes" in the web interface are referenced as "pages" from API endpoints.'
tags:
- Notes
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Id identifier
responses:
'200':
description: Successful operation
headers:
Content-Type:
description: application/json; charset=utf-8
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/NotesGetResponse'
example:
page:
id: '1051981226'
name: Title of the first note
title: PRJ1-N-1 Title of the first note
document_title: Title of the first note | Aha!
updated_at: '2019-01-01T00:00:00.000Z'
reference_num: PRJ1-N-1
emoji_value: null
document_type: 10
document_type_name: note
editor_width: FULL
type_name: note
position: 100000
created_at: '2019-01-01T00:00:00.000Z'
location: null
edit_locked: false
url: http://company.aha.io/pages/PRJ1-N-1
resource: http://company.aha.io/api/v1/pages/PRJ1-N-1
product_id: '131414752'
description:
id: '669149001'
body: Description of note 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
parent_id: null
tags:
- Infrastructure
- Sales
full_tags:
- id: 775582684
name: Infrastructure
color: '#7552e0'
- id: 926098016
name: Sales
color: '#e0da52'
comments_count: 0
custom_fields:
- id: 416524155
key: review_date
name: Review date
updatedAt: '2019-01-01T00:00:00Z'
value: '2019-01-01'
type: date
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
put:
summary: Update a note
description: '"Notes" in the web interface are referenced as "pages" from API endpoints.'
tags:
- Notes
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Id identifier
responses:
'200':
description: Successful operation
headers:
Content-Type:
description: application/json; charset=utf-8
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/NotesPutResponse'
example:
page:
id: '280859787'
name: Build products customers love
title: PRJ1-N-6 Build products customers love
document_title: Build products customers love | Aha!
updated_at: '2019-01-01T00:00:00.000Z'
reference_num: PRJ1-N-6
emoji_value: null
document_type: 70
document_type_name: external_link
editor_width: null
type_name: external link
position: 500000
created_at: '2019-01-01T00:00:00.000Z'
location: null
edit_locked: false
external_url: https://www.aha.io/solutions/product
url: http://company.aha.io/pages/PRJ1-N-6
resource: http://company.aha.io/api/v1/pages/PRJ1-N-6
product_id: '131414752'
description:
id: ''
body: '#<note:0x000000032dc8fa20></note:0x000000032dc8fa20>'
editor_version: 2
created_at: null
updated_at: null
attachments: []
parent_id: null
tags: []
full_tags: []
comments_count: 0
custom_fields: []
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NotesPostRequest'
example:
page:
name: New name for the note
description_attributes:
body: <p>An awesome new note</p>
delete:
summary: Delete a note
description: '"Notes" in the web interface are referenced as "pages" from API endpoints.'
tags:
- Notes
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Id identifier
responses:
'204':
description: No content - operation successful
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
components:
schemas:
NotesPutResponse:
type: object
properties:
page:
type: object
properties:
id:
type: string
example: '280859787'
name:
type: string
example: Build products customers love
title:
type: string
example: PRJ1-N-6 Build products customers love
document_title:
type: string
example: Build products customers love | Aha!
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
reference_num:
type: string
example: PRJ1-N-6
emoji_value:
type: 'null'
document_type:
type: integer
example: 70
document_type_name:
type: string
example: external_link
editor_width:
type: 'null'
type_name:
type: string
example: external link
position:
type: integer
example: 500000
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
location:
type: 'null'
edit_locked:
type: boolean
example: false
external_url:
type: string
example: https://www.aha.io/solutions/product
url:
type: string
example: http://company.aha.io/pages/PRJ1-N-6
resource:
type: string
example: http://company.aha.io/api/v1/pages/PRJ1-N-6
product_id:
type: string
example: '131414752'
description:
type: object
properties:
id:
type: string
example: ''
body:
type: string
example: '#<note:0x000000032dc8fa20></note:0x000000032dc8fa20>'
editor_version:
type: integer
example: 2
created_at:
type: 'null'
updated_at:
type: 'null'
attachments:
type: array
items: {}
example:
id: ''
body: '#<note:0x000000032dc8fa20></note:0x000000032dc8fa20>'
editor_version: 2
created_at: null
updated_at: null
attachments: []
parent_id:
type: 'null'
tags:
type: array
items: {}
full_tags:
type: array
items: {}
comments_count:
type: integer
example: 0
custom_fields:
type: array
items: {}
example:
id: '280859787'
name: Build products customers love
title: PRJ1-N-6 Build products customers love
document_title: Build products customers love | Aha!
updated_at: '2019-01-01T00:00:00.000Z'
reference_num: PRJ1-N-6
emoji_value: null
document_type: 70
document_type_name: external_link
editor_width: null
type_name: external link
position: 500000
created_at: '2019-01-01T00:00:00.000Z'
location: null
edit_locked: false
external_url: https://www.aha.io/solutions/product
url: http://company.aha.io/pages/PRJ1-N-6
resource: http://company.aha.io/api/v1/pages/PRJ1-N-6
product_id: '131414752'
description:
id: ''
body: '#<note:0x000000032dc8fa20></note:0x000000032dc8fa20>'
editor_version: 2
created_at: null
updated_at: null
attachments: []
parent_id: null
tags: []
full_tags: []
comments_count: 0
custom_fields: []
example:
page:
id: '280859787'
name: Build products customers love
title: PRJ1-N-6 Build products customers love
document_title: Build products customers love | Aha!
updated_at: '2019-01-01T00:00:00.000Z'
reference_num: PRJ1-N-6
emoji_value: null
document_type: 70
document_type_name: external_link
editor_width: null
type_name: external link
position: 500000
created_at: '2019-01-01T00:00:00.000Z'
location: null
edit_locked: false
external_url: https://www.aha.io/solutions/product
url: http://company.aha.io/pages/PRJ1-N-6
resource: http://company.aha.io/api/v1/pages/PRJ1-N-6
product_id: '131414752'
description:
id: ''
body: '#<note:0x000000032dc8fa20></note:0x000000032dc8fa20>'
editor_version: 2
created_at: null
updated_at: null
attachments: []
parent_id: null
tags: []
full_tags: []
comments_count: 0
custom_fields: []
NotesPostRequest:
type: object
properties:
page:
type: object
properties:
name:
type: string
example: New name for the note
description_attributes:
type: object
properties:
body:
type: string
example: <p>An awesome new note</p>
example:
body: <p>An awesome new note</p>
example:
name: New name for the note
description_attributes:
body: <p>An awesome new note</p>
example:
page:
name: New name for the note
description_attributes:
body: <p>An awesome new note</p>
NotesPostResponse:
type: object
properties:
page:
type: object
properties:
id:
type: string
example: '6776881149490967959'
name:
type: 'null'
title:
type: string
example: PRJ1-N-11 Untitled
document_title:
type: string
example: Untitled | Aha!
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
reference_num:
type: string
example: PRJ1-N-11
emoji_value:
type: 'null'
document_type:
type: integer
example: 80
document_type_name:
type: string
example: internal_link
editor_width:
type: 'null'
type_name:
type: string
example: internal link
position:
type: 'null'
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
location:
type: 'null'
edit_locked:
type: boolean
example: false
linked_record_id:
type: integer
example: 1007868956
linked_record_type:
type: string
example: Feature
url:
type: string
example: http://company.aha.io/pages/PRJ1-N-11
resource:
type: string
example: http://company.aha.io/api/v1/pages/PRJ1-N-11
product_id:
type: string
example: '131414752'
description:
type: object
properties:
id:
type: string
example: '6776881149488431496'
body:
type: string
example: ''
editor_version:
type: integer
example: 2
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
attachments:
type: array
items: {}
example:
id: '6776881149488431496'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
parent_id:
type: 'null'
tags:
type: array
items: {}
full_tags:
type: array
items: {}
comments_count:
type: integer
example: 0
custom_fields:
type: array
items: {}
example:
id: '6776881149490967959'
name: null
title: PRJ1-N-11 Untitled
document_title: Untitled | Aha!
updated_at: '2019-01-01T00:00:00.000Z'
reference_num: PRJ1-N-11
emoji_value: null
document_type: 80
document_type_name: internal_link
editor_width: null
type_name: internal link
position: null
created_at: '2019-01-01T00:00:00.000Z'
location: null
edit_locked: false
linked_record_id: 1007868956
linked_record_type: Feature
url: http://company.aha.io/pages/PRJ1-N-11
resource: http://company.aha.io/api/v1/pages/PRJ1-N-11
product_id: '131414752'
description:
id: '6776881149488431496'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
parent_id: null
tags: []
full_tags: []
comments_count: 0
custom_fields: []
example:
page:
id: '6776881149490967959'
name: null
title: PRJ1-N-11 Untitled
document_title: Untitled | Aha!
updated_at: '2019-01-01T00:00:00.000Z'
reference_num: PRJ1-N-11
emoji_value: null
document_type: 80
document_type_name: internal_link
editor_width: null
type_name: internal link
position: null
created_at: '2019-01-01T00:00:00.000Z'
location: null
edit_locked: false
linked_record_id: 1007868956
linked_record_type: Feature
url: http://company.aha.io/pages/PRJ1-N-11
resource: http://company.aha.io/api/v1/pages/PRJ1-N-11
product_id: '131414752'
description:
id: '6776881149488431496'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
parent_id: null
tags: []
full_tags: []
comments_count: 0
custom_fields: []
NotesGetResponse:
type: object
properties:
page:
type: object
properties:
id:
type: string
example: '1051981226'
name:
type: string
example: Title of the first note
title:
type: string
example: PRJ1-N-1 Title of the first note
document_title:
type: string
example: Title of the first note | Aha!
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
reference_num:
type: string
example: PRJ1-N-1
emoji_value:
type: 'null'
document_type:
type: integer
example: 10
document_type_name:
type: string
example: note
editor_width:
type: string
example: FULL
type_name:
type: string
example: note
position:
type: integer
example: 100000
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
location:
type: 'null'
edit_locked:
type: boolean
example: false
url:
type: string
example: http://company.aha.io/pages/PRJ1-N-1
resource:
type: string
example: http://company.aha.io/api/v1/pages/PRJ1-N-1
product_id:
type: string
example: '131414752'
description:
type: object
properties:
id:
type: string
example: '669149001'
body:
type: string
example: Description of note 1
editor_version:
type: integer
example: 1
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
attachments:
type: array
items: {}
example:
id: '669149001'
body: Description of note 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
parent_id:
type: 'null'
tags:
type: array
items:
type: string
example: Infrastructure
example:
- Infrastructure
- Sales
full_tags:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
color:
type: string
example:
id: 775582684
name: Infrastructure
color: '#7552e0'
example:
- id: 775582684
name: Infrastructure
color: '#7552e0'
- id: 926098016
name: Sales
color: '#e0da52'
comments_count:
type: integer
example: 0
custom_fields:
type: array
items:
type: object
properties:
id:
type: string
key:
type: string
name:
type: string
updatedAt:
type: string
value:
type: string
type:
type: string
example:
id: 416524155
key: review_date
name: Review date
updatedAt: '2019-01-01T00:00:00Z'
value: '2019-01-01'
type: date
example:
- id: 416524155
key: review_date
name: Review date
updatedAt: '2019-01-01T00:00:00Z'
value: '2019-01-01'
type: date
example:
id: '1051981226'
name: Title of the first note
title: PRJ1-N-1 Title of the first note
document_title: Title of the first note | Aha!
updated_at: '2019-01-01T00:00:00.000Z'
reference_num: PRJ1-N-1
emoji_value: null
document_type: 10
document_type_name: note
editor_width: FULL
type_name: note
position: 100000
created_at: '2019-01-01T00:00:00.000Z'
location: null
edit_locked: false
url: http://company.aha.io/pages/PRJ1-N-1
resource: http://company.aha.io/api/v1/pages/PRJ1-N-1
product_id: '131414752'
description:
id: '669149001'
body: Description of note 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
parent_id: null
tags:
- Infrastructure
- Sales
full_tags:
- id: 775582684
name: Infrastructure
color: '#7552e0'
- id: 926098016
name: Sales
color: '#e0da52'
comments_count: 0
custom_fields:
- id: 416524155
key: review_date
name: Review date
updatedAt: '2019-01-01T00:00:00Z'
value: '2019-01-01'
type: date
example:
page:
id: '1051981226'
name: Title of the first note
title: PRJ1-N-1 Title of the first note
document_title: Title of the first note | Aha!
updated_at: '2019-01-01T00:00:00.000Z'
reference_num: PRJ1-N-1
emoji_value: null
document_type: 10
document_type_name: note
editor_width: FULL
type_name: note
position: 100000
created_at: '2019-01-01T00:00:00.000Z'
location: null
edit_locked: false
url: http://company.aha.io/pages/PRJ1-N-1
resource: http://company.aha.io/api/v1/pages/PRJ1-N-1
product_id: '131414752'
description:
id: '669149001'
body: Description of note 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
parent_id: null
t
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aha/refs/heads/main/openapi/aha-notes-api-openapi.yml