Skip to main content
GET
/
v1
/
guests
List all guests
curl --request GET \
  --url https://envelope.so/api/v1/guests \
  --header 'x-api-key: <api-key>'
{
  "results": [
    {
      "_id": "<string>",
      "event": "<string>",
      "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"
        }
      },
      "confirmedAt": "2023-11-07T05:31:56Z",
      "attendedAt": "2023-11-07T05:31:56Z",
      "starred": false
    }
  ],
  "total": 123
}

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.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
event
string
required

Event ID to scope the guest list.

​
skip
integer

Number of records to skip for pagination.

Required range: x >= 0
Example:

0

​
limit
integer
default:20

Maximum number of records to return.

Required range: 1 <= x <= 100
Example:

20

​
search
string

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

Example:

"john"

​
email
string

Filter guests by exact email address match.

Example:

"john@example.com"

​
sortBy
string

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

Example:

"lastName:asc"

​
filterBy
string

JSON-encoded filter criteria for guest properties.

Example:

"{\"status.confirmation\":1}"

Response

List of guests with pagination metadata.

​
results
object[]
​
total
integer

Total count of matching guests