ENenvelope
Guests

Get a guest by ID

Retrieves detailed guest information including status and custom properties.

get/v1/guests/{_id}

Request

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

Path parameters

_idstring required

Guest ID to retrieve.

Query parameters

eventstring required

Associated event ID.

Response

Guest details retrieved successfully.

_idstring required

Guest ID

eventstring required

Event ID

confirmedAtstring date-time nullable

Date and time when the guest was confirmed

attendedAtstring date-time nullable

Date and time when the guest attended the event

starredboolean

Indicates if the guest is starred

Example response

{
  "status": {
    "confirmation": 2,
    "attendance": 1,
    "declineMessage": null,
    "givenConsents": [],
    "visitedZones": [],
    "addMethod": "publicRegistration",
    "checkInMethod": "qrScan"
  },
  "properties": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "lang": "en",
    "X62TkjiV": "My custom note",
    "yN9hzaCj": "1QLXYBlw",
    "Ybb48GO7": [
      "7bR7m2au",
      "BdwYyYmi"
    ]
  },
  "_populated": {
    "properties": {
      "First name": "John",
      "Last name": "Doe",
      "Email": "john@example.com",
      "Language": "en",
      "Note": "My custom note",
      "Ticket type": "VIP",
      "Interests": [
        "Technology",
        "Business"
      ]
    },
    "status": {
      "confirmation": "Confirmed (+1)",
      "attendance": "Attended"
    }
  }
}

Changes

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