List guests
GET/api/v1/events/{id}/attendees
Everyone holding a ticket to the event.
Permission
attendees:read (Read guests)Publishable keyNo: secret keys only
ListsPaged with limit and cursor. Pagination
Path parameters
idintegerRequired- The event's id.
Query parameters
qstring- Search by name, email or ticket code.
limitinteger- How many to return, 1 to 100. Default 25.
cursorstring- The next_cursor from the previous page.
Errors it can give
- 404not_foundNo such object in this company.
curl "https://eos.aveoevents.com/api/v1/events/41/attendees?q=taylor" \
-H "Authorization: Bearer $EOS_API_KEY"{
"object": "list",
"url": "/api/v1/events/41/attendees",
"has_more": false,
"next_cursor": null,
"data": [
{
"object": "attendee",
"id": "A-7Q2KX9",
"event_id": 41,
"order_id": "O-7KQ2M4X",
"order_number": 5501,
"ticket_type_id": 9001,
"ticket_type": "General admission",
"first_name": "Sam",
"last_name": "Taylor",
"email": "sam@example.com",
"status": "active",
"checked_in": false,
"checked_in_at": null
}
]
}Every field of the response: the attendee object.
Get a guest
GET/api/v1/events/{id}/attendees/{attendee_id}
One ticket and its holder.
Permission
attendees:read (Read guests)Publishable keyNo: secret keys only
Path parameters
idintegerRequired- The event's id.
attendee_idstringRequired- The ticket code.
Errors it can give
- 404not_foundNo such object in this company.
curl "https://eos.aveoevents.com/api/v1/events/41/attendees/A-7Q2KX9" \
-H "Authorization: Bearer $EOS_API_KEY"{
"object": "attendee",
"id": "A-7Q2KX9",
"event_id": 41,
"order_id": "O-7KQ2M4X",
"order_number": 5501,
"ticket_type_id": 9001,
"ticket_type": "General admission",
"first_name": "Sam",
"last_name": "Taylor",
"email": "sam@example.com",
"status": "active",
"checked_in": false,
"checked_in_at": null
}Every field of the response: the attendee object.
Update a guest
PATCH/api/v1/events/{id}/attendees/{attendee_id}
Changes the name or email on a ticket.
Permission
attendees:write (Update guests)Publishable keyNo: secret keys only
Idempotency-KeyAccepted. How retries stay safe
Path parameters
idintegerRequired- The event's id.
attendee_idstringRequired- The ticket code.
Body (JSON)
first_namestring- First name.
last_namestring- Last name.
emailstring- Email.
Errors it can give
- 404not_foundNo such object in this company.
curl -X PATCH "https://eos.aveoevents.com/api/v1/events/41/attendees/A-7Q2KX9" \
-H "Authorization: Bearer $EOS_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"first_name":"Jordan","last_name":"Lee","email":"jordan@example.com"}'{
"object": "attendee",
"id": "A-7Q2KX9",
"event_id": 41,
"order_id": "O-7KQ2M4X",
"order_number": 5501,
"ticket_type_id": 9001,
"ticket_type": "General admission",
"first_name": "Jordan",
"last_name": "Lee",
"email": "jordan@example.com",
"status": "active",
"checked_in": false,
"checked_in_at": null
}Every field of the response: the attendee object.
Resend a ticket
POST/api/v1/events/{id}/attendees/{attendee_id}/resend
Emails this one ticket to its holder again.
Permission
attendees:write (Update guests)Publishable keyNo: secret keys only
Path parameters
idintegerRequired- The event's id.
attendee_idstringRequired- The ticket code.
Errors it can give
- 404not_foundNo such object in this company.
curl -X POST "https://eos.aveoevents.com/api/v1/events/41/attendees/A-7Q2KX9/resend" \
-H "Authorization: Bearer $EOS_API_KEY"{
"object": "resend",
"attendee_id": "A-7Q2KX9",
"emails": 1
}