Skip to main content
GET
/
v4
/
provisional-booking
/
paginated
Get paginated provisional bookings
curl --request GET \
  --url https://api.example.com/v4/provisional-booking/paginated \
  --header 'x-meetergo-api-user-id: <api-key>'
{
  "provisionalBookings": [
    {
      "id": "<string>",
      "dto": {
        "attendee": {
          "email": "[email protected]",
          "receiveReminders": true,
          "notes": {},
          "firstname": "<string>",
          "lastname": "<string>",
          "fullname": "<string>",
          "bringalongEmails": [
            "[email protected]"
          ],
          "phone": "<string>",
          "language": "en",
          "timezone": "<string>",
          "dataPolicyAccepted": true
        },
        "meetingTypeId": "<string>",
        "start": "<string>",
        "hostIds": [
          "<string>"
        ],
        "appointmentId": "<string>",
        "location": "<string>",
        "queueId": "<string>",
        "channel": "local",
        "duration": 123,
        "routingFormId": "<string>",
        "ignoreAvailability": true,
        "attendeePendingId": 123,
        "paymentId": "<string>",
        "resourceChannelIds": [
          "<string>"
        ],
        "oneTimeLinkId": "<string>",
        "skipNotifications": true,
        "icsTitle": "<string>",
        "icsDescription": "<string>"
      },
      "type": "doubleOptIn",
      "createdAt": "<string>",
      "deletedAt": "<string>",
      "queueBookingInfo": {
        "userIds": [
          "<string>"
        ],
        "selectionReason": {},
        "groupId": "<string>"
      },
      "hosts": [
        {
          "id": "<string>",
          "givenName": "<string>",
          "familyName": "<string>",
          "slug": "<string>",
          "userType": "<string>",
          "picture": "<string>"
        }
      ],
      "meetingTypeId": "<string>"
    }
  ],
  "total": 123
}

Authorizations

x-meetergo-api-user-id
string
header
required

User ID to act as when using API Key authentication (required with API Key)

Query Parameters

page
number
required

Page number for pagination

pageSize
number
required

Number of items per page

all
boolean

Fetch all bookings in company, admin only

userId
string

Fetch bookings by userId, admin only

meetingTypeId
string

Fetch bookings by meetingTypeId, admin only

Response

200 - application/json

Successfully retrieved paginated provisional bookings

provisionalBookings
object[]
required
total
number
required