Retrieve a webinar
GET/calendar/{connection_id}/webinar/{id}
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Webinar
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
calendar_id | string | No | (reference to CalendarCalendar) |
subject | string | No | |
start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
timezone | string | No | |
notes | string | No | |
status | enum | No | Values: CANCELED, CONFIRMED, TENTATIVE |
organizer | object | No | |
organizer.user_id | string | No | (reference to HrisEmployee) |
organizer.email | string | No | |
organizer.name | string | No | |
organizer.status | enum | No | Values: ACCEPTED, REJECTED, TENTATIVE |
organizer.required | boolean | No | |
organizer.is_cohost | boolean | No | |
join_url | string | No | |
web_url | string | No | information |
panelists | CalendarWebinarPanelist[] | No | |
panelists[].email | string | No | |
panelists[].name | string | No | |
panelists[].is_required | boolean | No | |
panelists[].join_url | string | No | |
panelists[].join_password | string | No | |
panelists[].status | enum | No | Values: ACCEPTED, REJECTED, TENTATIVE |
registrants | CalendarWebinarRegistrant[] | No | |
registrants[].email | string | No | |
registrants[].name | string | No | |
registrants[].registration_reference | string | No | |
registrants[].registration_status | enum | No | Values: PENDING, APPROVED, REJECTED, CANCELLED |
registrants[].registered_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
panelist_password | string | No | |
registrant_password | string | No | |
conference | CalendarConference[] | No | |
conference[].conference_identifier | string | No | |
conference[].url | string | No | |
conference[].label | string | No | |
conference[].telephone | string | No | |
conference[].participant_access_code | string | No | |
conference[].host_access_code | string | No | |
conference[].notes | string | No | |
conference[].country_code | string | No | ISO 2-digit country code |
conference[].region_code | string | No | ISO 2-digit region code |
recurrence | CalendarEventRecurrence[] | No | |
recurrence[].frequency | enum | No | Values: DAILY, WEEKLY, MONTHLY, YEARLY |
recurrence[].interval | number | No | how many "units" between occurrences, defaults to 1 |
recurrence[].count | number | No | how many occurrences, defaults to undefined (no limit) |
recurrence[].end_at | string (date-time) | No | until date, defaults to undefined (no end date) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
recurrence[].on_days | enum[] | No | days of the week to repeat on, defaults to undefined (every day), only used if frequency is WEEKLY Values: SU, MO, TU, WE, TH, FR, SA |
recurrence[].on_months | object | No | months of the year to repeat on, defaults to undefined (every month), only used if frequency is YEARLY, January is 1 |
recurrence[].on_month_days | object | No | days of the month to repeat on, defaults to undefined (every day), only used if frequency is MONTHLY |
recurrence[].on_weeks | object | No | week ordinals for BYDAY (e.g., -1 for last, -2 for second-to-last, 1 for first, 2 for second), only used with on_days. 0 is used for days without week ordinals. |
recurrence[].on_year_days | object | No | days of the year to repeat on, defaults to undefined (every day), only used if frequency is YEARLY |
recurrence[].week_start | enum | No | week start day, defaults to undefined (no week start day) Values: SU, MO, TU, WE, TH, FR, SA |
recurrence[].excluded_dates | object | No | dates to exclude from the recurrence, defaults to undefined (no exclusions) |
recurrence[].included_dates | object | No | dates to include in the recurrence, defaults to undefined (no inclusions) |
recurrence[].timezone | string | No | timezone, defaults to undefined (no timezone) |
capacity | number | No | |
is_webcast | boolean | No | |
is_enabled | boolean | No | |
is_auto_approve | boolean | No | |
require_first_name | boolean | No | |
require_last_name | boolean | No | |
require_email | boolean | No | |
require_company | boolean | No | |
require_job_title | boolean | No | |
require_address | boolean | No | |
require_phone | boolean | No | |
has_qa | boolean | No | |
has_polls | boolean | No | |
has_recording | boolean | No |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'GET',
url: 'https://api.unified.to/calendar/5de520f96e439b002043d8dc/webinar/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know