> ## Documentation Index
> Fetch the complete documentation index at: https://developer.meetergo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get public appointment details

> Retrieves public appointment information that can be accessed with or without authentication



## OpenAPI

````yaml /openapi.json get /v4/appointment/public/{appointmentId}
openapi: 3.0.0
info:
  title: meetergo Platform API
  description: >-
    Scheduling, CRM and invoicing in one API: create users, manage availability
    and bookings, connect calendars, keep contacts and deals in sync, and take
    an offer through to a paid invoice.
  version: 3.274.0
  contact: {}
  termsOfService: https://www.meetergo.com/tos/
servers: []
security: []
tags:
  - name: User V4
    description: Create and manage users in your workspace
  - name: Meeting Type V4
    description: Configure meeting templates with durations, buffers, and conferencing
  - name: availability
    description: Manage weekly schedules and availability settings
  - name: Booking V4
    description: Create new bookings
  - name: Booking Availability V4
    description: Query available time slots for booking
  - name: Appointment V4
    description: Manage existing appointments
  - name: Attendee V4
    description: Manage attendee details and notes
  - name: Calendar Connections V4
    description: Connect and sync external calendars
  - name: Signatures V4
    description: >-
      Send PDFs for e-signature and download the signed, eIDAS-grade document
      (DocuSeal-compatible)
  - name: WhatsApp V4
    description: >-
      Send and receive WhatsApp messages by phone number and read conversation
      history
  - name: One Time Booking Link V4
    description: Create single-use booking links
  - name: availability-exception
    description: Override availability for specific dates
  - name: Booking Link V4
    description: Configure various booking page types
  - name: Personal Page V4
    description: Manage user profile pages
  - name: Handoff V4
    description: Reassign meetings to other hosts
  - name: Calendar Auth V4
    description: OAuth callbacks for calendar providers
  - name: CRM Contacts
    description: >-
      Create, find, and update the people in your CRM, including their custom
      data fields
  - name: CRM Deals
    description: >-
      Create, update, and track deals through pipeline stages (incl. per-deal
      activity history)
  - name: CRM Pipelines
    description: Manage pipelines and their stages
  - name: CRM Tasks
    description: Tasks on contacts, deals and companies
  - name: CRM Notes
    description: Notes on contacts, deals and companies
  - name: CRM Attachments
    description: Files attached to contacts, deals and companies
  - name: CRM Communications
    description: Logged calls, messages and meetings on contacts, deals and companies
  - name: CRM Email Sync
    description: Read the email history synced from connected mailboxes (read-only)
  - name: Data Fields
    description: >-
      Define the custom fields a contact can carry; their `name` is the key used
      in a contact's additionalData
  - name: Invoicing Documents
    description: >-
      Offers and invoices: create a draft, finalize it into a numbered
      e-invoice, send it, record payments, and run Mahnwesen
  - name: Invoicing Products
    description: Reusable products for invoice line items
  - name: Invoicing Settings
    description: Seller details, tax treatment, bank accounts, and number ranges
  - name: Invoicing Recurring
    description: >-
      Recurring schedules, billing runs over completed meetings, buyer prefill,
      and DATEV export
  - name: Queue V4
    description: Round-robin and queue-based routing (Beta)
  - name: Queue User Group V4
    description: Manage queue user groups (Beta)
  - name: Meeting Type Template V4
    description: Reusable meeting type configurations (Beta)
  - name: Attendee Pending V4
    description: Manage pending attendee approvals (Beta)
  - name: Provisional Booking V4
    description: Manage provisional/unconfirmed bookings (Beta)
paths:
  /v4/appointment/public/{appointmentId}:
    get:
      tags:
        - Appointment V4
      summary: Get public appointment details
      description: >-
        Retrieves public appointment information that can be accessed with or
        without authentication
      operationId: getPublicAppointment
      parameters:
        - name: appointmentId
          required: true
          in: path
          description: The unique identifier of the appointment
          schema:
            type: string
        - name: secret
          required: false
          in: query
          description: Optional secret key for accessing appointment details
          schema:
            type: string
      responses:
        '200':
          description: Public appointment details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicAppointment'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    PublicAppointment:
      type: object
      properties:
        id:
          type: string
          description: Appointment unique identifier
        meetingTypeId:
          type: string
          description: Meeting type ID associated with this appointment
        meetingInfo:
          description: Meeting information including title, duration, and other details
          allOf:
            - $ref: '#/components/schemas/MeetingInfo'
        online:
          type: boolean
          description: Whether the appointment is conducted online
        start:
          type: string
          description: Appointment start time (ISO string)
        end:
          type: string
          description: Appointment end time (ISO string)
        isCancelled:
          type: boolean
          description: Whether the appointment has been cancelled
        location:
          type: string
          description: Physical location address
        channel:
          description: Meeting channel type (e.g., video conference platform)
          allOf:
            - $ref: '#/components/schemas/MeetingTypeChannel'
        hosts:
          description: List of appointment hosts with basic information
          allOf:
            - $ref: '#/components/schemas/PublicAppointmentHost'
        company:
          description: Public company information
          allOf:
            - $ref: '#/components/schemas/PublicCompanyInfo'
        disableActionButtons:
          type: boolean
          description: >-
            Whether action buttons (reschedule, cancel) are disabled for this
            appointment
        cancellationPolicy:
          description: Cancellation policy for this appointment
          allOf:
            - $ref: '#/components/schemas/CancellationPolicySetting'
        reschedulingPolicy:
          description: Rescheduling policy for this appointment
          allOf:
            - $ref: '#/components/schemas/ReschedulingPolicySetting'
        timezonePreset:
          description: >-
            Timezone preset of the meeting type. When enabled, the reschedule
            page must render slots in this timezone instead of the visitor
            device timezone, matching the booking page.
          allOf:
            - $ref: '#/components/schemas/TimezonePresetSetting'
        timeFormat:
          description: Default time format on the booking and reschedule pages
          allOf:
            - $ref: '#/components/schemas/BookingTimeFormat'
        language:
          type: string
          description: Attendee's resolved language for this booking
        meetingLink:
          type: string
          description: Meeting link - only provided with proper authentication
        ics:
          type: string
          description: ICS calendar file content - only provided with proper authentication
        customCss:
          type: string
          description: Custom CSS styling for the appointment page
        showConfetti:
          type: boolean
          description: Whether to show confetti animation on the confirmation page
        enableWithdrawalButton:
          type: boolean
          description: >-
            Whether to show the withdrawal button ("Widerrufsbutton") on the
            confirmation page. Off by default; required from 19 June 2026 (§
            356a BGB) for B2C distance contracts with a right of withdrawal.
        createdAt:
          type: string
          description: >-
            When the appointment was booked (contract conclusion). The 14-day
            statutory withdrawal window runs from this timestamp.
        queueId:
          type: string
          description: Queue ID - required for rescheduling on round robin meetings
        recurringSeriesId:
          type: string
          description: >-
            Recurring series ID if this appointment is part of a recurring
            series
        occurrenceNumber:
          type: number
          description: 1-based index of this appointment within the recurring series
        recurringSeries:
          description: >-
            Recurring series information if this appointment is part of a
            recurring series
          allOf:
            - $ref: '#/components/schemas/PublicRecurringSeries'
        isBundleBooking:
          type: boolean
          description: Whether this appointment was booked as part of a bundle
        bundleId:
          type: string
          description: Bundle ID if this is a bundle booking
        bundleItems:
          description: Bundle items if this is a bundle booking
          type: array
          items:
            $ref: '#/components/schemas/PublicBundleItem'
      required:
        - id
        - meetingInfo
        - online
        - start
        - end
        - isCancelled
        - channel
        - hosts
        - company
        - disableActionButtons
        - timeFormat
        - language
        - showConfetti
        - enableWithdrawalButton
        - createdAt
    MeetingInfo:
      type: object
      properties:
        name:
          type: string
          description: Name of the meeting type
        description:
          type: string
          description: Description of the meeting type
        nameLocalised:
          nullable: true
          description: Per-language overrides for the title. Falls back to `name`.
          allOf:
            - $ref: '#/components/schemas/LocalisedContent'
        descriptionLocalised:
          nullable: true
          description: >-
            Per-language overrides for the description. Falls back to
            `description`.
          allOf:
            - $ref: '#/components/schemas/LocalisedContent'
        enableRedirect:
          type: boolean
          description: Enable redirect after booking completion
        redirect:
          type: string
          description: Redirect URL to navigate after booking
        passEventDetailsToRedirect:
          type: boolean
          description: >-
            Pass event details (invitee name, email, form answers) as query
            params to redirect URL
        duration:
          type: number
          description: Primary duration in minutes
        channel:
          description: Meeting channel/location type
          allOf:
            - $ref: '#/components/schemas/MeetingTypeChannel'
        customChannelName:
          type: string
          description: Custom name for the meeting channel
        customChannelLink:
          type: string
          description: Custom link for the meeting channel
        connectChannelName:
          type: string
          description: Custom display name for the connect channel
        groupBooking:
          type: boolean
          description: Enable group booking (multiple attendees per slot)
        showAvailableSlots:
          type: boolean
          description: Show available spots count on the booking page
        enrichInvitee:
          type: boolean
          description: Enable invitee data enrichment
        autoCreateSpace:
          type: boolean
          description: Auto-create a Space when someone books
        spacePresetId:
          type: object
          description: Space preset id used for the auto-created Space
          nullable: true
        spaceAutoInvite:
          type: boolean
          description: Publish the auto-created Space and invite the booker
        confirmationButton:
          description: Confirmation button settings
          allOf:
            - $ref: '#/components/schemas/ConfirmationButton'
        bufferBefore:
          type: number
          description: Buffer time before meeting in minutes
        bufferAfter:
          type: number
          description: Buffer time after meeting in minutes
        bufferMustStayWithinWorkingHours:
          type: boolean
          description: >-
            Only offer slots where buffer fits within working hours (no
            spillover into breaks or after-hours)
        rollingSlots:
          type: boolean
          description: >-
            Restart the slot grid after each appointment instead of keeping a
            fixed grid per working block
        color:
          type: object
          description: Color for the meeting type in RGB format, e.g. "rgb(0, 153, 255)"
          nullable: true
      required:
        - name
        - description
        - enableRedirect
        - redirect
        - passEventDetailsToRedirect
        - duration
        - channel
        - customChannelName
        - customChannelLink
        - connectChannelName
        - groupBooking
        - showAvailableSlots
        - enrichInvitee
        - autoCreateSpace
        - spaceAutoInvite
        - confirmationButton
        - bufferBefore
        - bufferAfter
        - bufferMustStayWithinWorkingHours
        - rollingSlots
    MeetingTypeChannel:
      type: string
      enum:
        - local
        - local-attendee
        - google
        - zoom
        - phone
        - phone-incoming
        - whatsapp
        - connect
        - webex
        - skypeForConsumer
        - skypeForBusiness
        - teamsForBusiness
        - teamsForBusiness2
        - teamsForExchange
        - teams2ForExchange
        - custom
        - resource
        - whereby
        - kmeet
        - zava
        - jitsi
        - nextcloudTalk
        - openTalk
        - alfaview
      description: Meeting channel/location type
    PublicAppointmentHost:
      type: object
      properties:
        id:
          type: string
          description: Host user unique identifier
        firstname:
          type: string
          description: Host first name
        lastname:
          type: string
          description: Host last name
        picture:
          type: string
          description: Host profile picture URL
        emailVerified:
          type: boolean
          description: Whether the host has verified their email
      required:
        - id
        - firstname
        - lastname
        - emailVerified
    PublicCompanyInfo:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        slug:
          type: string
          description: >-
            Company slug. Public pages address the company by it, e.g. the
            statutory withdrawal page at /widerruf/<slug>.
        description:
          type: string
        logo:
          type: string
        tier:
          allOf:
            - $ref: '#/components/schemas/CompanyTier'
        primaryColor:
          type: string
        useBrandStyling:
          type: boolean
        hideMeetergoBranding:
          type: boolean
        businessCardTheme:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/BusinessCardTheme'
        enforceBusinessCardTheme:
          type: boolean
        showDataPolicyLink:
          type: boolean
        hideDataPolicyCheckbox:
          type: boolean
        enableWithdrawalFunction:
          type: boolean
          description: >-
            Whether the statutory withdrawal function (§ 356a BGB) is published
            for this company. Drives the "Vertrag widerrufen" link in the
            booking pages' legal footer.
        dataPolicyLink:
          type: string
          nullable: true
        imprintLink:
          type: string
          nullable: true
        deleted:
          type: boolean
        useFormalBookingLanguage:
          type: boolean
        enableCustomLegalText:
          type: boolean
        enableCookieBanner:
          type: boolean
        customLegalText:
          type: string
        customBookingCSS:
          type: string
        featureAccess:
          $ref: '#/components/schemas/FeatureAccess'
        language:
          type: string
        allowedLanguages:
          type: array
          items:
            type: string
        googleAnalyticsMeasurementId:
          type: string
          nullable: true
        metaPixelId:
          type: string
          nullable: true
        tiktokPixelId:
          type: string
          nullable: true
        gtmContainerId:
          type: string
          nullable: true
        gtmServerContainerUrl:
          type: string
          nullable: true
        matomoUrl:
          type: string
          nullable: true
        matomoSiteId:
          type: string
          nullable: true
        usercentricsSettingsId:
          type: string
        usercentricsConfig:
          type: object
      required:
        - id
        - name
        - slug
        - description
        - tier
        - primaryColor
        - useBrandStyling
        - hideMeetergoBranding
        - enforceBusinessCardTheme
        - showDataPolicyLink
        - hideDataPolicyCheckbox
        - enableWithdrawalFunction
        - dataPolicyLink
        - imprintLink
        - deleted
        - useFormalBookingLanguage
        - enableCustomLegalText
        - enableCookieBanner
        - customLegalText
        - customBookingCSS
        - featureAccess
        - language
        - googleAnalyticsMeasurementId
        - metaPixelId
        - tiktokPixelId
        - gtmContainerId
        - gtmServerContainerUrl
        - matomoUrl
        - matomoSiteId
    CancellationPolicySetting:
      type: object
      properties:
        enable:
          type: boolean
        mode:
          type: string
          enum:
            - disabled
            - hours
            - days
        duration:
          type: object
      required:
        - enable
    ReschedulingPolicySetting:
      type: object
      properties:
        enable:
          type: boolean
        mode:
          type: string
          enum:
            - disabled
            - hours
            - days
        duration:
          type: object
      required:
        - enable
    TimezonePresetSetting:
      type: object
      properties:
        enable:
          type: boolean
        timezonePreset:
          type: string
      required:
        - enable
    BookingTimeFormat:
      type: string
      enum:
        - '12'
        - '24'
    PublicRecurringSeries:
      type: object
      properties:
        id:
          type: string
          description: Series ID
        mode:
          enum:
            - recurring
            - multi_slot
          type: string
          description: Mode of the series (recurring or multi_slot)
        frequency:
          nullable: true
          enum:
            - weekly
            - biweekly
            - monthly
          type: string
          description: Frequency of the series (only for recurring mode)
        totalOccurrences:
          type: number
          description: Total number of occurrences in this series
        appointments:
          description: All appointments in this series
          type: array
          items:
            $ref: '#/components/schemas/RecurringSeriesAppointment'
      required:
        - id
        - mode
        - totalOccurrences
        - appointments
    PublicBundleItem:
      type: object
      properties:
        meetingTypeId:
          type: string
          description: Meeting type ID
        meetingTypeName:
          type: string
          description: Meeting type name
        duration:
          type: number
          description: Duration in minutes
        price:
          type: number
          description: Price
        startTime:
          type: string
          description: Start time of this segment (ISO string)
        endTime:
          type: string
          description: End time of this segment (ISO string)
        sortOrder:
          type: number
          description: Order in the bundle
        hosts:
          description: Hosts for this segment
          type: array
          items:
            $ref: '#/components/schemas/PublicAppointmentHost'
      required:
        - meetingTypeId
        - meetingTypeName
        - duration
        - startTime
        - endTime
        - sortOrder
        - hosts
    ApiError:
      type: object
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          example: 400
        message:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
          description: >-
            A sentence, or the list of field constraints that failed. Validation
            errors name the offending property.
          example:
            - limit must not be greater than 100
        error:
          type: string
          example: BadRequestException
    LocalisedContent:
      type: object
      properties:
        en:
          type: string
        de:
          type: string
        fr:
          type: string
        es:
          type: string
        'no':
          type: string
        it:
          type: string
        nl:
          type: string
        da:
          type: string
        pl:
          type: string
        se:
          type: string
        tr:
          type: string
      required:
        - en
    ConfirmationButton:
      type: object
      properties:
        useConfirmationButton:
          type: boolean
        text:
          type: string
        color:
          type: string
        link:
          type: string
      required:
        - useConfirmationButton
        - text
        - color
        - link
    CompanyTier:
      type: string
      enum:
        - basic
        - essentials
        - growth
        - teams
        - light
        - suite
        - premium
        - enterprise
    BusinessCardTheme:
      type: object
      properties:
        preset:
          type: string
          description: Theme preset key, e.g. classic, nocturne
        accent:
          type: string
          description: Hex accent color override
        background:
          $ref: '#/components/schemas/BusinessCardBackground'
        font:
          type: string
          enum:
            - sans
            - serif
            - grotesk
            - mono
            - condensed
            - rounded
        buttonShape:
          type: string
          enum:
            - sharp
            - rounded
            - pill
    FeatureAccess:
      type: object
      properties:
        polls:
          type: boolean
        advancedMeetingTypeSettings:
          type: boolean
        workflows:
          type: boolean
        maxWorkflows:
          type: number
          description: '-1 means unlimited'
        meetingTypeCommunications:
          type: boolean
        multiHostBooking:
          type: boolean
        groupBooking:
          type: boolean
        enrichInvitee:
          type: boolean
        autoCreateSpace:
          type: boolean
        zapier:
          type: boolean
        personalizedBranding:
          type: boolean
        visualBranding:
          type: boolean
        crmIntegration:
          type: boolean
        cmpIntegration:
          type: boolean
        routingForms:
          type: boolean
        basicForms:
          type: boolean
        selectionPages:
          type: boolean
        dataFields:
          type: boolean
        roundRobin:
          type: boolean
        accountOwnerMatching:
          type: boolean
        handoff:
          type: boolean
        reschedule:
          type: boolean
        notifications:
          type: boolean
        workspaces:
          type: boolean
        api:
          type: boolean
        showcaseHubs:
          type: boolean
        meetergoConnect:
          type: boolean
        connectMaxParticipants:
          type: number
        connectMaxCallMinutes:
          type: number
        connectRecording:
          type: boolean
        connectBreakouts:
          type: boolean
        connectWebinars:
          type: boolean
        webhooks:
          type: boolean
        wallets:
          type: boolean
        dealSpace:
          type: boolean
        funnel:
          type: boolean
        unlimitedMeetingTypes:
          type: boolean
        salesforceIntegration:
          type: boolean
        salesforceStudioMapping:
          type: boolean
        salesforceRouting:
          type: boolean
        maximumCalendars:
          type: number
        disableIntercom:
          type: boolean
        supportChat:
          type: boolean
        evalancheIntegration:
          type: boolean
        analytics:
          type: boolean
        bookingFunnel:
          type: boolean
        funnelProgressAndInfobox:
          type: boolean
        contactsBeta:
          type: boolean
        paypalIntegration:
          type: boolean
        stripeIntegration:
          type: boolean
        mollieIntegration:
          type: boolean
        meetingTypeTemplates:
          type: boolean
        nextBeta:
          type: boolean
        video:
          type: boolean
        emailLayout:
          type: boolean
        reviews:
          type: boolean
        brevoIntegration:
          type: boolean
        getResponseIntegration:
          type: boolean
        customDomain:
          type: boolean
        maxCustomDomains:
          type: number
        maxViewers:
          type: number
          description: '-1 means unlimited'
        apiPlatform:
          type: boolean
        slackIntegration:
          type: boolean
        calgent:
          type: boolean
        miraPipelineAutopilot:
          type: boolean
        fileUploads:
          type: boolean
        knowledgePageLimit:
          type: number
        storageQuotaMB:
          type: number
        recordingRetentionDays:
          type: number
        multiBooking:
          type: boolean
        bundles:
          type: boolean
        maxCrmDeals:
          type: number
        maxShowcaseHubs:
          type: number
        maxDealSpaces:
          type: number
        waitlist:
          type: boolean
        notetaker:
          type: boolean
        notetakerRecording:
          type: boolean
        maxNotetakerRecapsPerMonth:
          type: number
        maxLinkedInLookupsPerMonth:
          type: number
        quickMail:
          type: boolean
        enrichDealSpaceCompany:
          type: boolean
        whatsappAddon:
          type: boolean
        conversionWidgetNativeScheduling:
          type: boolean
        instagramDms:
          type: boolean
        bookingCoupons:
          type: boolean
        crmEmailSync:
          type: boolean
        websiteChat:
          type: boolean
        emailChannel:
          type: boolean
        teamChat:
          type: boolean
        aiPhoneAssistant:
          type: boolean
        aiPhoneAssistantAdvanced:
          type: boolean
        bookingLocations:
          type: boolean
        bookingBlocks:
          type: boolean
        invoicing:
          type: boolean
        purchaseDocuments:
          type: boolean
        hostedEvents:
          type: boolean
        hostedEventTicketing:
          type: boolean
        paymentLinks:
          type: boolean
        feedbackLoop:
          type: boolean
        newsletter:
          type: boolean
        maxFormSubmissionsPerMonth:
          type: number
        maxSignatureRequestsPerMonth:
          type: number
        advancedSignatures:
          type: boolean
        maxAdvancedSignatureRequestsPerMonth:
          type: number
        maxInvoicesPerMonth:
          type: number
        whatsappAiAgent:
          type: boolean
        customSmtp:
          type: boolean
        csvExport:
          type: boolean
      required:
        - polls
        - advancedMeetingTypeSettings
        - workflows
        - maxWorkflows
        - meetingTypeCommunications
        - multiHostBooking
        - groupBooking
        - enrichInvitee
        - autoCreateSpace
        - zapier
        - personalizedBranding
        - visualBranding
        - crmIntegration
        - cmpIntegration
        - routingForms
        - basicForms
        - selectionPages
        - dataFields
        - roundRobin
        - accountOwnerMatching
        - handoff
        - reschedule
        - notifications
        - workspaces
        - api
        - showcaseHubs
        - meetergoConnect
        - connectMaxParticipants
        - connectMaxCallMinutes
        - connectRecording
        - connectBreakouts
        - connectWebinars
        - webhooks
        - wallets
        - dealSpace
        - funnel
        - unlimitedMeetingTypes
        - salesforceIntegration
        - salesforceStudioMapping
        - salesforceRouting
        - maximumCalendars
        - disableIntercom
        - supportChat
        - evalancheIntegration
        - analytics
        - bookingFunnel
        - funnelProgressAndInfobox
        - contactsBeta
        - paypalIntegration
        - stripeIntegration
        - mollieIntegration
        - meetingTypeTemplates
        - nextBeta
        - video
        - emailLayout
        - reviews
        - brevoIntegration
        - getResponseIntegration
        - customDomain
        - maxCustomDomains
        - maxViewers
        - apiPlatform
        - slackIntegration
        - calgent
        - miraPipelineAutopilot
        - fileUploads
        - knowledgePageLimit
        - storageQuotaMB
        - recordingRetentionDays
        - multiBooking
        - bundles
        - maxCrmDeals
        - maxShowcaseHubs
        - maxDealSpaces
        - waitlist
        - notetaker
        - notetakerRecording
        - maxNotetakerRecapsPerMonth
        - maxLinkedInLookupsPerMonth
        - quickMail
        - enrichDealSpaceCompany
        - whatsappAddon
        - conversionWidgetNativeScheduling
        - instagramDms
        - bookingCoupons
        - crmEmailSync
        - websiteChat
        - emailChannel
        - teamChat
        - aiPhoneAssistant
        - aiPhoneAssistantAdvanced
        - bookingLocations
        - bookingBlocks
        - invoicing
        - purchaseDocuments
        - hostedEvents
        - hostedEventTicketing
        - paymentLinks
        - feedbackLoop
        - newsletter
        - maxFormSubmissionsPerMonth
        - maxSignatureRequestsPerMonth
        - advancedSignatures
        - maxAdvancedSignatureRequestsPerMonth
        - maxInvoicesPerMonth
        - whatsappAiAgent
        - customSmtp
        - csvExport
    RecurringSeriesAppointment:
      type: object
      properties:
        id:
          type: string
          description: Appointment ID
        start:
          type: string
          description: Appointment start time (ISO string)
        end:
          type: string
          description: Appointment end time (ISO string)
        isCancelled:
          type: boolean
          description: Whether the appointment has been cancelled
        occurrenceNumber:
          type: number
          description: 1-based index in the recurring series
        secret:
          type: string
          description: >-
            Secret for this appointment - only included when caller is
            authenticated
      required:
        - id
        - start
        - end
        - isCancelled
        - occurrenceNumber
    BusinessCardBackground:
      type: object
      properties:
        type:
          type: string
          enum:
            - solid
            - gradient
            - image
        value:
          type: string
  responses:
    BadRequest:
      description: >-
        The request did not validate. `message` lists the constraints that
        failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Missing, malformed, or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: >-
        Authenticated, but not allowed: the plan does not include this feature,
        or the token is scoped away from it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: >-
        No such resource in your account. Resources belonging to another account
        are reported the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    TooManyRequests:
      description: Rate limited. Back off and retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.