Events

List all events

Retrieves accessible events with optional time-based filtering.

get/v1/events

Request

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

Query parameters

filter'upcoming' | 'past'

Filter events by time frame (upcoming/past).

Response

Events retrieved successfully.

totalinteger

Total count of matching events

Example response

{
  "results": [
    {
      "general": {
        "langs": [
          "en",
          "es"
        ]
      },
      "guestlist": {
        "properties": [
          {
            "id": "yN9hzaCj",
            "type": "select",
            "_en": {
              "name": "Ticket type"
            },
            "options": [
              {
                "id": "1QLXYBlw",
                "_en": {
                  "value": "VIP"
                }
              },
              {
                "id": "PCx9ruxP",
                "_en": {
                  "value": "Standard"
                }
              }
            ]
          },
          {
            "id": "X62TkjiV",
            "type": "text",
            "_en": {
              "name": "Note"
            },
            "options": []
          },
          {
            "id": "Ybb48GO7",
            "type": "multiSelect",
            "_en": {
              "name": "Interests"
            },
            "options": [
              {
                "id": "7bR7m2au",
                "_en": {
                  "value": "Technology"
                }
              },
              {
                "id": "BdwYyYmi",
                "_en": {
                  "value": "Business"
                }
              },
              {
                "id": "4igVHOnN",
                "_en": {
                  "value": "Marketing"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.