ClickFunnels Appointments::Scheduled Event API

openapi: 3.2.0
info:
  title: ClickFunnels Appointments::Scheduled 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: Appointments::ScheduledEvent
  description: '> Scheduled Appointment Events represent set meeting events


    The Appointment Scheduled Event represents a scheduled meeting between a ClickFunnels user and a contact on a specific day and time.'
paths:
  /workspaces/{workspace_id}/appointments/scheduled_events:
    get:
      tags:
      - Appointments::ScheduledEvent
      summary: List Scheduled Events
      operationId: listAppointmentsScheduledEvents
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/per_page'
      - $ref: '#/components/parameters/sort_order'
      - $ref: '#/components/parameters/sort_property'
      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/AppointmentsScheduledEventAttributes'
              example:
              - id: 2
                public_id: THudgA
                workspace_id: 42000
                start_on: '2025-01-01T00:00:00.000Z'
                end_on: '2025-01-01T00:00:00.000Z'
                status: scheduled
                max_invitees: 1
                order_id: null
                comments: This is an example scheduled event for testing purposes.
                tzid: America/Los_Angeles
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                event_type:
                  name: 30 Minute Meeting
                primary_contact:
                  id: 41
                  public_id: wuHLvl
                  email_address: test-f2a9de6fe23672ca2a72@example.com
                  first_name: Jules
                  last_name: Connelly
                  phone_number: (224) 508-1342 x59891
              - id: 3
                public_id: JbGkLQ
                workspace_id: 42000
                start_on: '2025-01-01T00:00:00.000Z'
                end_on: '2025-01-01T00:00:00.000Z'
                status: scheduled
                max_invitees: 1
                order_id: null
                comments: This is an example scheduled event for testing purposes.
                tzid: America/Los_Angeles
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                event_type:
                  name: 30 Minute Meeting
                primary_contact:
                  id: 42
                  public_id: mOuNlh
                  email_address: test-789e44776663df4ef58a@example.com
                  first_name: Bobbie
                  last_name: Zboncak
                  phone_number: (224) 508-1342 x59891
        '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
        '422':
          $ref: '#/components/responses/InvalidPageSize'
components:
  parameters:
    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
    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:
    InvalidPageSize:
      description: Unprocessable Entity - `per_page` must be a positive integer.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              hint:
                type:
                - string
                - 'null'
                description: Next step for the caller, or null when no additional guidance applies.
          example:
            error: 'Request unprocessable: per_page must be a positive integer, capped at 100 (got "0")'
            hint: null
  schemas:
    AppointmentsScheduledEventAttributes:
      type: object
      title: Scheduled events
      description: Scheduled events
      properties:
        id:
          type: integer
          description: Scheduled event ID
        public_id:
          type:
          - string
          - 'null'
          description: The unique public identifier for the scheduled event
        workspace_id:
          type: integer
          description: Workspace ID
        start_on:
          type: string
          format: date-time
          description: Event Start Time
        end_on:
          type:
          - string
          - 'null'
          format: date-time
          description: End On
        status:
          type:
          - string
          - 'null'
          description: Status
        max_invitees:
          type:
          - integer
          - 'null'
          description: Max Invitees
        order_id:
          type:
          - string
          - 'null'
          description: Event Payment Order
        comments:
          type:
          - string
          - 'null'
          description: Please share anything that will help prepare for our meeting.
        tzid:
          type:
          - string
          - 'null'
          description: Timezone
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Added
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Updated
        event_type:
          type:
          - object
          - 'null'
          title: Scheduled events
          description: Event type information (can be null in rare cases if the event type has been deleted, but the event record wasn't)
          properties:
            name:
              type:
              - string
              - 'null'
              description: The display name of the scheduled event, typically including event type and invitee information
        primary_contact:
          type:
          - object
          - 'null'
          title: Scheduled events
          description: Scheduled events
          properties:
            id:
              type: integer
              description: Scheduled event ID
            public_id:
              type:
              - string
              - 'null'
              description: The unique public identifier for the scheduled event
            email_address:
              type:
              - string
              - 'null'
              description: The email address of the primary invitee for this scheduled event
            first_name:
              type:
              - string
              - 'null'
              description: The first name of the primary invitee for this scheduled event
            last_name:
              type:
              - string
              - 'null'
              description: The last name of the primary invitee for this scheduled event
            phone_number:
              type:
              - string
              - 'null'
              description: The phone number of the primary invitee for this scheduled event
      example:
        id: 1
        public_id: mdheDs
        workspace_id: 42000
        start_on: '2025-01-01T00:00:00.000Z'
        end_on: '2025-01-01T00:00:00.000Z'
        status: scheduled
        max_invitees: 1
        order_id: null
        comments: This is an example scheduled event for testing purposes.
        tzid: America/Los_Angeles
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
        event_type:
          name: 30 Minute Meeting
        primary_contact:
          id: 1
          public_id: uONtxf
          email_address: test-5cc06c0232058b060025@example.com
          first_name: Shanita
          last_name: Lockman
          phone_number: (224) 508-1342 x59891
  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
  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)