ClickFunnels

ClickFunnels Sales::Opportunities::Note API

Sales Opportunity Notes

Documentation GitHub OpenAPI

Operations 5

GET /sales/opportunities/{opportunity_id}/notes List Notes #

POST /sales/opportunities/{opportunity_id}/notes Create Note #

GET /sales/opportunities/notes/{id} Fetch Note #

PUT /sales/opportunities/notes/{id} Update Note #

DELETE /sales/opportunities/notes/{id} Remove Note #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/clickfunnels-sales-opportunities-note-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ClickFunnels Sales::Opportunities::Note API
  termsOfService: https://www.clickfunnels.com/terms-of-service
  contact:
    name: ClickFunnels API Team
    url: https://developers.myclickfunnels.com
  x-logo:
    url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
  description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.

    '
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
  description: ClickFunnels API
  variables:
    subdomain:
      default: myworkspace
security:
- BearerAuth: []
tags:
- name: Sales::Opportunities::Note
  description: Sales Opportunity Notes
paths:
  /sales/opportunities/{opportunity_id}/notes:
    get:
      tags:
      - Sales::Opportunities::Note
      summary: List Notes
      description: List Notes
      operationId: listSalesOpportunitiesNotes
      parameters:
      - name: opportunity_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - $ref: '#/components/parameters/sort_property'
      - name: filter
        in: query
        description: '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](https://developers.myclickfunnels.com/docs/filtering).

          '
        required: false
        schema:
          type: object
          properties:
            id:
              type: string
              description: A comma-separated list of note IDs to filter by (within the scope of the opportunity).
              example: 1,42
            created_by_id:
              type: string
              description: A comma-separated list of memberships IDs to filter by.
              example: 1,42
        style: deepObject
        explode: true
      responses:
        '200':
          description: OK
          headers:
            Pagination-Next:
              $ref: '#/components/headers/PaginationNext'
            Link:
              $ref: '#/components/headers/Link'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SalesOpportunitiesNoteAttributes'
              example:
              - id: 370
                public_id: qenzYJ
                opportunity_id: 184
                content: Example note
                created_by_id: 398
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
              - id: 385
                public_id: lmPuLs
                opportunity_id: 191
                content: Example note
                created_by_id: 413
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID.
              example:
                error: 'Not found: Record missing'
    post:
      tags:
      - Sales::Opportunities::Note
      summary: Create Note
      description: Create Note
      operationId: createSalesOpportunitiesNotes
      parameters:
      - name: opportunity_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Note
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                sales_opportunities_note:
                  type: object
                  $ref: '#/components/schemas/SalesOpportunitiesNoteParameters'
            example:
              sales_opportunities_note:
                content: Example note
                created_by_id: 42
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesOpportunitiesNoteAttributes'
              example:
                id: 415
                public_id: iDXPLk
                opportunity_id: 205
                content: Example note
                created_by_id: 443
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
  /sales/opportunities/notes/{id}:
    get:
      tags:
      - Sales::Opportunities::Note
      summary: Fetch Note
      description: Fetch Note
      operationId: getSalesOpportunitiesNotes
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesOpportunitiesNoteAttributes'
              example:
                id: 400
                public_id: rNdsgj
                opportunity_id: 198
                content: Example note
                created_by_id: 428
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    put:
      tags:
      - Sales::Opportunities::Note
      summary: Update Note
      description: Update Note
      operationId: updateSalesOpportunitiesNotes
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Note
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                sales_opportunities_note:
                  type: object
                  $ref: '#/components/schemas/SalesOpportunitiesNoteParametersUpdate'
            example:
              sales_opportunities_note:
                content: Example Note
                created_by_id: 42
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesOpportunitiesNoteAttributes'
              example:
                id: 445
                public_id: sLzcfJ
                opportunity_id: 219
                content: Example note
                created_by_id: 473
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    delete:
      tags:
      - Sales::Opportunities::Note
      summary: Remove Note
      description: Remove Note
      operationId: removeSalesOpportunitiesNotes
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
components:
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    sort_property:
      name: sort_property
      in: query
      description: '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.

        '
      required: false
      schema:
        type: string
        enum:
        - id
        - updated_at
    sort_order:
      name: sort_order
      in: query
      description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination).
      required: false
      schema:
        type: string
        enum:
        - asc
        - desc
    after:
      name: after
      in: query
      required: false
      schema:
        type: string
      description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination).
  schemas:
    SalesOpportunitiesNoteAttributes:
      type: object
      title: Notes
      description: Notes
      properties:
        id:
          type: integer
          description: Note ID
        public_id:
          type:
          - string
          - 'null'
          description: Note public ID
        opportunity_id:
          type: integer
          description: Opportunity
        content:
          type: string
          description: Content
        created_by_id:
          type:
          - integer
          - 'null'
          description: '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_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Note creation date
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Note last updated date
      example:
        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'
      required:
      - content
      - created_at
      - created_by_id
      - id
      - opportunity_id
      - public_id
      - updated_at
    SalesOpportunitiesNoteParameters:
      type: object
      title: Notes
      description: Notes
      required:
      - content
      properties:
        content:
          type: string
          description: Content
        created_by_id:
          type: integer
          description: 'The ID of the Team-Membership that created the note. When creating notes via the API, this defaults to the ClickFunnels API default User''s Membership ID. You can retrieve a list of available Memberships and their id via the Team resource''s memberships property.

            '
      example:
        sales_opportunities_note:
          content: Example note
          created_by_id: 42
    SalesOpportunitiesNoteParametersUpdate:
      type: object
      title: Notes
      description: Notes
      required: []
      properties:
        content:
          type: string
          description: Content
        created_by_id:
          type: integer
          description: 'The ID of the Team-Membership that created the note. When creating notes via the API, this defaults to the ClickFunnels API default User''s Membership ID. You can retrieve a list of available Memberships and their id via the Team resource''s memberships property.

            '
      example:
        sales_opportunities_note:
          content: Example Note
          created_by_id: 42
  headers:
    Link:
      description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value.
      schema:
        type: string
    PaginationNext:
      description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page.
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com