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.

Attributes

Description

attendees

It 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

recordsFiltered

It returns the filter added to get all attendees.

recordsTotal

It returns total records of all attendees.

ticketTypeCountDtos

It 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.

totalBookedTickets

It returns number of booked tickets.

totalCheckedInTickets

It returns number of checked in tickets.

totalFreeTickets

It returns number of free tickets.

totalPaidTickets

It 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 code

Error Description

200

Returns all attendee details.

400

The request could not be understood by the server due to malformed syntax.

401

You are not authorized to view the resource.

403

Accessing the resource you were trying to reach is forbidden.

404

The resource you were trying to reach is not found.

4030101

Not staff User.

Language
Credentials
Header
Click Try It! to start a request and see the response here!