Notes
Get all Notes
Returns all notes, with the exception of replies. You can filter notes using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties.
| Property Name | Type | Allowed Operators | Examples |
|---|---|---|---|
| id | int32 | = | id=1|id=2|id=3 |
| creator.id | int32 | = | creator.id=1 |
| createdAt | datetime | >, <, >=, <= | createdAt<2025-02-04T10:48:24Z |
| updatedAt | datetime | >, <, >=, <= | updatedAt>=2025-02-03T10:48:24Z |
get/v2/notes
Query parameters
totalCountboolean
Include total count of the collection in the pagination response
cursorstring
Cursor for the next or previous page
limitinteger
Number of items to include in the page
filterstring
Filter options
includesstring[]
Additional properties to include in the response
Response
OK
Example response
{
"data": [
{
"creator": {
"id": 1,
"firstName": "Jane",
"lastName": "Doe",
"primaryEmailAddress": "jane.smith@northpointvc.com",
"type": "internal"
},
"mentions": [
{
"id": 1,
"type": "person",
"person": {
"id": 1,
"firstName": "Jane",
"lastName": "Smith",
"primaryEmailAddress": "jane.smith@northpointvc.com",
"type": "internal"
}
}
]
}
],
"pagination": {
"prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}
}