v1

latestOpenAPI 3.1.1Proprietary2026-07-2687313591.4 KB
Opportunities

Get Notes for an Opportunity

Returns Notes for a given Opportunity which includes directly attached notes and those attached to persons on this Opportunity.

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 NameTypeAllowed OperatorsExamples
creator.idint32=creator.id=1
createdAtdatetime>, <, >=, <=createdAt<2025-02-04T10:48:24Z
updatedAtdatetime>, <, >=, <=updatedAt>=2025-02-03T10:48:24Z
get/v2/opportunities/{opportunityId}/notes

Path parameters

opportunityIdinteger required

Opportunity 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"
  }
}