Get external calendar events
Get external calendar events for an employee by its ID with filtering
Headers
-
Unique identifier to allow referencing a particular transaction or event chain
Minimum length is
1
.
Query parameters
-
Status to be considered for filtering
At least
1
element. Values areBUSY
,FREE
, orTENTATIVE
. -
ID(s) to be considered for filtering
At least
1
element. Minimum length of each is1
. -
Start date and time of the event to be considered for filtering (ISO 8601)
Minimum length is
1
. -
End date and time of the event to be considered for filtering (ISO 8601)
Minimum length is
1
. -
Offset for the results to be returned
Default value is
0
. -
Limitation for the number of results to be returned, number between 1 and 1000.
Format should match the following pattern:
^([1-9]|[1-9][0-9]{1,2}|1000)$
. Default value is25
.
curl \
--request GET 'https://api.development.pexipengage.com/enterprises/acme/employees/1234/external-calendar-events?from=2025-05-04T09%3A42%3A00Z&to=2025-05-04T09%3A42%3A00Z' \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
--header "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
{
"data": [
{
"id": "123",
"externalId": "ABCD1234",
"externalCalendar": {
"id": "123"
},
"start": "2022-08-17T09:00:00.000Z",
"end": "2022-08-17T10:00:00.000Z",
"allDay": true,
"showAs": "BUSY",
"title": "Team meeting",
"description": "Discuss topics on the agenda",
"resourceType": "APPOINTMENT",
"resourceId": "123",
"private": true,
"createdAt": "2022-08-17T19:05:21.362Z",
"updatedAt": "2022-08-17T19:05:21.362Z"
}
],
"meta": {
"offset": 0,
"limit": 25,
"totalCount": 42
}
}
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string"
}
]
}