ENenvelope
Guests

List all guests

Retrieves a paginated list of guests with filtering, sorting, and search capabilities.

get/v1/guests

Request

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

Query parameters

eventstring required

Event ID to scope the guest list.

skipinteger

Number of records to skip for pagination.

limitinteger
Example:20

Maximum number of records to return.

searchstring
Example:john

Search term for filtering guests by first name, last name, or email.

emailstring
Example:john@example.com

Filter guests by exact email address match.

sortBystring
Example:lastName:asc

Sort field and direction (field:asc|desc).

filterBystring
Example:{"status.confirmation":1}

JSON-encoded filter criteria for guest properties.

Response

List of guests with pagination metadata.

totalinteger

Total count of matching guests

Example response

{
  "results": [
    {
      "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.