Developer Hub
»
Attendees GET API Documentation
Get Event Attendees List: /events/{event_uuid}/attendees
Purpose
This endpoint retrieves detailed list of attendees associated with a specific event. Each attendee includes custom and system-defined attributes, such as personal information, ticket details, and uploaded files.
Scope
event.list_attendee → Attendees list permission must be granted from the application to view event attendees list.
Use Case
This endpoint is useful for retrieving a list of attendees details for monitoring event participation, managing attendee data, and accessing uploaded documents.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uuid | string | The unique identifier of the event whose attendee details are to be retrieved. |
Query Parameters
|
Parameter |
Type |
Allowed Value |
Description |
|---|---|---|---|
|
position |
number |
N/A |
Specifies the starting position for data retrieval. |
|
rows |
number |
20 to 100 |
Limits the number of rows returned in the response. |
|
order_by |
enum |
created_ascending, created_descending, starting, name_ascending, name_descending |
Defines the sorting order for the response data. Specify the desired order |
|
order_id |
uuid |
Any valid order UUID |
A unique identifier for a specific order. |
Request Body
No request body is required for this endpoint.
Response
The response contains a statusCode indicating the request's success, a result object with detailed attendee data, and pagination information. The result.attendees array includes attendee objects, each identified by a unique uuid and containing a list of attributes. Attributes are represented as objects with field_name, field_type (either custom or system), and field_value, which may include personal details, ticket information, or file links. The result.pagination object provides details on the total number of records, current position, rows per page, and optional sorting criteria (order_by).
JSON
{
"statusCode": 200,
"result": {
"attendees": [
{
"uuid": "ATTENDEE_UUID",
"attributes": [
{
"field_name": "FIELD_NAME",
"field_type": "FIELD_TYPE",
"field_value": "FIELD_VALUE"
}
]
}
],
"pagination": {
"records": "TOTAL_RECORDS",
"position": "CURRENT_POSITION",
"rows": "ROWS_PER_PAGE",
"order_by": "ORDER_BY_FIELD"
}
}
}| Attribute | Type | Description |
|---|---|---|
| statusCode | Integer | HTTP status code of the response. |
| result | Object | Contains the primary result of the response. |
| result.attendees | Array | List of attendees. |
| result.uuid | String | Unique identifier for the attendee. |
| result.attributes | Array | List of attributes associated with the attendee. |
| result.field_name | String | Name of the attribute field. |
| result.field_type | String | Data type of the attribute field |
| result.field_value | String | Value of the attribute field. |
| pagination | Object | Details about the pagination of the response. |
| pagination.records | Integer | Total number of records available. |
| pagination.position | Integer | Current position in the list of records. |
| pagination.rows | Integer | Number of rows per page. |
| pagination.order_by | String | Field by which the records are ordered. |
Get Event Attendee Details: /events/{event_uuid}/attendees/{attendee_uuid}
Purpose
This endpoint retrieves detailed information about a specific attendee of a particular event. The attendee is identified by their unique uuid, and the response includes both system-defined and custom-defined attributes associated with the attendee.
Scope
event.list_attendee → Attendees list permission must be granted from the application to view attendee information.
Use Case
This endpoint is used to retrieve detailed information about a specific attendee of an event, including system-defined attributes like ticket quantity, order creation date, and price, as well as custom-defined fields such as personal details, uploaded files, and additional data provided during registration. It is useful for event organisers to manage and audit attendance, generate reports, address customer support queries, and integrate attendee data into other systems efficiently.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uuid | string | The unique identifier of the event. |
| attendees_uuid | string | The unique identifier of the attendee. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response contains detailed information about a specific attendee, including their unique identifier (uuid) and a list of attributes. These attributes are categorised as system fields (e.g., is_new, order_created_on, price, total_ticket_quantity) and custom fields, which can include personal details like firstName, emailAddress, and phone, as well as additional data such as uploaded files or custom input fields provided during registration. The custom fields may vary depending on the event setup, offering flexibility in capturing attendee-specific data.
JSON
{
"statusCode": 200,
"result": {
"attendees": {
"uuid": "UUID",
"attributes": [
{
"field_name": "is_new",
"field_type": "system",
"field_value": "FIELD_VALUE"
},
{
"field_name": "order_created_on",
"field_type": "system",
"field_value": "FIELD_VALUE"
},
{
"field_name": "price",
"field_type": "system",
"field_value": "FIELD_VALUE"
},
{
"field_name": "total_ticket_quantity",
"field_type": "system",
"field_value": "FIELD_VALUE"
},
{
"field_name": "title",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "firstName",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "middleName",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "lastName",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "emailAddress",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "dateOfBirth",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "addressLine1",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "addressLine2",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "country",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "state",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "city",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "postCode",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "identificationNo",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "nationality",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "phone",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "address",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "First Name",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "Phone Number",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "File Upload",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "First Name",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "Phone Number",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "File Upload",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "First Name",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "Phone Number",
"field_type": "custom",
"field_value": "FIELD_VALUE"
},
{
"field_name": "File Upload",
"field_type": "custom",
"field_value": "FIELD_VALUE"
}
]
}
}
}| Attribute | Type | Description |
|---|---|---|
| statusCode | Integer | HTTP status code of the response. |
| result | Object | Contains the primary result of the response. |
| result.attendees | Object | Details about the attendee. |
| result.attendees.uuid | String | Unique identifier for the attendee. |
| result.attendees.attributes | Array of Objects | List of attributes related to the attendee. |
| result.attendees.attributes[].field_name | String | Name of the field. |
| result.attendees.attributes[].field_type | String | Type of the field. |
| result.attendees.attributes[].field_value | String | Value of the field. |
Paginated Responses
A paginated response includes two primary sections: a pagination header and a list of objects. Below is an example of a paginated response:
JSON
"pagination": {
"records": "RECORDS_COUNT",
"position": "POSITION",
"rows": "ROWS_COUNT",
"order_by": "ORDER_BY"
}| Attribute | Type | Description |
|---|---|---|
| records | string | The total number of records available across all pages. |
| position |
string |
The current position in the list of records being viewed. |
| rows |
string |
The number of rows (or items) displayed per page. |
| order_by |
string |
The column and order used to sort the records |