Skip to main content
GET
Get paginated appointments

Authorizations

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

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.

Query Parameters

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

Page number (0-indexed). Use 0 for the first page.

Required range: x >= 0
Example:

0

pageSize
number
required

Number of items per page

Required range: 1 <= x <= 100
Example:

20

channel
enum<string>

Meeting channel/location type

Available options:
local,
local-attendee,
google,
zoom,
phone,
phone-incoming,
whatsapp,
connect,
webex,
skypeForConsumer,
skypeForBusiness,
teamsForBusiness,
teamsForBusiness2,
teamsForExchange,
teams2ForExchange,
custom,
resource,
whereby,
kmeet,
zava,
jitsi
start
string
end
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