Skip to main content
Skip table of contents

Account Get - Entire Participant List

Bulk Retrieval of Participants

To perform bulk data retrieval of participants, it is necessary to use the following endpoint:

GET /api/v2/participants/{{event_id}}/list

This endpoint allows fetching participant data with support for pagination and filtering based on the last update timestamp.

Available Query Parameters:

  • limit (integer)
    Specifies the number of items to be returned per page. The default value is 100, which is also the maximum recommended for optimal performance.
    Example: limit=100

  • page (integer)
    Indicates the page number to retrieve. Pagination starts at page=1. This parameter should be incremented with each request to retrieve the next set of records.
    Example: page=5

  • timestamp (integer)
    Optional parameter used to filter participants based on the last update date. The value must be provided as a Unix timestamp. Only participants updated after the specified timestamp will be returned. This is particularly useful for incremental data synchronization.
    Example: timestamp=1741092900

Example Request:

/api/v2/participants/{{event_id}}/list?limit=100&page=2&timestamp=1741092900

This request will retrieve the second page of participants (100 per page) that were updated after the specified timestamp.

Note: To retrieve comprehensive participant information, it is recommended to use "timestamp" = 0. This will provide the complete list of participants. The response will include the latest timestamp, which can be utilized in subsequent requests to obtain only newly added participants.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.