Get a guest by ID

curl --request GET \
  --url https://{workspace}.attendu.com/api/v1/guests/{_id} \
  --header 'x-api-key: <api-key>'

{
  "_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"
        }
      ]
    }
  }
}

GET

guests

{_id}

Get a guest by ID

curl --request GET \
  --url https://{workspace}.attendu.com/api/v1/guests/{_id} \
  --header 'x-api-key: <api-key>'

{
  "_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"
        }
      ]
    }
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

_id

string

required

Guest ID to retrieve.

Query Parameters

event

string

required

Associated event ID.

Response

Guest details retrieved successfully.

_id

string

required

Guest ID

event

string

required

Event ID

status

object

required

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

Show child attributes

status.confirmation

integer

default:0

required

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

status.attendance

integer

default:0

required

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

status.givenConsents

string[]

required

Array of consents that the guest has given

status.visitedZones

string[]

required

Array of zone IDs that the guest has visited

status.declineMessage

string | null

Message from the guest when they declined the invitation

status.addMethod

enum<string>

Method used to add the guest to the event

Available options:

batchImport,

singleAdd,

checkInAdd,

publicRegistration

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"
}

properties

object

required

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

Show child attributes

properties.firstName

string

required

First name of the guest

properties.lastName

string

required

Last name of the guest

properties.email

string

required

Email address of the guest

properties.lang

string

required

Language of the guest

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"
}

_populated

object

required

Show child attributes

_populated.properties

object

required

Localized and human-readable guest properties

Show child attributes

_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"]
}

_populated.status

object

required

Localized and human-readable guest status

Show child attributes

_populated.status.confirmation

string

required

Localized confirmation status

Example:

"Confirmed (+1)"

_populated.status.attendance

string

required

Localized attendance status

Example:

"Attended"

confirmedAt

string<date-time> | null

Date and time when the guest was confirmed

attendedAt

string<date-time> | null

Date and time when the guest attended the event

starred

boolean

default:false

Indicates if the guest is starred

extras

object

Optional additional guest data

Show child attributes

extras.roommates

string[]

Array of guest IDs who are roommates

Guest ID of a roommate

extras.payment

object

Ticket payment information

Show child attributes

extras.payment.isPaid

boolean

Indicates if the ticket has been paid

extras.payment.paidAt

string<date-time>

Date and time when the ticket was paid

extras.payment.stripePaymentIntent

string

Stripe payment intent ID

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"
      }
    ]
  }
}

List all guests Create a new guest

⌘I

Get Started

Events

Guests

Get a guest by ID

Authorizations

Path Parameters

Query Parameters

Response