---
title: "List Planned Events"
method: GET
path: "/api/v2/events/planned-events"
tags: ["Events"]
---

# List Planned Events

`GET /api/v2/events/planned-events`

A get call for listing planned events data

## Query parameters

- `start` integer
- `limit` integer
- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- PlannedEventsSchema
  - `plannedEventList` PlannedEvent[], nullable — List of planned events
    - `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
  - `plannedEventListBranding` EventBranding
    - `navBar` NavBar
      - `color` string, nullable — Color of navbar
      - `background` string, nullable — background of navbar
      - `link` string, nullable — Link of navbar
      - `image` string, nullable — Image on navbar
      - `title` string, nullable — title of navbar
    - `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

---

[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/revisions/0fb26f4e41bf/schema)