Get external calendar events

GET /employees/{id}/external-calendar-events
OAuth2

Get external calendar events for an employee by its ID with filtering

Headers

  • Authorization string

    Bearer token used for authorization

    Minimum length is 1.

  • X-Correlation-Id string

    Unique identifier to allow referencing a particular transaction or event chain

    Minimum length is 1.

Path parameters

  • id string Required

    Primary identifier of the requested resource

    Minimum length is 1.

Query parameters

  • external-calendar-id string | null
  • show-as array[string]

    Status to be considered for filtering

    At least 1 element. Values are BUSY, FREE, or TENTATIVE.

  • id array[string]

    ID(s) to be considered for filtering

    At least 1 element. Minimum length of each is 1.

  • from string(date-time) Required

    Start date and time of the event to be considered for filtering (ISO 8601)

    Minimum length is 1.

  • to string(date-time) Required

    End date and time of the event to be considered for filtering (ISO 8601)

    Minimum length is 1.

  • offset string(positive-integer)

    Offset for the results to be returned

    Default value is 0.

  • limit string(positive-integer)

    Limitation for the number of results to be returned

    Default value is 25.

Responses

GET /employees/{id}/external-calendar-events 
curl \
 -X GET https://api.pexipengage.com/enterprises/acme/employees/1234/external-calendar-events?from=2024-05-04T09%3A42%3A00%2B00%3A00&to=2024-05-04T09%3A42%3A00%2B00%3A00 \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
Response examples (200) 
{
  "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
  }
}
Response examples (404) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}