Get Calendar Events

GEThttps://services.leadconnectorhq.com/calendars/events/appointments/{eventId}
Get Calendar Events
Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Query Parameters
calendarId
string

Either of calendarId, userId or groupId is required

Example:
BqTwX8QFwXzpegMve9EQ
groupId
string

Either of groupId, calendarId or userId is required

Example:
ocQHyuzHvysMo5N5VsXc
userId
string

User Id - Owner of an appointment. Either of userId, groupId or calendarId is required

Example:
CVokAlI8fgw4WYWoCtQz
endTime
string
required

End Time (in millis)

Example:
1680978599999
locationId
string
required

Location Id

Example:
0007BWpSzSwfiuSl0tR2
startTime
string
required

Start Time (in millis)

Example:
1680373800000
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-04-15

Responses

Successful response

Body

events
array[object]
id
string
required

Event Id or Instance id for a recurring event

Examples:
ocQHyuzHvysMo5N5VsXcocQHyuzHvysMo5N5VsXc_1729821600000_1800
address
string

Calendar Event address

Example:
https://meet.google.com/yqp-gogr-wve
title
string
required

Calendar Event title

Example:
Appointment with GHL Dev team
calendarId
string
required

Calendar ID

Example:
BqTwX8QFwXzpegMve9EQ
locationId
string
required

Location ID

Example:
0007BWpSzSwfiuSl0tR2
contactId
string
required

Contact ID

Example:
9NkT25Vor1v4aQatFsv2
groupId
string
required

Group ID

Example:
9NkT25Vor1v4aQatFsv2
appointmentStatus
string
required

Appointment Status

Example:
confirmed
assignedUserId
string
required

AssignedUser - the primary owner of an appointment

Example:
YlWd2wuCAZQzh2cH1fVZ
users
array[string]
required

Users - the secondary owners of an appointment.

Example:
["YlWd2wuCAZQzh2cH1fVZ","9NkT25Vor1v4aQatFsv2"]
notes
string

Notes

Example:
Some dummy note
isRecurring
boolean

true if the event is recurring otherwise false

Example:
true
rrule
string

RRULE as per the iCalendar (RFC 5545) specification for recurring events. DTSTART is not required, instance ids are calculated on the basis of startTime of the event.

Examples:
RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5RRULE:FREQ=DAILY;INTERVAL=1;UNTIL=20210623T043000Z EXDATE:20211105T040000Z,20211105T040000Z
startTime
object
required

Start Time

Example:
2023-09-25T16:00:00+05:30
endTime
object
required

End Time

Example:
2023-09-25T16:00:00+05:30
dateAdded
object
required

Date Added

Example:
2023-09-25T16:00:00+05:30
dateUpdated
object
required

Date Updated

Example:
2023-09-25T16:00:00+05:30
assignedResources
array[string]

Ids of associated resources rooms and/or equipments

createdBy
object

Appointment booked by metadata

masterEventId
string

Master event id for a recurring instance

Example:
ocWd2wuBGAQzh2cH1fSZ

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request