Retrieve a full list of all webinars published in your account
- Method: webinars
- Type: POST
- Complete URL: https://api.webinarjam.com/webinarjam/webinars
The request must include all of the required fields, based on the table below:
Name | Value |
api_key * | string(64) |
* Required fields
The response body will be a JSON object containing an array of webinars. Each webinar object will contain:
Name | Type | Description |
webinar_id | integer | Webinar ID |
webinar_hash * | string | Webinar Hash |
name | string | Webinar Name (Private) |
title | string | Webinar Title (Public) |
description | string | Webinar Description |
type | string | Series of presentations, Single presentation, Always on, Right now |
schedules | array | Array of schedules |
timezone | string | Webinar timezone |
* webinar_hash: this parameter is used in case you want your API to be able to generate the webinar’s one-click registration link.
Example CURL request:
curl --data "api_key=demokey" https://api.webinarjam.com/webinarjam/webinars
Example return:
{ "status": "success", "webinars": [ { "webinar_id": 4, "webinar_hash": "asd4g2", "name": "demo4", "title": "demo4", "description": "A series of events", "type": "Series of presentations", "schedules": [ "Every day, at 1:00 PM", "Every Tuesday, at 2:00 PM" ], "timezone": "America/Los_Angeles", }, { "webinar_id": 3, "webinar_hash": "k5tz6", "name": "demo3", "title": "demo3", "description": "description of webinar", "type": "Single presentation", "schedules": [ "Friday, 3 January 2020, at 1:00 PM" ], "timezone": "America/Chicago", }, { "webinar_id": 2, "webinar_hash": "4otgvf", "name": "demo2", "description": "My always on webinar", "type": "Always on", "schedules": [ "Always on" ], "timezone": "America/New_York", } { "webinar_id": 1, "webinar_hash": "93t2xa", "name": "demo1", "description": "right now", "type": "Right now", "schedules": [ "Right now" ], "timezone": "America/New_York", } ] }