MYmyclickfunnels
Sales::Opportunities::Note

List Notes

Changed on

List Notes

get/sales/opportunities/{opportunity_id}/notes

Request

Path parameters

opportunity_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

idstring

A comma-separated list of note IDs to filter by (within the scope of the opportunity).

created_by_idstring

A comma-separated list of memberships IDs to filter by.

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

{
  "id": "1,42",
  "created_by_id": "1,42"
}

Response

OK

idinteger

Note ID

public_idstring nullable

Note public ID

opportunity_idinteger

Opportunity

contentstring

Content

created_by_idinteger nullable

The ID of the Team-Membership that created the note. For notes created via the API, this defaults to the ClickFunnels API default User.

created_atstring date-time nullable

Note creation date

updated_atstring date-time nullable

Note last updated date

Example response

[
  {
    "id": 49,
    "public_id": "zAUjDv",
    "opportunity_id": 24,
    "content": "Example note",
    "created_by_id": 53,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]

Changes

  • 511d88b30aeaRevision changes
    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter opportunity_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status