WIwistia
Webinars

List Webinars

Changed on

Lists webinars belonging to the account. This endpoint can also be used to do a batch fetch based off of the hashed id.

Requires api token with one of the following permissions

Read all data

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization naming a webinar (any permission) can also be used; it lists the webinars the token names.

get/webinars

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/webinars
  • Auth
    HTTP bearer

Query parameters

pageinteger

The page number to retrieve. This cannot be combined with cursor, pagination.

per_pageinteger

The number of medias per page. Use this for both offset pagination and cursor pagination.

enabled0 | 1

If cursor[enabled] is set to 1, the first result set will be fetched with cursor pagination enabled. This values is ignored if cursor[before] or cursor[after] are set.

beforestring

If cursor[before] is set then cursor pagination is enabled and all records before the cursor up to the per_page are returned. This feature is useful for fetching "new records", for example, in a "pull to refersh" feature when showing records in a descending order.

afterstring

If cursor[after] is set then cursor pagination is enabled and all records after the cursor up to the per_page are returned.

If cursor[enabled] is set to 1 then cursor pagination is enabled and the first set of records are fetched up to the per_page. Cursor pagination will also be turned on if cursor[before] or cursor[after] are set. Records returned will have a cursor property set which can be used to fetch more records in the same sort_by ordering. The cursor value of the last record can be used to fetch records after the current result set and the cursor of the first record can be used to fetch records before the result set.

NOTE: a cursor value is only valid if the sort_by value hasn't changed from the last fetch. For example, you cannot fetch using sort_by id and then pass that cursor value to a sort_by name.

sort_by'scheduled_for' | 'title' | 'created' | 'updated' | 'id'

Field to sort by. When using cursor pagination (see cursor param), only id and scheduled_for are supported. All other sort_by options (title, created, updated) require offset pagination.

sort_direction0 | 1

Sort direction (0 = desc, 1 = asc; default is 1)

hashed_ids[]string[]

Filter by specific webinars IDs

started'true' | 'false'

Filter by whether the webinar has started. Use "true" for webinars that have started, "false" for webinars that have not started yet

Headers

X-Wistia-API-Versionstring required

Response

Successful response with a list of webinars

idstring required

The hashed ID of the webinar

hashed_idstring required

The hashed ID of the webinar. Identical to id, named to match every other Wistia resource.

titlestring required

The title of the webinar

descriptionstring nullable

The description of the webinar

scheduled_forstring date-time nullable

The scheduled start time in W3C format with timezone

event_durationinteger nullable

Duration of the webinar in minutes

time_zonestring required

The IANA time zone identifier the webinar is scheduled in

lifecycle_status'pending' | 'ready' | 'starting' | 'started' | 'ended' | 'vod_ready' | 'failed' required

The current lifecycle status of the webinar. This is a read-only, system-managed field that Wistia updates as the event moves through its lifecycle; it cannot be set or changed via the API.

registration_statusstring required

Registration status of the event

created_atstring date-time required

When the event was created (UTC)

updated_atstring date-time required

When the event was last updated (UTC)

audience_linkstring required

Link for the audience to join the event

host_linkstring required

Link for the host to manage the event

panelist_linkstring required

Link for panelists to join the event

thumbnail_urlstring nullable

URL of the webinar's custom thumbnail image, or null if no custom thumbnail has been set

cursorstring nullable

A cursor for stable pagination based on current sort_by order. You can pass this to cursor[before] or cursor[after] as a parameter to fetch the records before or after this record in the same sort order. This is only populated if records were fetched with cursor[enabled], or cursor[before] or cursor[after].

Example response

[
  {
    "id": "abc123def456",
    "hashed_id": "abc123def456",
    "title": "Wellness Session: Coping with Outie Memories",
    "description": "A comprehensive session on managing work-life balance",
    "scheduled_for": "2024-03-20T15:30:00-05:00",
    "event_duration": 60,
    "time_zone": "America/New_York",
    "lifecycle_status": "ready",
    "registration_status": "published",
    "created_at": "2024-03-15T10:30:00Z",
    "updated_at": "2024-03-15T10:30:00Z",
    "audience_link": "https://lumon-industries.wistia.com/live/events/abc123def456",
    "host_link": "https://lumon-industries.wistia.com/live/events/abc123def456/onair",
    "panelist_link": "https://lumon-industries.wistia.com/live/events/abc123def456/onair/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "thumbnail_url": "https://embed-ssl.wistia.com/deliveries/abc123def456.jpg"
  }
]

Changes