Appointment V4
Get paginated appointments
Retrieves appointments with pagination support for the authenticated user
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>'import requests
url = "https://api.example.com/v4/appointment/paginated"
headers = {"x-meetergo-api-user-id": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-meetergo-api-user-id': '<api-key>'}};
fetch('https://api.example.com/v4/appointment/paginated', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v4/appointment/paginated",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-meetergo-api-user-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v4/appointment/paginated"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-meetergo-api-user-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v4/appointment/paginated")
.header("x-meetergo-api-user-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v4/appointment/paginated")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-meetergo-api-user-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"appointments": [
{
"id": "<string>",
"secret": "<string>",
"ics": "<string>",
"meetingInfo": {
"name": "<string>",
"description": "<string>",
"enableRedirect": true,
"redirect": "<string>",
"passEventDetailsToRedirect": true,
"duration": 123,
"customChannelName": "<string>",
"customChannelLink": "<string>",
"groupBooking": true,
"showAvailableSlots": 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": {
"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,
"pipedriveUseExistingDeal": true,
"centralStationContactSync": true,
"centralStationDealSync": true,
"centralStationPipelineId": 123,
"centralStationStageId": 123,
"linkandoSyncEnabled": true,
"linkandoPlaybookId": 123,
"linkandoTemplateId": 123,
"evalancheEnabled": true,
"klicktippEnabled": true,
"getResponseEnabled": true,
"getResponseCampaignId": "<string>",
"brevoEnabled": true,
"sevdeskEnabled": true,
"sevdeskCategoryId": 123,
"smartWeContactSync": true,
"smartWeCompanySync": true,
"smartWeDealSync": true,
"smartWeDealStage": "<string>",
"salesforceSyncEnabled": true,
"salesforceCaseSync": true,
"salesforceLeadSync": true,
"salesforceOpportunitySync": true,
"salesforceLeadStatus": "<string>",
"salesforceCaseStatus": "<string>",
"salesforceOpportunityStage": "<string>",
"salesforceDefaultObjectType": "<string>",
"internalCrmPipelineId": {},
"internalCrmStageId": {},
"crmOptInFieldName": {}
},
"start": "<string>",
"end": "<string>",
"isCancelled": true,
"attendees": [
{
"id": "<string>",
"secret": "<string>",
"bringalongEmails": [
"<string>"
],
"notes": {},
"receiveReminders": true,
"language": "<string>",
"timezone": "<string>",
"noShow": true,
"dataPolicyAccepted": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"email": "<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>",
"transcription": "<string>",
"summary": "<string>"
}
],
"total": 123
}Authorizations
ApiUserHeaderJWTApiKey
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
Available options:
appointment.start, appointment.createdAt Available options:
ASC, DESC Page number (0-indexed). Use 0 for the first page.
Required range:
x >= 0Example:
0
Number of items per page
Required range:
1 <= x <= 100Example:
20
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 Fetch all bookings in company, admin only
Fetch bookings by userId, admin only
⌘I
Get paginated appointments
curl --request GET \
--url https://api.example.com/v4/appointment/paginated \
--header 'x-meetergo-api-user-id: <api-key>'import requests
url = "https://api.example.com/v4/appointment/paginated"
headers = {"x-meetergo-api-user-id": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-meetergo-api-user-id': '<api-key>'}};
fetch('https://api.example.com/v4/appointment/paginated', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v4/appointment/paginated",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-meetergo-api-user-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v4/appointment/paginated"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-meetergo-api-user-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v4/appointment/paginated")
.header("x-meetergo-api-user-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v4/appointment/paginated")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-meetergo-api-user-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"appointments": [
{
"id": "<string>",
"secret": "<string>",
"ics": "<string>",
"meetingInfo": {
"name": "<string>",
"description": "<string>",
"enableRedirect": true,
"redirect": "<string>",
"passEventDetailsToRedirect": true,
"duration": 123,
"customChannelName": "<string>",
"customChannelLink": "<string>",
"groupBooking": true,
"showAvailableSlots": 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": {
"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,
"pipedriveUseExistingDeal": true,
"centralStationContactSync": true,
"centralStationDealSync": true,
"centralStationPipelineId": 123,
"centralStationStageId": 123,
"linkandoSyncEnabled": true,
"linkandoPlaybookId": 123,
"linkandoTemplateId": 123,
"evalancheEnabled": true,
"klicktippEnabled": true,
"getResponseEnabled": true,
"getResponseCampaignId": "<string>",
"brevoEnabled": true,
"sevdeskEnabled": true,
"sevdeskCategoryId": 123,
"smartWeContactSync": true,
"smartWeCompanySync": true,
"smartWeDealSync": true,
"smartWeDealStage": "<string>",
"salesforceSyncEnabled": true,
"salesforceCaseSync": true,
"salesforceLeadSync": true,
"salesforceOpportunitySync": true,
"salesforceLeadStatus": "<string>",
"salesforceCaseStatus": "<string>",
"salesforceOpportunityStage": "<string>",
"salesforceDefaultObjectType": "<string>",
"internalCrmPipelineId": {},
"internalCrmStageId": {},
"crmOptInFieldName": {}
},
"start": "<string>",
"end": "<string>",
"isCancelled": true,
"attendees": [
{
"id": "<string>",
"secret": "<string>",
"bringalongEmails": [
"<string>"
],
"notes": {},
"receiveReminders": true,
"language": "<string>",
"timezone": "<string>",
"noShow": true,
"dataPolicyAccepted": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"email": "<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>",
"transcription": "<string>",
"summary": "<string>"
}
],
"total": 123
}