ENenvelope
Events

Get an event by ID

Retrieves detailed event information including settings and configuration.

get/v1/events/{_id}

Request

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

Path parameters

_idstring required

Event ID to retrieve.

Response

Event details retrieved successfully.

_idstring

Event ID

createdAtstring date-time

Date and time when the event was created

updatedAtstring date-time

Date and time when the event was last updated

Example response

{
  "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.