---
title: "Get Notes for an Opportunity"
method: GET
path: "/v2/opportunities/{opportunityId}/notes"
tags: ["Opportunities"]
---

# Get Notes for an Opportunity

`GET /v2/opportunities/{opportunityId}/notes`

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 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` |

## Path parameters

- `opportunityId` integer, required

## Query parameters

- `filter` string
- `cursor` string
- `limit` integer
- `totalCount` boolean

## Response `200`

OK

- NotesNotesPaged — NotesPaged model
  - `data` NotesNote[], required — A page of Note objects
    - union — Note model
      - NotesEntitiesNote — An abstract base class for notes
        - `id` integer, required — The id of the note
        - `content` NotesContent, required — A note content
          - `html` string, nullable, required — The HTML content of the note
        - `creator` PersonData, required
          - `id` integer, required — The persons's unique identifier
          - `firstName` string, nullable, required — The person's first name
          - `lastName` string, nullable, required — The person's last name
          - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
          - `type` 'internal' | 'collaborator' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `collaborator` - individuals outside of your company who have read-only access to specified Affinity list views and stay updated on your firm's activities. `external` - people who are not internal nor collaborators.
        - `mentions` NotesMention[], required — The mentions in the note
          - `id` integer, required — The id of the mention
          - `type` 'person', required — The type of mention
          - `person` PersonData, required
            - `id` integer, required — The persons's unique identifier
            - `firstName` string, nullable, required — The person's first name
            - `lastName` string, nullable, required — The person's last name
            - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
            - `type` 'internal' | 'collaborator' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `collaborator` - individuals outside of your company who have read-only access to specified Affinity list views and stay updated on your firm's activities. `external` - people who are not internal nor collaborators.
        - `createdAt` string, date-time, required — The date and time the note was created
        - `updatedAt` string, date-time, nullable, required — The date and time the note was last updated
      - NotesInteractionNote — An abstract base class for notes
        - `id` integer, required — The id of the note
        - `content` NotesContent, required — A note content
          - `html` string, nullable, required — The HTML content of the note
        - `creator` PersonData, required
          - `id` integer, required — The persons's unique identifier
          - `firstName` string, nullable, required — The person's first name
          - `lastName` string, nullable, required — The person's last name
          - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
          - `type` 'internal' | 'collaborator' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `collaborator` - individuals outside of your company who have read-only access to specified Affinity list views and stay updated on your firm's activities. `external` - people who are not internal nor collaborators.
        - `mentions` NotesMention[], required — The mentions in the note
          - `id` integer, required — The id of the mention
          - `type` 'person', required — The type of mention
          - `person` PersonData, required
            - `id` integer, required — The persons's unique identifier
            - `firstName` string, nullable, required — The person's first name
            - `lastName` string, nullable, required — The person's last name
            - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
            - `type` 'internal' | 'collaborator' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `collaborator` - individuals outside of your company who have read-only access to specified Affinity list views and stay updated on your firm's activities. `external` - people who are not internal nor collaborators.
        - `createdAt` string, date-time, required — The date and time the note was created
        - `updatedAt` string, date-time, nullable, required — The date and time the note was last updated
      - NotesAiNotetakerRootNote — An abstract base class for notes
        - `id` integer, required — The id of the note
        - `content` NotesContent, required — A note content
          - `html` string, nullable, required — The HTML content of the note
        - `creator` PersonData, required
          - `id` integer, required — The persons's unique identifier
          - `firstName` string, nullable, required — The person's first name
          - `lastName` string, nullable, required — The person's last name
          - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
          - `type` 'internal' | 'collaborator' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `collaborator` - individuals outside of your company who have read-only access to specified Affinity list views and stay updated on your firm's activities. `external` - people who are not internal nor collaborators.
        - `mentions` NotesMention[], required — The mentions in the note
          - `id` integer, required — The id of the mention
          - `type` 'person', required — The type of mention
          - `person` PersonData, required
            - `id` integer, required — The persons's unique identifier
            - `firstName` string, nullable, required — The person's first name
            - `lastName` string, nullable, required — The person's last name
            - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
            - `type` 'internal' | 'collaborator' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `collaborator` - individuals outside of your company who have read-only access to specified Affinity list views and stay updated on your firm's activities. `external` - people who are not internal nor collaborators.
        - `createdAt` string, date-time, required — The date and time the note was created
        - `updatedAt` string, date-time, nullable, required — The date and time the note was last updated
      - NotesUserReplyNote — An abstract base class for notes
        - `id` integer, required — The id of the note
        - `content` NotesContent, required — A note content
          - `html` string, nullable, required — The HTML content of the note
        - `creator` PersonData, required
          - `id` integer, required — The persons's unique identifier
          - `firstName` string, nullable, required — The person's first name
          - `lastName` string, nullable, required — The person's last name
          - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
          - `type` 'internal' | 'collaborator' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `collaborator` - individuals outside of your company who have read-only access to specified Affinity list views and stay updated on your firm's activities. `external` - people who are not internal nor collaborators.
        - `mentions` NotesMention[], required — The mentions in the note
          - `id` integer, required — The id of the mention
          - `type` 'person', required — The type of mention
          - `person` PersonData, required
            - `id` integer, required — The persons's unique identifier
            - `firstName` string, nullable, required — The person's first name
            - `lastName` string, nullable, required — The person's last name
            - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
            - `type` 'internal' | 'collaborator' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `collaborator` - individuals outside of your company who have read-only access to specified Affinity list views and stay updated on your firm's activities. `external` - people who are not internal nor collaborators.
        - `createdAt` string, date-time, required — The date and time the note was created
        - `updatedAt` string, date-time, nullable, required — The date and time the note was last updated
      - NotesAiNotetakerReplyNote — An abstract base class for notes
        - `id` integer, required — The id of the note
        - `content` NotesContent, required — A note content
          - `html` string, nullable, required — The HTML content of the note
        - `creator` PersonData, required
          - `id` integer, required — The persons's unique identifier
          - `firstName` string, nullable, required — The person's first name
          - `lastName` string, nullable, required — The person's last name
          - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
          - `type` 'internal' | 'collaborator' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `collaborator` - individuals outside of your company who have read-only access to specified Affinity list views and stay updated on your firm's activities. `external` - people who are not internal nor collaborators.
        - `mentions` NotesMention[], required — The mentions in the note
          - `id` integer, required — The id of the mention
          - `type` 'person', required — The type of mention
          - `person` PersonData, required
            - `id` integer, required — The persons's unique identifier
            - `firstName` string, nullable, required — The person's first name
            - `lastName` string, nullable, required — The person's last name
            - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
            - `type` 'internal' | 'collaborator' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `collaborator` - individuals outside of your company who have read-only access to specified Affinity list views and stay updated on your firm's activities. `external` - people who are not internal nor collaborators.
        - `createdAt` string, date-time, required — The date and time the note was created
        - `updatedAt` string, date-time, nullable, required — The date and time the note was last updated
  - `pagination` PaginationWithTotalCount, required
    - `prevUrl` string, uri, nullable — URL for the previous page
    - `nextUrl` string, uri, nullable — URL for the next page

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `default` — Errors

---

[API](https://skmtc.net/affinity/apis/affinity-api-v2.md) · [All operations](https://skmtc.net/affinity/apis/affinity-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinity/affinity-api-v2/versions/4c2891c31b7f/schema)