Guests
Get a guest by ID
Retrieves detailed guest information including status and custom properties.
GET
/
v1
/
guests
/
{_id}
Copy
curl --request GET \
--url https://{workspace}.attendu.com/api/v1/guests/{_id} \
--header 'x-api-key: <api-key>'
Copy
{
"_id": "<string>",
"event": "<string>",
"confirmedAt": "2023-11-07T05:31:56Z",
"attendedAt": "2023-11-07T05:31:56Z",
"starred": false,
"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"
],
"ticketType": "QF78tnh3"
},
"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"
}
]
}
},
"_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"
}
}
}
Authorizations
Path Parameters
Guest ID to retrieve.
Query Parameters
Associated event ID.
Response
200
application/json
Guest details retrieved successfully.
The response is of type object
.
Copy
curl --request GET \
--url https://{workspace}.attendu.com/api/v1/guests/{_id} \
--header 'x-api-key: <api-key>'
Copy
{
"_id": "<string>",
"event": "<string>",
"confirmedAt": "2023-11-07T05:31:56Z",
"attendedAt": "2023-11-07T05:31:56Z",
"starred": false,
"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"
],
"ticketType": "QF78tnh3"
},
"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"
}
]
}
},
"_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"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.