GET /api/v2/participants/{eventId}/list
Returns a paginated list of participants registered for a specific event.
Authentication
Authorization: Bearer <your_api_key>
Endpoint
GET /api/v2/participants/{eventId}/list
Path Parameters
|
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
|
integer |
Yes |
The ID of the event to retrieve participants for |
Query Parameters
|
Parameter |
Type |
Required |
Default |
Constraints |
Description |
|---|---|---|---|---|---|
|
|
integer |
No |
|
Must be a positive integer |
Page number for pagination (starts from 1) |
|
|
integer |
No |
|
Must be between 1 and 300 |
Number of items per page |
|
|
integer |
No |
|
Must be a positive Unix timestamp |
Returns only participants updated on or after this timestamp. Useful for incremental synchronization |
Response Format
Success Response (HTTP 200)
{
"code": 200,
"response_id": "...",
"data": {
"list": [ ... ],
"total": 150,
"page": 1,
"limit": 100,
"last_page": 2
},
"errors": null
}
Pagination Metadata
|
Field |
Type |
Description |
|---|---|---|
|
|
integer |
Total number of matching participants across all pages |
|
|
integer |
Current page number |
|
|
integer |
Number of items per page |
|
|
integer |
Number of the last available page |
Participant Object Fields
Each participant object in the list array contains the full profile. Key field groups include: personal information, location, contact and social links, event and category data, exhibitor association, roles, business matching categories, notification preferences, connection permissions, custom questions, and timestamps (registered_date, last_update).
For the complete field reference, see GET /api/v2/account/get which returns the same profile structure for a single account.
Error Responses
|
HTTP Code |
Condition |
Error Message |
|---|---|---|
|
400 |
Invalid |
Validation error describing the constraint violation |
|
403 |
Missing or invalid API key |
|
|
404 |
Event with given |
|
Example Request
GET /api/v2/participants/173/list?page=1&limit=50×tamp=1741092900
Authorization: Bearer your_api_key_here
Best Practices
Pagination
-
Use appropriate
limitvalues to balance performance and data transfer -
The maximum
limitis 300 items per page -
Always check the
last_pagevalue to determine if more pages are available
Incremental Synchronization
-
Use the
timestampparameter to retrieve only participants updated since your last sync -
Store the
last_updatevalue from the most recent participant and use it in subsequent requests -
This approach significantly reduces data transfer for regular synchronization
Data Filtering
The endpoint returns only active participants for the specified event, excluding inactive records, event administrators, and system accounts with special roles.