List notes
List notes for all records or for a specific record.
Required scopes: note:read
, object_configuration:read
, record_permission:read
.
curl --request GET \
--url https://api.attio.com/v2/notes \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"note_id": "ff3f3bd4-40f4-4f80-8187-cd02385af424"
},
"parent_object": "people",
"parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
"title": "Initial Prospecting Call Summary",
"content_plaintext": "Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points",
"content_markdown": "# Introduction\nDate and time of the call\nParticipants\nPurpose of the call\n\n## Customer Background\n- Company overview (industry, size, location)\n- Key business challenges\n- Current software solutions (if any) and pain points",
"created_by_actor": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2022-11-21T13:22:49.061281000Z"
}
]
}
Authorizations
This API uses OAuth 2.0 with the authorization code grant flow.
Query Parameters
The maximum number of results to return. The default is 10
and the maximum is 50
. See the full guide to pagination here.
10
The number of results to skip over before returning. The default is 0
. See the full guide to pagination here.
5
The slug or ID of the parent object the notes belong to.
"people"
The ID of the parent record the notes belong to.
"891dcbfc-9141-415d-9b2a-2238a6cc012d"
Response
Success
The slug or ID of the parent object the note belongs to.
"people"
The ID of the parent record the note belongs to.
"891dcbfc-9141-415d-9b2a-2238a6cc012d"
The note title. The title is plaintext only and has no formatting.
"Initial Prospecting Call Summary"
The plaintext representation of the note content. The line feed character \n
represents new lines within the note content.
"Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points"
The markdown representation of the note content. Supports a subset of markdown features including:
- Headings (levels 1-3 only with
#
,##
,###
) - Unordered lists (
-
,*
,+
) - Ordered lists (
1.
,2.
, etc.) - Text styling:
**bold**
,*italic*
,~~strikethrough~~
,==highlighted==
- Links:
[link text](https://example.com)
Note that note images are not returned as part of the markdown API representation.
"# Introduction\nDate and time of the call\nParticipants\nPurpose of the call\n\n## Customer Background\n- Company overview (industry, size, location)\n- Key business challenges\n- Current software solutions (if any) and pain points"
The actor that created this note.
An ID to identify the actor.
The type of actor. Read more information on actor types here.
api-token
, workspace-member
, system
, app
{
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
When the note was created.
"2022-11-21T13:22:49.061281000Z"
Was this page helpful?
curl --request GET \
--url https://api.attio.com/v2/notes \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"note_id": "ff3f3bd4-40f4-4f80-8187-cd02385af424"
},
"parent_object": "people",
"parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
"title": "Initial Prospecting Call Summary",
"content_plaintext": "Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points",
"content_markdown": "# Introduction\nDate and time of the call\nParticipants\nPurpose of the call\n\n## Customer Background\n- Company overview (industry, size, location)\n- Key business challenges\n- Current software solutions (if any) and pain points",
"created_by_actor": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2022-11-21T13:22:49.061281000Z"
}
]
}