Client Level Analytics
Registrants by Email Multiple Events
Returns a listing of all registration information for a specific email address. There is a limit of 100 registrants per page.
- If double opt-in verification was enabled at the time of registration for an event and a user has not completed the verification process, the user will not be included in any endpoint responses.
- subaccounts parameter conditions:
- Value can be 1 or more child client IDs (multiple values will need to be delimited by a comma).
- Child client IDs must be under the {clientId} of the request.
- If subaccounts is provided and excludeSubaccounts is "Y", the following error message is returned: "You have to set excludesubaccounts='N' in order to filter by subaccounts.".
- If subaccounts includes multiple values and at least one value is not valid, an error message is returned.
- When subaccounts is provided, the response will only return data for the child client IDs included in the parameter
get/client/{clientId}/registrant/{email}/allevents
Request
- Base URL: https://api.on24.com/wcc/api/v2
- URL: https://api.on24.com/wcc/api/v2/client/{clientId}/registrant/{email}/allevents
- Auth: one of:
- API key in header AccessTokenKey
- API key in header AccessTokenSecret
Path parameters
clientIdstring required
The client id
emailstring required
The email to lookup
Query parameters
pageoffsetinteger
Selects the page to retrieve
excludesubaccountsstring
if set to "y", sub-accounts will be excluded
subaccountsstring
Comma separated list of child client ids
itemsperpageinteger
Number of items to be retrieved per page
Headers
accessTokenKeystring required
client access token key
accessTokenSecretstring required
client access token secret
Response
Return list of registrants
- This endpoint returns data on people who registered for a Virtual Environment (VE).
- Properties that will not be returned for VE registrants include:
- userprofileurl
- engagementprediction
- emailformat
- The following values are cached on the server between 3 - 24 hours:
- engagementprediction
Changes
No recorded changes to this operation across all 1 revision of this API.