> ## Documentation Index
> Fetch the complete documentation index at: https://docs.envelope.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an event by ID

> Retrieves detailed event information including settings and configuration.



## OpenAPI

````yaml openapi.json get /v1/events/{_id}
openapi: 3.0.1
info:
  title: Envelope API
  description: >-
    Event management API for programmatically managing events, guests, and
    related resources.
  license:
    name: MIT
  contact:
    email: support@envelope.so
  version: 1.0.4
servers:
  - url: https://envelope.so/api
security:
  - api_key: []
tags:
  - name: Guests
    description: API for managing guests
  - name: Events
    description: API for managing events
paths:
  /v1/events/{_id}:
    get:
      tags:
        - Events
      summary: Get an event by ID
      description: >-
        Retrieves detailed event information including settings and
        configuration.
      parameters:
        - name: _id
          in: path
          required: true
          description: Event ID to retrieve.
          schema:
            type: string
      responses:
        '200':
          description: Event details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  schemas:
    Event:
      type: object
      properties:
        _id:
          type: string
          description: Event ID
        general:
          type: object
          properties:
            title:
              type: string
              description: Title of the event
            startDate:
              type: string
              format: date-time
              description: Start date of the event
            endDate:
              type: string
              format: date-time
              description: End date of the event
            timezone:
              type: string
              default: Europe/London
              description: Timezone of the event
            location:
              type: object
              properties:
                placeName:
                  type: string
                  description: Name of the event location
                address:
                  type: string
                  description: Address of the event location
                city:
                  type: string
                  description: City of the event location
                zipCode:
                  type: string
                  description: Zip code of the event location
                country:
                  type: string
                  description: Country of the event location
            langs:
              type: array
              items:
                type: string
              description: Languages supported by the event
              example:
                - en
                - es
        guestlist:
          type: object
          properties:
            properties:
              type: array
              description: Guestlist properties including any custom properties
              items:
                type: object
                required:
                  - id
                  - type
                properties:
                  id:
                    type: string
                    description: Unique identifier for the property
                  type:
                    type: string
                    enum:
                      - text
                      - select
                      - multiSelect
                    description: Type of the property field
                  _en:
                    type: object
                    properties:
                      name:
                        type: string
                        description: English localization of property name
                  options:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                      properties:
                        id:
                          type: string
                          description: Unique identifier for the option
                        _en:
                          type: object
                          properties:
                            value:
                              type: string
                              description: English localization of option value
          example:
            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
        createdAt:
          type: string
          format: date-time
          description: Date and time when the event was created
        updatedAt:
          type: string
          format: date-time
          description: Date and time when the event was last updated
  responses:
    UnauthorizedError:
      description: Invalid or missing API key.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: integer
                example: 401
              message:
                type: string
                example: Invalid API key.
    NotFoundError:
      description: Requested resource not found.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: integer
                example: 404
              message:
                type: string
                example: Resource not found.
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.