Skip to main content
GET
/
v4
/
appointment
/
paginated
Get paginated appointments
curl --request GET \
  --url https://api.example.com/v4/appointment/paginated \
  --header 'x-meetergo-api-user-id: <api-key>'
{
  "appointments": [
    {
      "id": "<string>",
      "secret": "<string>",
      "ics": "<string>",
      "meetingInfo": {
        "name": "<string>",
        "description": "<string>",
        "enableRedirect": true,
        "redirect": "<string>",
        "duration": 123,
        "channel": "local",
        "customChannelName": "<string>",
        "customChannelLink": "<string>",
        "groupBooking": true,
        "enrichInvitee": true,
        "confirmationButton": {
          "useConfirmationButton": true,
          "text": "<string>",
          "color": "<string>",
          "link": "<string>"
        },
        "bufferBefore": 123,
        "bufferAfter": 123,
        "color": {}
      },
      "hostingInfo": {
        "mainHost": "<string>",
        "meetingLink": "<string>",
        "googleEventId": "<string>",
        "googleConnectionSub": "<string>",
        "calendarConnectionId": "<string>",
        "zoomMeetingId": 123,
        "connectChannelId": "<string>",
        "wherebyMeetingId": "<string>",
        "calendarSyncProviders": {
          "id": "<string>",
          "type": "<string>",
          "hostId": "<string>",
          "eventId": "<string>",
          "calendarId": "<string>"
        }
      },
      "cancel": {
        "actionSource": "attendee",
        "actionAt": "<string>",
        "actionBy": "<string>",
        "reason": "<string>"
      },
      "crmOptions": {
        "hubspotContactSync": true,
        "hubspotContactStage": "<string>",
        "hubspotCompanySync": true,
        "hubspotCompanyStage": "<string>",
        "hubspotCompanyMatchingField": "<string>",
        "hubspotDealSync": true,
        "hubspotDealStage": "<string>",
        "hubspotPipelineId": "<string>",
        "pipedriveDealSync": true,
        "pipedriveContactSync": true,
        "pipedrivePipelineId": 123,
        "pipedriveStageId": 123,
        "linkandoSyncEnabled": true,
        "linkandoPlaybookId": 123,
        "linkandoTemplateId": 123,
        "evalancheEnabled": true,
        "klicktippEnabled": true,
        "getResponseEnabled": true,
        "getResponseCampaignId": "<string>",
        "smartWeContactSync": true,
        "smartWeCompanySync": true,
        "smartWeDealSync": true,
        "smartWeDealStage": "<string>",
        "salesforceSyncEnabled": true,
        "salesforceCaseSync": true,
        "salesforceLeadSync": true,
        "salesforceOpportunitySync": true,
        "salesforceLeadStatus": "<string>",
        "salesforceCaseStatus": "<string>",
        "salesforceOpportunityStage": "<string>",
        "salesforceDefaultObjectType": "<string>"
      },
      "start": "<string>",
      "end": "<string>",
      "isCancelled": true,
      "attendees": [
        {
          "id": "<string>",
          "secret": "<string>",
          "email": "<string>",
          "bringalongEmails": [
            "<string>"
          ],
          "notes": {},
          "receiveReminders": true,
          "language": "<string>",
          "timezone": "<string>",
          "noShow": true,
          "dataPolicyAccepted": true,
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "fullname": "<string>",
          "firstname": "<string>",
          "lastname": "<string>",
          "phone": "<string>",
          "doubleOptIn": "<string>",
          "deletedAt": "<string>"
        }
      ],
      "attendeeIds": [
        "<string>"
      ],
      "roundRobinEntries": [
        {
          "id": 123,
          "createdAt": "<string>",
          "userId": "<string>",
          "groupId": "<string>",
          "appointmentId": "<string>",
          "queueId": "<string>",
          "selectionReason": "<string>"
        }
      ],
      "meetingTypeId": "<string>",
      "hostIds": [
        "<string>"
      ],
      "scheduledReminderIds": [
        "<string>"
      ],
      "companyId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "resolvableErrors": [
        {
          "errorCode": "<string>"
        }
      ],
      "rescheduledAt": "<string>",
      "location": "<string>",
      "deletedAt": "<string>",
      "paymentId": "<string>",
      "note": "<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

​
sortBy
enum<string>
Available options:
appointment.start,
appointment.createdAt
​
sortDirection
enum<string>
Available options:
ASC,
DESC
​
page
number
required
​
pageSize
number
required
​
channel
enum<string>

Meeting channel/location type

Available options:
local,
local-attendee,
google,
zoom,
phone,
phone-incoming,
whatsapp,
connect,
webex,
whereby,
kmeet,
jitsi,
zava,
teamsForBusiness2,
custom,
resource
​
start
string
​
end
string
​
search
string
​
workspaceId
string
​
status
string
​
all
boolean

Fetch all bookings in company, admin only

​
userId
string

Fetch bookings by userId, admin only

​
meetingTypeId
string

Response

200 - application/json

Paginated appointments retrieved successfully

​
appointments
object[]
required

Array of appointments for the current page

​
total
number
required

Total number of appointments matching the criteria