---
title: "List all events"
method: GET
path: "/v1/events"
tags: ["Events"]
---

# List all events

`GET /v1/events`

## Request

- Base URL: `https://envelope.so/api`
- URL: `https://envelope.so/api/v1/events`
- Auth: API key in header `x-api-key`

Retrieves accessible events with optional time-based filtering.

## Query parameters

- `filter` 'upcoming' | 'past'

## Response `200`

Events retrieved successfully.

- object
  - `results` Event[]
    - `_id` string: Event ID
    - `general` object
      - `title` string: Title of the event
      - `startDate` string, date-time: Start date of the event
      - `endDate` string, date-time: End date of the event
      - `timezone` string: Timezone of the event
      - `location` object
        - `placeName` string: Name of the event location
        - `address` string: Address of the event location
        - `city` string: City of the event location
        - `zipCode` string: Zip code of the event location
        - `country` string: Country of the event location
      - `langs` string[]: Languages supported by the event
    - `guestlist` object
      - `properties` object[]: Guestlist properties including any custom properties
        - `id` string, required: Unique identifier for the property
        - `type` 'text' | 'select' | 'multiSelect', required: Type of the property field
        - `_en` object
          - `name` string: English localization of property name
        - `options` object[]
          - `id` string, required: Unique identifier for the option
          - `_en` object
            - `value` string: English localization of option value
    - `createdAt` string, date-time: Date and time when the event was created
    - `updatedAt` string, date-time: Date and time when the event was last updated
  - `total` integer: Total count of matching events

## Other responses

- `401`: Invalid or missing API key.

---

[API](https://skmtc.dev/envelope/apis/envelope-api.md) - [All operations](https://skmtc.dev/envelope/apis/envelope-api/llms.txt) - [OpenAPI document](https://skmtc.dev/envelope/apis/envelope-api/revisions/13c4ed2b553b?raw)