Get a list of registrants and attendees (WebinarJam API)

Method: POST
Complete URL: https://api.webinarjam.com/webinarjam/registrants

The request must include all of the required fields, based on the table below:

Name	Value
api_key*	string(64)
webinar_id*{+}	integer
schedule_id{+}	int
attended_live	int, between 0 and 4 0 - All registrants 1- Attended live session 2 - Did not attend live session 3 - Attended and left before a specific timestamp, with ‘attended_live_timestamp’ 4 - Attended and left after a specific timestamp, with ‘attended_live_timestamp
attended_replay	int, between 0 and 4 0 - All registrants 1- Attended replay session 2 - Did not attend replay session 3 - Attended and left before a specific timestamp, with ‘attended_replay_timestamp’ 4 - Attended and left after a specific timestamp, with ‘attended_replay_timestamp
purchased	int, between 0 and 2 0 - All registrants 1 - Purchased a product 2 - Did not purchase a product
page	int, min: 1
attended_live_timestamp	int, value in seconds, min: 0
attended_replay_timestamp	int, value in seconds, min: 0
date_range	int, min: 0, max: 8 0 - All Time 1 - Today 2 - yesterday 3 - this week 4 - last week 5 - last 7 days 6 - this month 7 - last month 8 - last 30 days
search	string

* Required fields

{+} webinar_id and schedule must be obtained from a previous API call to retrieve the details of whatever specific webinar you want the list of registrants and attendees from. Also, please note that one particular schedule ID might refer to an entire series of webinars, and thus all individual webinar sessions within the same series will have the same schedule ID. In order to pinpoint the specific individual session within a series, refer to the ‘date_range’ parameter.

Important: The schedule ID must be obtained before the scheduled date and time of the webinar. Once the webinar has concluded, retrieving the schedule ID will no longer be possible.

The response body will be a JSON object containing a user object with the following:

Name	Value	Description
first_name	string	Registrant’s first name
last_name*	string	Registrant’s last name
phone_country_code*	string	Registrant’s phone country code
phone*	string	Registrant’s phone number
email	string	Registrant’s email address
ip	string	Registrant’s IP address
webinar	integer	Name of the webinar
schedule	integer	Schedule ID associated with the registrant’s chosen date and time
signup_date	integer	Date the registrant signed up for the webinar
attended_live	integer	Registrant’s live attendance status
date_live	integer	Date when the registrant watched the live webinar
entered_live	string	Time to enter the live room
time_live	string	Time spent in the live room
purchased_live	integer	Registrant’s purchase behavior in the live room
revenue_live	string	Revenue earned from the registrant’s purchase in the live room
attended_replay	integer	Registrant’s replay attendance status
date_replay	integer	Date when the registrant watched the replay webinar
time_replay	string	Time spent in the replay room
purchased_replay	integer	Registrant’s purchase behavior in the replay room
revenue_replay	string	Revenue earned from the registrant’s purchase in the replay room
subscribed	integer	Data explaining if the registrant is subscribed to notifications
gdpr_status	integer	Registrant’s GDPR acceptance status
gdpr_communications	integer	Data explains if the registrant from a GDPR region agreed to receive the webinar notifications
gdpr_status_date	integer	Date when the registrant chose their GDPR status
gdpr_status_ip	string	Registrant’s IP address
utm_source	integer	Source of the registration, such as Facebook, Instagram, etc.
utm_medium	integer	Medium of the registration, such as email, affiliate, social, etc.
utm_campaign	integer	Campaign from which the registration is coming in, such as launch, promotional event, etc.
utm_term	integer	Specific ad keywords used in a campaign
utm_content	integer	The exact variation of the same link that the user used to register

* These fields will be returned only if they are enabled within that particular webinar configuration settings

Example CURL request

curl --data “api_key=demokey&webinar_id=556&schedule_id=903” https://api.webinarjam.com/webinarjam/registrants

Example return

WebinarJam API return response