> ## 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 paginated provisional bookings

> Retrieves a paginated list of provisional bookings based on the provided criteria.



## OpenAPI

````yaml /openapi.json get /v4/provisional-booking/paginated
openapi: 3.0.0
info:
  title: meetergo Platform API
  description: >-
    Comprehensive scheduling API for creating users, managing availability,
    handling bookings, and connecting calendar providers. Enables seamless
    integration with external platforms and applications.
  version: 0.0.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: 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: 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/provisional-booking/paginated:
    get:
      tags:
        - Provisional Booking V4
      summary: Get paginated provisional bookings
      description: >-
        Retrieves a paginated list of provisional bookings based on the provided
        criteria.
      operationId: getPaginatedProvisionalBookings
      parameters:
        - name: page
          required: true
          in: query
          description: Page number for pagination
          schema:
            type: number
        - name: pageSize
          required: true
          in: query
          description: Number of items per page
          schema:
            type: number
        - name: all
          required: false
          in: query
          description: Fetch all bookings in company, admin only
          schema:
            type: boolean
        - name: userId
          required: false
          in: query
          description: Fetch bookings by userId, admin only
          schema:
            type: string
        - name: meetingTypeId
          required: false
          in: query
          description: Fetch bookings by meetingTypeId, admin only
          schema:
            type: string
        - name: status
          required: false
          in: query
          description: Filter by status
          schema:
            type: string
            enum:
              - pending
              - confirmed
              - expired
              - declined_by_host
        - name: type
          required: false
          in: query
          description: >-
            Filter by type (doubleOptIn = awaiting attendee,
            requireHostConfirmation = needs host action)
          schema:
            enum:
              - doubleOptIn
              - requireHostConfirmation
            type: string
      responses:
        '200':
          description: Successfully retrieved paginated provisional bookings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedProvisionalBookingsResponseDto'
      security:
        - ApiUserHeader: []
        - JWT: []
        - ApiKey: []
components:
  schemas:
    PaginatedProvisionalBookingsResponseDto:
      type: object
      properties:
        provisionalBookings:
          type: array
          items:
            $ref: '#/components/schemas/ProvisionalBookingPayloadResponseDto'
        total:
          type: number
      required:
        - provisionalBookings
        - total
    ProvisionalBookingPayloadResponseDto:
      type: object
      properties:
        id:
          type: string
        dto:
          $ref: '#/components/schemas/BookingDto'
        type:
          enum:
            - doubleOptIn
            - requireHostConfirmation
          type: string
        createdAt:
          type: string
        deletedAt:
          type: string
        queueBookingInfo:
          $ref: '#/components/schemas/NextQueueHostsSelectionReasonDto'
        hosts:
          type: array
          items:
            $ref: '#/components/schemas/UserBasicDto'
        meetingTypeId:
          type: string
      required:
        - id
        - dto
        - type
        - createdAt
    BookingDto:
      type: object
      properties:
        attendee:
          $ref: '#/components/schemas/CreateAttendeeDto'
        meetingTypeId:
          type: string
          description: ID of the meeting type to book.
        hostIds:
          description: >-
            Host IDs for the booking.

            Required for one-on-one bookings (specific host selection).

            Optional for round-robin/queue bookings where queueId is provided
            instead.
          type: array
          items:
            type: string
        start:
          type: string
        appointmentId:
          type: string
        location:
          type: string
        queueId:
          type: string
          description: >-
            required when meeting type has a queue (round-robin / co-host)

            must be undefined for non-queue meetings (one-to-one / group)

            if host selection is true, queue id is required if fastest host
            selection is chosen

            if hosts selection is true, queue id must be undefined if a specific
            host is chosen
        channel:
          allOf:
            - $ref: '#/components/schemas/MeetingTypeChannel'
        duration:
          type: number
          description: >-
            Duration in minutes for the booking. Optional.

            If not provided, uses the meeting type's default duration.

            If provided, must match either the default duration or one of the
            allowed durations configured for the meeting type.

            Primarily needed when meeting type has multiple duration options
            (allowedDurations).
        routingFormId:
          type: string
        ignoreAvailability:
          type: boolean
          description: >-
            Used mainly for instant booker to skip availability checks and
            payment validation for hosts
        attendeePendingId:
          type: number
          description: >-
            ID of pending attendee that will be deleted after successful
            booking.

            This is only needed when "collect during form entry" feature is
            used.

            If not provided, a successful booking may show up in pending
            contacts.
        paymentId:
          type: string
        paymentProvider:
          description: >-
            Selected payment provider for this booking.

            Required when the meeting type has multiple payment providers
            enabled.

            If not provided, falls back to the first enabled provider.
          allOf:
            - $ref: '#/components/schemas/PaymentProvider'
        couponCode:
          type: string
          description: >-
            Coupon code for a discount on paid bookings.

            Validated during payment order creation and re-validated at booking
            time.
          maxLength: 32
        resourceChannelIds:
          description: Ids of the resource channel entity
          type: array
          items:
            type: string
        oneTimeLinkId:
          type: string
          description: >-
            Id of the one time booking link.

            Required in order to invalidate the booking link, once booking is
            done
        skipNotifications:
          type: boolean
          description: Skip sending email notifications to the attendee for this booking
        phoneOnlyBooking:
          type: boolean
          description: >-
            When true, attendee email is not required and phone becomes the
            identifier.

            Requires the meeting type to have `allowPhoneOnlyBooking` enabled in
            its options.

            Designed for voice agent / phone scheduling use cases where
            collecting email

            from the caller is not viable.
        icsTitle:
          type: string
          description: >-
            Custom ICS calendar invite title. If provided, overrides the
            configured

            meeting type ICS title for this specific booking.

            Useful for AI-generated titles based on conversation context (e.g.,
            from calgent).
          maxLength: 200
        icsDescription:
          type: string
          description: >-
            Custom ICS calendar invite description. If provided, overrides the
            configured

            meeting type ICS description for this specific booking.

            Useful for AI-generated descriptions based on conversation context
            (e.g., from calgent).
          maxLength: 2000
        rwgToken:
          type: string
          description: |-
            Google Actions Center token for conversion tracking.
            This token is passed via the rwg_token URL parameter when users
            click through from Google Maps/Search.
          maxLength: 500
        rwgMerchantId:
          type: string
          description: |-
            Merchant ID associated with the rwg_token for Google Actions Center.
            Used to determine if merchant changed during booking flow.
        bookingPassword:
          type: string
          description: |-
            Password for accessing a password-protected booking page.
            Required when the meeting type has password protection enabled.
        waitlistToken:
          type: string
          description: >-
            Waitlist unsubscribe token. When provided (from the ?wl= URL param
            on the booking link),

            the corresponding waitlist entry is removed after successful booking
            and the attendee

            is tagged as originating from the waitlist.
      required:
        - attendee
        - meetingTypeId
        - start
    NextQueueHostsSelectionReasonDto:
      type: object
      properties:
        userIds:
          type: array
          items:
            type: string
        groupId:
          type: string
        selectionReason:
          type: object
      required:
        - userIds
        - selectionReason
    UserBasicDto:
      type: object
      properties:
        id:
          type: string
        givenName:
          type: string
        familyName:
          type: string
        picture:
          type: string
        slug:
          type: string
        userType:
          type: string
      required:
        - id
        - givenName
        - familyName
        - slug
        - userType
    CreateAttendeeDto:
      type: object
      properties:
        email:
          type: string
          description: |-
            Attendee email address. Required for all standard bookings.
            Optional only when `BookingDto.phoneOnlyBooking` is true.
            Validated as email format when provided.
          format: email
        firstname:
          type: string
          description: Either fullname or firstname/lastname is required
        lastname:
          type: string
          description: Either fullname or firstname/lastname is required
        fullname:
          type: string
          description: Either fullname or firstname/lastname is required
        receiveReminders:
          type: boolean
        bringalongEmails:
          description: Additional attendee emails (max 5)
          maxItems: 5
          type: array
          items:
            type: string
            format: email
        notes:
          type: object
          description: An object containing attendee form entries.
          additionalProperties:
            type: string
        phone:
          type: string
        language:
          allOf:
            - $ref: '#/components/schemas/Language'
        timezone:
          type: string
        dataPolicyAccepted:
          type: boolean
      required:
        - receiveReminders
        - notes
    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
      description: Meeting channel/location type
    PaymentProvider:
      type: string
      enum:
        - paypal
        - stripe
        - none
    Language:
      type: string
      enum:
        - en
        - de
        - fr
        - es
        - 'no'
        - nl
        - it
        - pl
        - sv
        - tr
        - da
  securitySchemes:
    ApiUserHeader:
      type: apiKey
      in: header
      name: x-meetergo-api-user-id
      description: >-
        User ID to act on behalf of. Platform API Keys only (required with an
        API Key unless the endpoint states otherwise). Requests authenticated
        with a Personal Access Token are rejected if this header names another
        user.
    JWT:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT Bearer token for standard user authentication
    ApiKey:
      scheme: bearer
      bearerFormat: API Key
      type: http
      description: >-
        Bearer token: a Platform API Key (format: ak_live:<uuid>:<secret>) or a
        Personal Access Token (format: rgo-...). PATs always act as the token
        owner.

````