Attendee Endpoint
GET https://secure.erbium.com/api/event/{event ID}/attendees
The Attendees endpoint allows you to retrieve all information about the registrants for your event. {event ID} is a placeholder for the event ID, which is e- followed by a sequence of letters and digits. You can find the event ID in the browser URL when accessing your event through the Erbium user interface.
Query Parameters
Calling the attendees endpoint with no query parameters results in a list of all attendees with the status "Registered". You can use one or more query parameters to specify a different query.
| Query Parameter | Description |
| attendee-id | ID of a particular attendee to retrieve |
| confirmation | Confirmation Number of a particular attendee to retrieve |
| inv-status |
Invitation status to query. Must be one or more of the following values, separated by commas: unsent, sent, declined, accepted, outstanding, cancelled |
| reg-status |
Registration status to query. Must be one or more of the following values, separated by commas: registered , cancelled , not-started , in-progress, pending-approval , rejected |
| registered-after |
Return registrants who registered after the given timestamp. |
| updated-after |
Return registrants whose records were updated. |
The value of the registered-after and updated-after parameters is an ISO 8601 timestamp in the UTC time zone, for example 2023-07-24T22:18:00Z.
Query parameters combine with AND semantics, while multiple values for inv-status or reg-status are interpreted using OR semantics. For example, specifying
?reg-status=registered,cancelled®istered- after=2023-07-24T22:18:00Z
returns attendees whose status is Registered OR Cancelled, AND who registered after the given timestamp.
Response
The response of the attendees endpoint is a JSON object with a single key, data . The value of that key is an array of objects, each corresponding to an attendee to your event. The attendees endpoint does not currently support pagination.
Each attendee object is a map with the following keys:
| Key | Description |
| ID | Unique identifier of the attendee. |
| Email address of the attendee. | |
| name | Name of the attendee, an object with the keys first-name and last-name |
| details | Assorted details about the attendee. See below. |
| selections | Information entered and selected by the attendee on the registration form. See below. |
Details
The details block is an object with the following attributes:
| Key | Description |
| folio-id | ID of the primary attendee in this attendee’s folio. |
| reg-status | One of: registered , cancelled , incomplete , pending |
| decline-reason | If the attendee has declined, the reason they specified for declining. |
| is-test | true if this is a test attendee, false otherwise. |
| confirmation | Confirmation number of the attendee, or null if the attendee is pre-registration. |
| folio-balance | For paid events, the statement balance of this attendee’s folio in cents. |
| reg-ts | For registered or cancelled attendees, the timestamp when they registered. |
| reg-source | registrant if the attendee registered themselves, or admin if the attendee was registered by an event planner. |
| inv-status | One of: unsent , sent , declined , accepted , outstanding , cancelled |
| updated-ts | Timestamp when this attendee’s record last changed. |
| is-primary | true if this is a primary attendee for the folio, false otherwise. |
Selections
The selections block is an object whose keys are IDs of widgets on the registration for and whose values are objects representing the inputs and selections made by the registrant. The contents of each value object depends on the type of widget.
Comments
0 comments
Please sign in to leave a comment.