List all guests

curl --request GET \
  --url https://{workspace}.attendu.com/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": "[email protected]",
        "lang": "en",
        "X62TkjiV": "My custom note",
        "yN9hzaCj": "1QLXYBlw",
        "Ybb48GO7": [
          "7bR7m2au",
          "BdwYyYmi"
        ],
        "ticketType": "QF78tnh3"
      },
      "_populated": {
        "properties": {
          "First name": "John",
          "Last name": "Doe",
          "Email": "[email protected]",
          "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,
      "extras": {
        "roommates": [
          "507f1f77bcf86cd799439011",
          "507f191e810c19729de860ea"
        ],
        "payment": {
          "isPaid": true,
          "paidAt": "2023-04-15T14:30:00Z",
          "stripePaymentIntent": "pi_3RJut1234567890",
          "stripeInvoice": "in_1RJutEIz1234567890",
          "usedPromoCodes": [
            {
              "id": "43oMGCex",
              "amount": 100,
              "code": "U2QWC8"
            }
          ]
        }
      }
    }
  ],
  "total": 123
}

GET

guests

List all guests

curl --request GET \
  --url https://{workspace}.attendu.com/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": "[email protected]",
        "lang": "en",
        "X62TkjiV": "My custom note",
        "yN9hzaCj": "1QLXYBlw",
        "Ybb48GO7": [
          "7bR7m2au",
          "BdwYyYmi"
        ],
        "ticketType": "QF78tnh3"
      },
      "_populated": {
        "properties": {
          "First name": "John",
          "Last name": "Doe",
          "Email": "[email protected]",
          "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,
      "extras": {
        "roommates": [
          "507f1f77bcf86cd799439011",
          "507f191e810c19729de860ea"
        ],
        "payment": {
          "isPaid": true,
          "paidAt": "2023-04-15T14:30:00Z",
          "stripePaymentIntent": "pi_3RJut1234567890",
          "stripeInvoice": "in_1RJutEIz1234567890",
          "usedPromoCodes": [
            {
              "id": "43oMGCex",
              "amount": 100,
              "code": "U2QWC8"
            }
          ]
        }
      }
    }
  ],
  "total": 123
}

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

string

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

Example:

"john"

string

Filter guests by exact email address match.

Example:

"[email protected]"

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[]

Show child attributes

results._id

string

required

Guest ID

results.event

string

required

Event ID

results.status

object

required

Guest status information including confirmation, attendance, consents and check-in details

Show child attributes

results.status.confirmation

integer

default:0

required

-1 = declined, 0 = default, 1 = confirmed, 2 = confirmed + 1 partner, 3 = confirmed + 2 partners

results.status.attendance

integer

default:0

required

0 = default, 1 = attended, 2 = attended + 1 partner, 3 = attended + 2 partners

results.status.givenConsents

string[]

required

Array of consents that the guest has given

results.status.visitedZones

string[]

required

Array of zone IDs that the guest has visited

results.status.declineMessage

string | null

Message from the guest when they declined the invitation

results.status.addMethod

enum<string>

Method used to add the guest to the event

Available options:

batchImport,

singleAdd,

checkInAdd,

publicRegistration

results.status.checkInMethod

enum<string> | null

Method used to check in the guest

Available options:

qrScan,

manual

Example:

{
  "confirmation": 2,
  "attendance": 1,
  "declineMessage": null,
  "givenConsents": [],
  "visitedZones": [],
  "addMethod": "publicRegistration",
  "checkInMethod": "qrScan"
}

results.properties

object

required

Guest properties including default required fields and any custom properties defined for the event

Show child attributes

results.properties.firstName

string

required

First name of the guest

results.properties.lastName

string

required

Last name of the guest

results.properties.email

string

required

Email address of the guest

results.properties.lang

string

required

Language of the guest

results.properties.ticketType

string

Ticket type of the guest

Example:

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "lang": "en",
  "X62TkjiV": "My custom note",
  "yN9hzaCj": "1QLXYBlw",
  "Ybb48GO7": ["7bR7m2au", "BdwYyYmi"],
  "ticketType": "QF78tnh3"
}

results._populated

object

required

Show child attributes

results._populated.properties

object

required

Localized and human-readable guest properties

Show child attributes

results._populated.properties.{key}

Example:

{
  "First name": "John",
  "Last name": "Doe",
  "Email": "[email protected]",
  "Language": "en",
  "Note": "My custom note",
  "Ticket type": "VIP",
  "Interests": ["Technology", "Business"]
}

results._populated.status

object

required

Localized and human-readable guest status

Show child attributes

results._populated.status.confirmation

string

required

Localized confirmation status

Example:

"Confirmed (+1)"

results._populated.status.attendance

string

required

Localized attendance status

Example:

"Attended"

results.confirmedAt

string<date-time> | null

Date and time when the guest was confirmed

results.attendedAt

string<date-time> | null

Date and time when the guest attended the event

results.starred

boolean

default:false

Indicates if the guest is starred

results.extras

object

Optional additional guest data

Show child attributes

results.extras.roommates

string[]

Array of guest IDs who are roommates

Guest ID of a roommate

results.extras.payment

object

Ticket payment information

Show child attributes

results.extras.payment.isPaid

boolean

Indicates if the ticket has been paid

results.extras.payment.paidAt

string<date-time>

Date and time when the ticket was paid

results.extras.payment.stripePaymentIntent

string

Stripe payment intent ID

results.extras.payment.stripeInvoice

string

Stripe invoice ID

Array of promo codes used for this payment.

Show child attributes

Unique identifier for the promo code (nanoid, 8 chars)

Discount amount for the promo code.

Promo code (6 chars, uppercase, A-Z0-9)

Example:

[
  {
    "id": "43oMGCex",
    "amount": 100,
    "code": "U2QWC8"
  }
]

Example:

{
  "roommates": [
    "507f1f77bcf86cd799439011",
    "507f191e810c19729de860ea"
  ],
  "payment": {
    "isPaid": true,
    "paidAt": "2023-04-15T14:30:00Z",
    "stripePaymentIntent": "pi_3RJut1234567890",
    "stripeInvoice": "in_1RJutEIz1234567890",
    "usedPromoCodes": [
      {
        "id": "43oMGCex",
        "amount": 100,
        "code": "U2QWC8"
      }
    ]
  }
}

total

integer

Total count of matching guests

Get an event by ID Get a guest by ID

⌘I

Get Started

Events

Guests

List all guests

Authorizations

Query Parameters

Response