API Reference

Get All Attendees

This API will help to get all attendees of event. We need to pass authentication and event URL to get particular event's attendees. We are also using pagination and searching functionality for get records.

Here is the description of response attributes, which returns to the form of JSON.

AttributesDescription
attendeesIt returns the list of attendees of particular event. It contains attendee details like :
attendeeId : It is the attendee Id
barcode : It contains the barcode of the ticket
email : It contains the email id of attendee
firstName : It contains the first name of attendee
lastName : It contains the last name of attendee
status : It contains the status of attendee
ticketStatus : It contains the status of ticket
ticketType : It contains the type of ticket
recordsFilteredIt returns the filter added to get all attendees.
recordsTotalIt returns total records of all attendees.
ticketTypeCountDtosIt returns array of number of total ticket per ticket type.
It contains :
ticketTypeId : It contains ticket type Id
ticketTypeName : It contains the ticket type name
totalTickets : It contains number of total tickets.
totalBookedTicketsIt returns number of booked tickets.
totalCheckedInTicketsIt returns number of checked in tickets.
totalFreeTicketsIt returns number of free tickets.
totalPaidTicketsIt returns number of paid tickets

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error codeError Description
200Returns all attendee details.
400The request could not be understood by the server due to malformed syntax.
401You are not authorized to view the resource.
403Accessing the resource you were trying to reach is forbidden.
404The resource you were trying to reach is not found.
4030101Not staff User.
Language
Authorization
Header
Click Try It! to start a request and see the response here!