v1
latestOpenAPI 3.1.02026-07-223614164.6 KBNotes
List notes
Retrieve a list of notes in the workspace.
get/v1/notes
Query parameters
limitinteger
The number of items to return.
cursorstring
A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.
entity.idstring
Filter notes by entity. Only notes linked to the specified entity will be returned.
querystring
Full-text search query against note content.
createdAfterstring date-time
Return only notes created after this ISO 8601 timestamp.
createdBeforestring date-time
Return only notes created before this ISO 8601 timestamp.
Response
A paginated list of notes in the workspace.
Example response
{
"data": {
"items": [
{
"id": "nte_91118b73-5a75-480b-b8e3-a33671c35cdc",
"entity": {
"id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
"entityType": "person",
"fullName": "John Doe"
},
"visibility": "public",
"content": "This is a note about John Doe",
"author": {
"type": "user",
"id": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
"fullName": "John Doe",
"email": "john.doe@example.com",
"deleted": false
},
"createdAt": "2021-01-01T00:00:00.000Z",
"parentNote": {
"id": "nte_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
"entity": {
"id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
"entityType": "person",
"fullName": "John Doe"
},
"content": "This is a parent note about John Doe",
"visibility": "public",
"author": {
"type": "user",
"id": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
"fullName": "John Doe",
"email": "john.doe@example.com",
"deleted": false
},
"createdAt": "2021-01-01T00:00:00.000Z",
"deleted": false
}
}
],
"pagination": {
"nextLink": "https://api.folk.app/v1/notes?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
}
},
"deprecations": [
"This field is deprecated"
]
}