ClickFunnels Contacts::Event API

openapi: 3.2.0
info:
  title: ClickFunnels Contacts::Event 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.


    ### For AI agents


    This document is the catalogue: every operation ClickFunnels exposes over REST is described here, with a unique operationId, typed schemas, and the scopes it needs. It is served from `/openapi.json`, `/openapi.yaml`, `/api/openapi.{json,yaml}`, and `/api/v2/openapi.{json,yaml}` on the accounts host.


    Three things it does not describe, each one request away:


    - MCP server: the app-native Model Context Protocol server (Streamable HTTP, OAuth 2.1 with PKCE). Prefer it over raw REST when your client supports MCP - it describes itself at runtime.

    - Skill guides, also as an Agent Skills index: one task guide per job (pages, blogs, products, orders, workflows, emails, courses, stats, external SDK pages). Read the guide that matches your job before your first write. llms.txt covers when to use ClickFunnels at all, how to get credentials, and how to behave around rate limits.

    - Protected resource metadata (RFC 9728) and authorization server metadata (RFC 8414): the scope vocabulary and the OAuth endpoints. Dynamic client registration is for MCP clients only.


    On ClickFunnels-owned API hosts (`myclickfunnels.com` and its subdomains), the OpenAPI specification responses and API authentication failures (401, or 403 for insufficient scope) carry those links in an RFC 8288 `Link` header, so clients can discover the documentation and authentication metadata from those responses. Requests sent through a customer''s custom domain keep the Bearer challenge but omit those discovery pointers.'
  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: []
- OAuth2: []
tags:
- name: Contacts::Event
  description: Contact Activity Event reads, excluding MessageHub conversations.
paths:
  /contacts/{contact_id}/events:
    get:
      tags:
      - Contacts::Event
      description: Read the Event rows used by the contact Activity tab. MessageHub conversation rows are excluded. Numeric and public IDs are accepted. Ordered by created_at then id (ascending by default, desc for latest activity). Pagination-Next is the row id. sort_property is not supported (422). Unfiltered or multi-type reads are refused with 422 above 50,000 events; pass a single filter[type] key to read such a contact.
      summary: List Contact Events
      operationId: listContactsEvents
      parameters:
      - name: contact_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/per_page'
      - $ref: '#/components/parameters/sort_order'
      - name: filter
        in: query
        style: deepObject
        explode: true
        schema:
          type: object
          properties:
            type:
              type: string
              description: Comma-separated event type keys. Unknown keys match no events.
              example: $order.successful_purchase,$contact.note
      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/ContactsEventAttributes'
              example:
              - id: 912345678
                public_id: AbCdEf
                contact_id: 123
                type_key: $contact.note
                type_label: Contact Note
                occurred_at: '2026-10-12T14:03:00.000Z'
                actor_id: null
                data:
                  note: Called about the refund
                created_at: '2026-10-13T09:15:22.000Z'
                order_id: null
                orders_transaction_id: null
                product_id: null
                workflow_id: null
                workflows_step_id: null
                broadcast_id: null
                course_id: null
                courses_section_id: null
                courses_lesson_id: null
                page_id: null
                visit_id: null
                contacts_tag_id: null
                sales_opportunity_id: null
                calendar_event_id: null
                url_redirect_id: null
        '400':
          description: Bad Request - filter is not an object, or names a key other than type.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  hint:
                    type:
                    - string
                    - 'null'
              example:
                error: 'Bad request: found unpermitted parameter: :types'
                hint: null
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  hint:
                    type:
                    - string
                    - 'null'
                    description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
              example:
                error: API key missing or invalid
                hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
        '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.
                  hint:
                    type:
                    - string
                    - 'null'
                    description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
              example:
                error: 'Not found: Record missing'
                hint: null
        '403':
          $ref: '#/components/responses/WorkspaceGrantForbidden'
        '422':
          description: Unprocessable Entity. The `per_page` value must be a positive integer.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  hint:
                    type:
                    - string
                    - 'null'
              example:
                error: Contact has more than 50000 events; pass a single filter[type] key to list them
                hint: null
  /contacts/events/{id}:
    get:
      tags:
      - Contacts::Event
      description: Read the Event rows used by the contact Activity tab. MessageHub conversation rows are excluded. Numeric and public IDs are accepted.
      summary: Fetch Contact Event
      operationId: getContactsEvents
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactsEventAttributes'
              example:
                id: 912345678
                public_id: AbCdEf
                contact_id: 123
                type_key: $contact.note
                type_label: Contact Note
                occurred_at: '2026-10-12T14:03:00.000Z'
                actor_id: null
                data:
                  note: Called about the refund
                created_at: '2026-10-13T09:15:22.000Z'
                order_id: null
                orders_transaction_id: null
                product_id: null
                workflow_id: null
                workflows_step_id: null
                broadcast_id: null
                course_id: null
                courses_section_id: null
                courses_lesson_id: null
                page_id: null
                visit_id: null
                contacts_tag_id: null
                sales_opportunity_id: null
                calendar_event_id: null
                url_redirect_id: null
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  hint:
                    type:
                    - string
                    - 'null'
                    description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
              example:
                error: API key missing or invalid
                hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
        '403':
          $ref: '#/components/responses/WorkspaceGrantForbidden'
        '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.
                  hint:
                    type:
                    - string
                    - 'null'
                    description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
              example:
                error: 'Not found: Record missing'
                hint: null
components:
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    per_page:
      name: per_page
      in: query
      required: false
      description: 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](https://developers.myclickfunnels.com/docs/pagination).
      schema:
        type: integer
        minimum: 1
        default: 20
    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).
  responses:
    WorkspaceGrantForbidden:
      description: "Forbidden — this request's workspace is closed to it.\n\nThree cases return this:\n\n* The access token is limited to specific workspaces (see the workspace selection made when\n  the key was provisioned, or the workspaces approved on the OAuth consent screen) and the\n  request acts on a workspace outside that set.\n* The access token is limited to specific workspaces and the request's workspace could not be\n  determined at all. The gate is fail-closed, so a workspace-limited token is denied rather\n  than allowed through when the target workspace is ambiguous.\n* The workspace's team has no active ClickFunnels subscription: it was canceled, is paused,\n  or is locked out after failed payments. Reads and writes are both refused until the\n  subscription is reactivated, and the body carries `\"code\": \"subscription_inactive\"`.\n\nA token with no workspace restriction never receives the first two."
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              code:
                type: string
                description: A machine-readable cause, when there is one. `subscription_inactive` means the workspace's team has no active ClickFunnels subscription.
                enum:
                - subscription_inactive
              hint:
                type:
                - string
                - 'null'
                description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
          examples:
            workspace_not_granted:
              summary: Token not granted this workspace
              value:
                error: 'Forbidden: This access token is limited to specific workspaces and was not granted access to this one.'
                hint: The token's workspace grant was chosen when it was provisioned (Platform Applications) or on the OAuth consent screen. Use GET /api/v2/teams/{team_id}/workspaces to list the workspaces this token can reach (GET /api/v2/teams lists the team ids).
            subscription_inactive:
              summary: Team subscription inactive
              value:
                error: 'Forbidden: This workspace''s team does not have an active ClickFunnels subscription, so API access to it is disabled until the subscription is reactivated.'
                hint: null
                code: subscription_inactive
  headers:
    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
    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
  schemas:
    ContactsEventAttributes:
      type: object
      title: Contact Event
      properties:
        id:
          type: integer
        public_id:
          type: string
        contact_id:
          type: integer
        type_key:
          type:
          - string
          - 'null'
          description: Event type key.
        type_label:
          type:
          - string
          - 'null'
          description: Label of the resolved event type.
        occurred_at:
          type: string
          format: date-time
          description: Tracked occurrence time, falling back to created_at; can differ from list order.
        actor_id:
          type:
          - integer
          - 'null'
          description: User ID, resolvable through GET /api/v2/users/{id}; null for contact or system activity.
        data:
          description: Raw type-dependent JSON, without schema validation. Notes use note; purchases can use value and currency.
        created_at:
          type: string
          format: date-time
        order_id:
          type:
          - integer
          - 'null'
        orders_transaction_id:
          type:
          - integer
          - 'null'
        product_id:
          type:
          - integer
          - 'null'
        workflow_id:
          type:
          - integer
          - 'null'
        workflows_step_id:
          type:
          - integer
          - 'null'
        broadcast_id:
          type:
          - integer
          - 'null'
        course_id:
          type:
          - integer
          - 'null'
        courses_section_id:
          type:
          - integer
          - 'null'
        courses_lesson_id:
          type:
          - integer
          - 'null'
        page_id:
          type:
          - integer
          - 'null'
        visit_id:
          type:
          - integer
          - 'null'
        contacts_tag_id:
          type:
          - integer
          - 'null'
        sales_opportunity_id:
          type:
          - integer
          - 'null'
        calendar_event_id:
          type:
          - integer
          - 'null'
        url_redirect_id:
          type:
          - integer
          - 'null'
      example:
        id: 912345678
        public_id: AbCdEf
        contact_id: 123
        type_key: $contact.note
        type_label: Contact Note
        occurred_at: '2026-10-12T14:03:00.000Z'
        actor_id: null
        data:
          note: Called about the refund
        created_at: '2026-10-13T09:15:22.000Z'
        order_id: null
        orders_transaction_id: null
        product_id: null
        workflow_id: null
        workflows_step_id: null
        broadcast_id: null
        course_id: null
        courses_section_id: null
        courses_lesson_id: null
        page_id: null
        visit_id: null
        contacts_tag_id: null
        sales_opportunity_id: null
        calendar_event_id: null
        url_redirect_id: null
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'A workspace API key or an OAuth access token, sent as `Authorization: Bearer <token>`.


        Both carry the same scope vocabulary as the `OAuth2` scheme below. Category-only

        scopes restrict access to the categories they name. Coarse wildcards remain additive:

        `read contacts:read` reads every category, while `write contacts:read` can write every

        category. Omit coarse scopes when restricting access to specific categories.

        Legacy tokens with only coarse scopes retain their existing unrestricted access;

        a bare `read` scope alone does not enforce read-only access.

        '
    OAuth2:
      type: oauth2
      description: 'OAuth 2.0 authorization code flow for REST integrations. Create a Platform Application

        and follow `https://developers.myclickfunnels.com/docs/oauth-20` to connect users.

        Authorization server metadata is published at

        `https://accounts.myclickfunnels.com/.well-known/oauth-authorization-server`.

        Dynamic client registration at `/oauth/register` is for MCP clients only; MCP-scoped

        tokens must use `https://agents.myclickfunnels.com/mcp`, not the REST API.


        Scopes are least-privilege by category. Ask for the two coarse wildcards (`read`,

        `write`) only when an integration genuinely needs the whole workspace; otherwise ask

        for the `<category>:read` / `<category>:write` pairs you use. `write` implies `read`

        for the same category. Protected resource metadata (RFC 9728) for this API lives at

        `https://accounts.myclickfunnels.com/.well-known/oauth-protected-resource`.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.myclickfunnels.com/oauth/authorize
          tokenUrl: https://accounts.myclickfunnels.com/oauth/token
          refreshUrl: https://accounts.myclickfunnels.com/oauth/token
          scopes:
            read: Read any resource in the granted workspaces
            write: Read and write any resource in the granted workspaces
            contacts:read: Read Contacts
            contacts:write: Read and write Contacts
            workflows:read: Read Workflows (Automations)
            workflows:write: Read and write Workflows (Automations)
            funnels:read: Read Funnels
            funnels:write: Read and write Funnels
            sites:read: Read Sites & Design
            sites:write: Read and write Sites & Design
            courses:read: Read Courses
            courses:write: Read and write Courses
            emails:read: Read Emails
            emails:write: Read and write Emails
            blog:read: Read Blog
            blog:write: Read and write Blog
            community:read: Read Community
            community:write: Read and write Community
            appointments:read: Read Appointments
            appointments:write: Read and write Appointments
            opportunities:read: Read Opportunities
            opportunities:write: Read and write Opportunities
            store:read: Read Store
            store:write: Read and write Store
            forms:read: Read Forms
            forms:write: Read and write Forms
            media:read: Read Media
            media:write: Read and write Media
            webhooks:read: Read Webhooks
            webhooks:write: Read and write Webhooks
            account:read: Read Account
            account:write: Read and write Account
            reference:read: Read Reference Data
            reference:write: Read and write Reference Data
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com
x-provenance:
  method: harvested
  publisher: ClickFunnels
  source: https://accounts.myclickfunnels.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)