---
title: "List User Calendar Events"
method: GET
path: "/api/v2/core/user-calendar-events"
tags: ["User Calendar Event"]
---

# List User Calendar Events

`GET /api/v2/core/user-calendar-events`

Search User Calendar Events using specific filter parameters and get all attributes of the entity objects

## Query parameters

- `start` integer
- `limit` integer
- `queryLimit` string
- `creatorUserId` string
- `positionId` string
- `profileId` string
- `candidateEmail` string
- `meetingTime` string
- `assigneeUserId` string
- `status` string
- `eventType` string
- `entityIds` string
- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `data` UserCalendarEventsSchema[]
    - `createdAt` integer, nullable — Timestamp when this user calendar event was created
    - `plannedEventId` integer, nullable — Planned Event id associated with the user calendar event
    - `assigneeUserId` string, nullable — User id of the assignee for the calendar event
    - `profileId` string, nullable — Profile id of the candidate associated the user calendar event
    - `eventType` string, nullable — Type of the calendar event (e.g. INTERVIEW)
    - `meetingTime` integer, nullable — Meeting timestamp for the user calendar event
    - `creatorUserId` string, nullable — User id of the user who created the calendar event
    - `interviewSlotsJson` object, nullable — Interview Slots
    - `templateId` integer, nullable — Template id associated with the user calendar event
    - `id` integer, nullable — Id associated with the user calendar event
    - `candidateEmail` string, nullable — Candidate email for the user calendar event
    - `durationMinutes` integer, nullable — Time duration in minutes of the user calendar event
    - `updatedAt` integer, nullable — Timestamp when this user calendar event was last updated
    - `plannedEvent` PlannedEvent
      - `createdAt` integer, nullable — Timestamp when this event was created
      - `isCancelled` boolean, nullable
      - `eventSpeakers` string[], nullable — List of speakers
      - `activeRegistrations` string, nullable — active registrations
      - `registerButton` RegisterButton
        - `textColor` string, nullable — text color for registration button
        - `backgroundColor` string, nullable — background color of registration button
        - `text` string, nullable — Text of registration button
      - `eventTeamDataJson` object, nullable — Event team data
      - `eventBucket` string, nullable — Bucket of the event
      - `address` string, nullable — Address of venue
      - `eventCustomFieldsJson` object, nullable — Event custom fields
      - `eventType` string, nullable
      - `institution` string, nullable — Institution related to event
      - `selectedTimezone` string, nullable — Selected time zome
      - `name` string, nullable — Name of the event
      - `homePageBanner` HomePageBanner
        - `useImage` boolean, nullable — boolean value for using image
        - `image` string, nullable — image of home page banner
        - `title` string, nullable — title for home page
      - `eventLocationType` string, nullable
      - `id` string, nullable — id
      - `parentId` string, nullable — Parent id of the event
      - `venue` string, nullable — Venue of the event
      - `endTimestamp` integer, nullable — Ending timestamp of event
      - `isPublished` boolean, nullable
      - `eventLandingPage` string, nullable — Event landing page
      - `status` string, nullable
      - `createdBy` string, nullable — User id which created this event
      - `eventCategory` string, nullable — Category of the event
      - `startTimestamp` integer, nullable — Starting time stamp of event
      - `when` string, nullable — When tag of the event
      - `description` string, nullable — Description of event
    - `status` string, nullable — Status of the user calendar event
    - `timezone` string, nullable — Timezone for the user calendar event
    - `positionId` integer, nullable — Position id associated with the user calendar event
  - `meta` MetaSchema
    - `totalCount` integer, nullable
    - `pageTotalCount` integer, nullable
    - `pageStartIndex` integer, nullable

---

[API](https://skmtc.net/eightfold/apis/api-server-v2-service-service.md) · [All operations](https://skmtc.net/eightfold/apis/api-server-v2-service-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eightfold/api-server-v2-service-service/versions/0fb26f4e41bf/schema)