Companies
Get Notes for a Company
Returns relevant notes for a given company which includes directly attached notes and notes attached to persons on this company.
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 |
|---|---|---|---|
| creator.id | int32 | = | creator.id=1 |
| createdAt | datetime | >, <, >=, <= | createdAt<2025-02-04T10:48:24Z |
| updatedAt | datetime | >, <, >=, <= | updatedAt>=2025-02-03T10:48:24Z |
get/v2/companies/{companyId}/notes
Path parameters
companyIdinteger required
Company's ID
Query parameters
filterstring
Filter options
cursorstring
Cursor for the next or previous page
limitinteger
Number of items to include in the page
totalCountboolean
Include total count of the collection in the pagination 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"
}
}