openapi-directory/api/getgo.com/gotowebinar.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"email":"developer-support@logmein.com","name":"Developer Support","url":"https://goto-developer.logmein.com"},"description":"The GoToWebinar API provides seamless integration of webinar registrant and attendee data into your existing infrastructure or third-party applications. The ability to register participants, as well as pull lists of registrants and attendees for a webinar, allows organizers to manage the flow of information between their primary applications without manual intervention.","termsOfService":"https://goto-developer.logmein.com/terms-use","title":"GoToWebinar","version":"1.0.0","x-origin":[{"format":"swagger","url":"https://developer.citrixonline.com/sites/default/files/citrix/citrix-apis/gotowebinar.json","version":"2.0"}],"x-providerName":"getgo.com","x-serviceName":"gotowebinar"},"tags":[{"description":"Operations available for webinars of a given organizer.","name":"Webinars"},{"description":"Operations available for co-organizers of a given webinar.","name":"Co-organizers"},{"description":"Operations available for panelists of a given webinar.","name":"Panelists"},{"description":"Operations available for registrants of a given webinar.","name":"Registrants"},{"description":"Operations available for sessions of a given webinar.","name":"Sessions"},{"description":"Operations available for attendees of a given webinar session.","name":"Attendees"}],"paths":{"/accounts/{accountKey}/webinars":{"get":{"description":"Retrieves the list of webinars for an account within a given date range. __*Page*__ and __*size*__ parameters are optional. Default __*page*__ is 0 and default __*size*__ is 20. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getAllAccountWebinars","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/accountKey"},{"description":"A required start of datetime range in ISO8601 UTC format, e.g. 2015-07-13T10:00:00Z","in":"query","name":"fromTime","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"A required end of datetime range in ISO8601 UTC format, e.g. 2015-07-13T22:00:00Z","in":"query","name":"toTime","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"The page number to be displayed. The first page is 0.","in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"The size of the page.","in":"query","name":"size","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountWebinarsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get all webinars for an account","tags":["Webinars"]}},"/organizers/{organizerKey}/historicalWebinars":{"get":{"description":"Returns details for completed webinars for the specified organizer and completed webinars of other organizers where the specified organizer is a co-organizer.","operationId":"getHistoricalWebinars","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"description":"A required start of datetime range in ISO8601 UTC format, e.g. 2015-07-13T10:00:00Z","in":"query","name":"fromTime","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"A required end of datetime range in ISO8601 UTC format, e.g. 2015-07-13T22:00:00Z","in":"query","name":"toTime","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/HistoricalWebinar"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"summary":"Get historical webinars","tags":["Webinars"]}},"/organizers/{organizerKey}/sessions":{"get":{"description":"Retrieve all completed sessions of all the webinars of a given organizer.","operationId":"getOrganizerSessions","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"description":"A required start of datetime range in ISO8601 UTC format, e.g. 2015-07-13T10:00:00Z","in":"query","name":"fromTime","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"A required end of datetime range in ISO8601 UTC format, e.g. 2015-07-13T22:00:00Z","in":"query","name":"toTime","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Session"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"summary":"Get organizer sessions","tags":["Sessions"]}},"/organizers/{organizerKey}/upcomingWebinars":{"get":{"description":"Returns webinars scheduled for the future for the specified organizer and webinars of other organizers where the specified organizer is a co-organizer.","operationId":"getUpcomingWebinars","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UpcomingWebinar"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"summary":"Get upcoming webinars","tags":["Webinars"]}},"/organizers/{organizerKey}/webinars":{"get":{"description":"Returns webinars scheduled for the future for a specified organizer.","operationId":"getAllWebinars","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Webinar"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"summary":"Get all webinars","tags":["Webinars"]},"post":{"description":"Creates a single session webinar, a sequence of webinars or a series of webinars depending on the type field in the body: \"single_session\" creates a single webinar session, \"sequence\" creates a webinar with multiple meeting times where attendees are expected to be the same for all sessions, and \"series\" creates a webinar with multiple meetings times where attendees choose only one to attend. The default, if no type is declared, is single_session. A sequence webinar requires a \"recurrenceStart\" object consisting of a \"startTime\" and \"endTime\" key for the first webinar of the sequence, a \"recurrencePattern\" of \"daily\", \"weekly\", \"monthly\", and a \"recurrenceEnd\" which is the last date of the sequence (for example, 2016-12-01). A series webinar requires a \"times\" array with a discrete \"startTime\" and \"endTime\" for each webinar in the series. The call requires a webinar subject and description. The \"isPasswordProtected\" sets whether the webinar requires a password for attendees to join. If set to True, the organizer must go to Registration Settings at My Webinars (https://global.gotowebinar.com/webinars.tmpl) and add the password to the webinar, and send the password to the registrants. The response provides a numeric webinarKey in string format for the new webinar. Once a webinar has been created with this method, you can accept registrations.","operationId":"createWebinar","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebinarReqCreate"}}},"description":"The webinar details","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedWebinar"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"summary":"Create webinar","tags":["Webinars"]}},"/organizers/{organizerKey}/webinars/{webinarKey}":{"delete":{"description":"Cancels a specific webinar. If the webinar is a series or sequence, this call deletes all scheduled sessions. To send cancellation emails to registrants set sendCancellationEmails=true in the request. When the cancellation emails are sent, the default generated message is used in the cancellation email body.","operationId":"cancelWebinar","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"description":"Indicates whether cancellation notice emails should be sent. The default value is false","in":"query","name":"sendCancellationEmails","required":false,"schema":{"type":"boolean"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"405":{"description":"Method Not Allowed (Webinar is in the past)"},"409":{"description":"Conflict (Webinar is in session)"}},"summary":"Cancel webinar","tags":["Webinars"]},"get":{"description":"Retrieve information on a specific webinar. If the type of the webinar is 'sequence', a sequence of future times will be provided. Webinars of type 'series' are treated the same as normal webinars - each session in the webinar series has a different webinarKey. If an organizer cancels a webinar, then a request to get that webinar would return a '404 Not Found' error.","operationId":"getWebinar","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebinarByKey"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get webinar","tags":["Webinars"]},"put":{"description":"Updates a webinar. The call requires at least one of the parameters in the request body. The request completely replaces the existing session, series, or sequence and so must include the full definition of each as for the Create call. Set notifyParticipants=true to send update emails to registrants.","operationId":"updateWebinar","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"description":"Defines whether to send notifications to participants","in":"query","name":"notifyParticipants","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebinarReqUpdate"}}},"description":"The webinar details","required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request (times not valid, webinar in progress, webinar ended, etc.)"},"403":{"description":"Forbidden"}},"summary":"Update webinar","tags":["Webinars"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/attendees":{"get":{"description":"Returns all attendees for all sessions of the specified webinar.","operationId":"getAttendeesForAllWebinarSessions","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Attendee"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get attendees for all webinar sessions","tags":["Webinars"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/audio":{"get":{"description":"Retrieves the audio/conferencing information for a specific webinar.","operationId":"getAudioInformation","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audio"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get audio information","tags":["Webinars"]},"post":{"description":"Updates the audio/conferencing settings for a specific webinar","operationId":"updateAudioInformation","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"description":"Defines whether to send notifications to participants","in":"query","name":"notifyParticipants","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudioUpdate"}}},"description":"The audio/conferencing settings","required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Update audio information","tags":["Webinars"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/coorganizers":{"get":{"description":"Returns the co-organizers for the specified webinar. The original organizer who created the webinar is filtered out of the list. If the webinar has no co-organizers, an empty array is returned. Co-organizers that do not have a GoToWebinar account are returned as external co-organizers. For those organizers no surname is returned.","operationId":"getCoorganizers","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Coorganizer"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Get co-organizers","tags":["Co-organizers"]},"post":{"description":"Creates co-organizers for the specified webinar. For co-organizers that have a GoToWebinar account you have to set the parameter 'external' to 'false'. In this case you have to pass the parameter 'organizerKey' only. For co-organizers that have no GoToWebinar account you have to set the parameter 'external' to 'true'. In this case you have to pass the parameters 'givenName' and 'email'. Since there is no parameter for 'surname' you should pass first and last name to the parameter 'givenName'.","operationId":"createCoorganizers","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CoorganizerReqCreate"},"type":"array"}}},"description":"The co-organizer details","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Coorganizer"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Create co-organizers","tags":["Co-organizers"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/coorganizers/{coorganizerKey}":{"delete":{"description":"Deletes an internal co-organizer specified by the coorganizerKey (memberKey).","operationId":"deleteCoorganizer","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/coorganizerKey"},{"description":"By default only internal co-organizers (with a GoToWebinar account) can be deleted. If you want to use this call for external co-organizers you have to set this parameter to 'true'.","in":"query","name":"external","required":false,"schema":{"type":"boolean"}}],"responses":{"204":{"description":"No Content (Co-organizer was deleted)"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Delete co-organizer","tags":["Co-organizers"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/coorganizers/{coorganizerKey}/resendInvitation":{"post":{"description":"Resends an invitation email to the specified co-organizer","operationId":"resendCoorganizerInvitation","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/coorganizerKey"},{"description":"By default only internal co-organizers (with a GoToWebinar account) will retrieve the resent invitation email. If you want to use this call for external co-organizers you have to set this parameter to 'true'.","in":"query","name":"external","required":false,"schema":{"type":"boolean"}}],"responses":{"204":{"description":"No Content (Invitation email was sent)"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Resend invitation","tags":["Co-organizers"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/meetingtimes":{"get":{"description":"Retrieves the meeting times for a webinar.","operationId":"getWebinarMeetingTimes","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DateTimeRange"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get webinar meeting times","tags":["Webinars"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/panelists":{"get":{"description":"Retrieves all the panelists for a specific webinar.","operationId":"getPanelists","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Panelist"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get webinar panelists","tags":["Panelists"]},"post":{"description":"Create panelists for a specified webinar","operationId":"createPanelists","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PanelistReqCreate"},"type":"array"}}},"description":"Array of panelists","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CreatedPanelist"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Create Panelists","tags":["Panelists"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/panelists/{panelistKey}":{"delete":{"description":"Removes a webinar panelist.","operationId":"deleteWebinarPanelist","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/panelistKey"}],"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Delete webinar panelist","tags":["Panelists"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/panelists/{panelistKey}/resendInvitation":{"post":{"description":"Resend the panelist invitation email.","operationId":"resendPanelistInvitation","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/panelistKey"}],"responses":{"204":{"description":"Created"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Resend panelist invitation","tags":["Panelists"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/performance":{"get":{"description":"Gets performance details for all sessions of a specific webinar.","operationId":"getPerformanceForAllWebinarSessions","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/SessionPerformance"},"description":"Describes performance details for webinars","type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get performance for all webinar sessions","tags":["Webinars"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/registrants":{"get":{"description":"Retrieve registration details for all registrants of a specific webinar. Registrant details will not include all fields captured when creating the registrant. To see all data, use the API call 'Get Registrant'. Registrants can have one of the following states; <br>WAITING - registrant registered and is awaiting approval (where organizer has required approval), <br>APPROVED - registrant registered and is approved, and <br>DENIED - registrant registered and was denied.","operationId":"getAllRegistrantsForWebinar","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Registrant"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get registrants","tags":["Registrants"]},"post":{"description":"Register an attendee for a scheduled webinar. The response contains the registrantKey and join URL for the registrant. An email will be sent to the registrant unless the organizer turns off the confirmation email setting from the GoToWebinar website. Please note that you must provide all required fields including custom fields defined during the webinar creation. Use the API call 'Get registration fields' to get a list of all fields, if they are required, and their possible values. At this time there are two versions of the 'Create Registrant' call. The first version only accepts firstName, lastName, and email and ignores all other fields. If you have custom fields or want to capture additional information this version won't work for you. The second version allows you to pass all required and optional fields, including custom fields defined when creating the webinar. To use the second version you must pass the header value 'Accept: application/vnd.citrix.g2wapi-v1.1+json' instead of 'Accept: application/json'. Leaving this header out results in the first version of the API call.","operationId":"createRegistrant","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"description":"Set to 'application/vnd.citrix.g2wapi-v1.1+json' to make a registration using fields (custom or default) additional to the basic ones.","in":"header","name":"Accept","required":false,"schema":{"type":"string"}},{"description":"Indicates whether the confirmation email should be resent when a registrant is re-registered. The default value is false.","in":"query","name":"resendConfirmation","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrantFields"}}},"description":"The registrant details. To get all possible values run the API call 'Get registration fields' which is also part of this documentation.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrantCreated"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"409":{"description":"The user is already registered"}},"summary":"Create registrant","tags":["Registrants"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/registrants/fields":{"get":{"description":"Retrieve required, optional registration, and custom questions for a specified webinar.","operationId":"getRegistrationFields","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationFields"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get registration fields","tags":["Registrants"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/registrants/{registrantKey}":{"delete":{"description":"Removes a webinar registrant from current registrations for the specified webinar. The webinar must be a scheduled, future webinar.","operationId":"deleteRegistrant","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/registrantKey"}],"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Delete registrant","tags":["Registrants"]},"get":{"description":"Retrieve registration details for a specific registrant.","operationId":"getRegistrant","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/registrantKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrantDetailed"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get registrant","tags":["Registrants"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions":{"get":{"description":"Retrieves details for all past sessions of a specific webinar.","operationId":"getAllSessions","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Session"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Get webinar sessions","tags":["Sessions"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}":{"get":{"description":"Retrieves attendance details for a specific webinar session that has ended. If attendees attended the session ('registrantsAttended'), specific attendance details, such as attendenceTime for a registrant, will also be retrieved. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getWebinarSession","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/sessionKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Attendee"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Get webinar session","tags":["Sessions"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees":{"get":{"description":"Retrieve details for all attendees of a specific webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getAttendees","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/sessionKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Attendee"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get session attendees","tags":["Attendees"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}":{"get":{"description":"Retrieve registration details for a particular attendee of a specific webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getAttendee","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/sessionKey"},{"$ref":"#/components/parameters/registrantKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Registrant"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get attendee","tags":["Attendees"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/polls":{"get":{"description":"Get poll answers from a particular attendee of a specific webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getAttendeePollAnswers","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/sessionKey"},{"$ref":"#/components/parameters/registrantKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PollAnswer"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get attendee poll answers","tags":["Attendees"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/questions":{"get":{"description":"Get questions asked by an attendee during a webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getAttendeeQuestions","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/sessionKey"},{"$ref":"#/components/parameters/registrantKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AttendeeQuestion"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get attendee questions","tags":["Attendees"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/surveys":{"get":{"description":"Retrieve survey answers from a particular attendee during a webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getAttendeeSurveyAnswers","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/sessionKey"},{"$ref":"#/components/parameters/registrantKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PollAnswer"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"summary":"Get attendee survey answers","tags":["Attendees"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/performance":{"get":{"description":"Get performance details for a session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getPerformance","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/sessionKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionPerformance"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Get session performance","tags":["Sessions"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/polls":{"get":{"description":"Retrieve all collated attendee questions and answers for polls from a specific webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getPolls","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/sessionKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Poll"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Get session polls","tags":["Sessions"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/questions":{"get":{"description":"Retrieve questions and answers for a past webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getQuestions","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/sessionKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AttendeeQuestion"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Get session questions","tags":["Sessions"]}},"/organizers/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/surveys":{"get":{"description":"Retrieve surveys for a past webinar session. For technical reasons, this call cannot be executed from this documentation. Please use the curl command to execute it.","operationId":"getSurveys","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/organizerKey"},{"$ref":"#/components/parameters/webinarKey"},{"$ref":"#/components/parameters/sessionKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Poll"},"type":"array"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"summary":"Get session surveys","tags":["Sessions"]}}},"servers":[{"url":"https://api.getgo.com/G2W/rest"}],"components":{"parameters":{"Authorization":{"description":"Access token","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},"accountKey":{"description":"The key of the account","in":"path","name":"accountKey","required":true,"schema":{"type":"integer","format":"int64"}},"coorganizerKey":{"description":"The key of the internal or external co-organizer (memberKey)","in":"path","name":"coorganizerKey","required":true,"schema":{"type":"integer","format":"int64"}},"organizerKey":{"description":"The key of the organizer","in":"path","name":"organizerKey","required":true,"schema":{"type":"integer","format":"int64"}},"panelistKey":{"description":"The key of the webinar panelist","in":"path","name":"panelistKey","required":true,"schema":{"type":"integer","format":"int64"}},"registrantKey":{"description":"The key of the registrant","in":"path","name":"registrantKey","required":true,"schema":{"type":"integer","format":"int64"}},"sessionKey":{"description":"The key of the webinar session","in":"path","name":"sessionKey","required":true,"schema":{"type":"integer","format":"int64"}},"webinarKey":{"description":"The key of the webinar","in":"path","name":"webinarKey","required":true,"schema":{"type":"integer","format":"int64"}}},"schemas":{"AccessCodes":{"description":"Describes the access codes for organizer, panelists and attendees","properties":{"attendee":{"description":"Access code for attendees","type":"string"},"organizer":{"description":"Access code for the organizer","type":"string"},"panelist":{"description":"Access code for panelists","type":"string"}},"required":["organizer","panelist","attendee"]},"AccountWebinar":{"description":"Describes a webinar for an account within a given date range.","properties":{"description":{"description":"A short description of the webinar","type":"string"},"impromptu":{"description":"A boolean flag indicating if the webinar type is impromptu","type":"boolean"},"isPasswordProtected":{"default":false,"description":"A boolean flag indicating if the webinar is password protected","type":"boolean"},"organizerKey":{"description":"The key of the webinar organizer","type":"string"},"registrationUrl":{"description":"The URL the webinar invitees can use to register","type":"string"},"subject":{"description":"The webinar subject","type":"string"},"timeZone":{"description":"The timezone where the webinar is taking place","type":"string"},"times":{"description":"Array with startTime and endTime for the webinar sessions","items":{"$ref":"#/components/schemas/DateTimeRange"},"type":"array"},"type":{"default":"single_session","description":"Specifies the webinar type","type":"string"},"webinarID":{"description":"The 9-digit webinar ID","type":"string"},"webinarKey":{"description":"The unique key of the webinar","type":"string"}},"required":["webinarKey","webinarID","subject","description","times","timeZone","organizerKey","registrationUrl","impromptu","isPasswordProtected","type"]},"AccountWebinars":{"description":"","properties":{"webinars":{"items":{"$ref":"#/components/schemas/AccountWebinar"},"type":"array"}},"required":["webinars"]},"AccountWebinarsResponse":{"description":"Describes a list of webinars for an account within a given date range","properties":{"_embedded":{"$ref":"#/components/schemas/AccountWebinars"},"page":{"$ref":"#/components/schemas/page"}},"required":["_embedded","page"]},"AnswerToAttendeeQuestion":{"description":"Describes an answer to a question asked by an attendee during a webinar session.","properties":{"answer":{"description":"An answer given to a question asked by an attendee during a webinar session","type":"string"},"answeredBy":{"description":"The key of the organizer that answered the attendee's question","type":"string"}},"required":["answer","answeredBy"]},"Attendance":{"description":"Describes the times the attendee joined and left a webinar session.","properties":{"joinTime":{"description":"The time the attendee joined a webinar session","format":"date-time","type":"string"},"leaveTime":{"description":"The time the attendee left a webinar session","format":"date-time","type":"string"}},"required":["joinTime","leaveTime"]},"AttendanceStatistics":{"description":"Describes attendance metrics for a webinar session.","properties":{"averageAttendanceTimeSeconds":{"description":"Average attendance time in seconds","format":"float","type":"number"},"averageAttentiveness":{"description":"Average based on the focus of the attendees Viewer during the webinar session","format":"float","type":"number"},"averageInterestRating":{"description":"Numerical value 1-100 (100 being most interested) indicating the average interest rating of the webinar attendees","format":"float","type":"number"},"percentageAttendance":{"description":"The percentage of registrants that actually attended the webinar session","format":"float","type":"number"},"registrantCount":{"description":"The number of registrations for the webinar","format":"int32","type":"integer"}},"required":["registrantCount","percentageAttendance","averageInterestRating","averageAttentiveness","averageAttendanceTimeSeconds"]},"Attendee":{"description":"Describes the attendee of a webinar","properties":{"attendance":{"description":"The list of times the attendee joined and left the webinar session","items":{"$ref":"#/components/schemas/Attendance"},"type":"array"},"attendanceTimeInSeconds":{"description":"The total attendance time in seconds","format":"int64","type":"integer"},"email":{"description":"The attendee's email address","type":"string"},"firstName":{"description":"The attendee's first name","type":"string"},"lastName":{"description":"The attendee's last name","type":"string"},"registrantKey":{"description":"The key of the webinar attendee","format":"int64","type":"integer"},"sessionKey":{"description":"The unique key of the webinar session","format":"int64","type":"integer"}},"required":["registrantKey","firstName","lastName","email","attendanceTimeInSeconds","attendance","sessionKey"]},"AttendeeQuestion":{"description":"Describes the question asked by an attendee during a webinar session; includes the answers given to it.","properties":{"answers":{"description":"Answer to a question of an attendee and key of the organizer that answered","items":{"$ref":"#/components/schemas/AnswerToAttendeeQuestion"},"type":"array"},"askedBy":{"description":"The email address of the attendee that asked the question","type":"string"},"question":{"description":"The question asked by the attendee","type":"string"}},"required":["answers","question","askedBy"]},"Audio":{"description":"Describes the audio/conferencing information for a webinar.","properties":{"confCallNumbers":{"additionalProperties":{"$ref":"#/components/schemas/CallNumbers"},"description":"The conference call numbers and access codes per country. This will be returned only, if 'type' is not set to 'Private'. Example for this object: \"confCallNumbers\":{\"CA\":{\"accessCodes\":{\"attendee\":\"159-309-045\",\"organizer\":\"791-426-085\",\"panelist\":\"690-270-339\"},\"tollFree\":\"1 888 455 4198\"},\"FI\":{\"accessCodes\":{\"attendee\":\"159-309-045\",\"organizer\":\"791-426-085\",\"panelist\":\"690-270-339\"},\"toll\":\"+358 (0) 338 79 4198\"},\"US\":{\"accessCodes\":{\"attendee\":\"159-309-045\",\"organizer\":\"791-426-085\",\"panelist\":\"690-270-339\"},\"toll\":\"+1 (805) 879-4198\",\"tollFree\":\"1 888 455 4198\"}}","type":"object"},"privateInfo":{"$ref":"#/components/schemas/PrivateInfo"},"type":{"$ref":"#/components/schemas/AudioType"}},"required":["type"]},"AudioType":{"description":"How to connect to the webinar's audio conference","enum":["PSTN","VOIP","Hybrid","Private"],"type":"string"},"AudioUpdate":{"description":"Defines the audio/conferencing settings for the specified webinar","properties":{"privateInfo":{"$ref":"#/components/schemas/PrivateInfoUpdate"},"pstnInfo":{"$ref":"#/components/schemas/PstnInfoUpdate"},"type":{"$ref":"#/components/schemas/AudioType"}},"required":["type"]},"CallNumbers":{"description":"Conference call numbers per country.","properties":{"accessCodes":{"$ref":"#/components/schemas/AccessCodes"},"toll":{"description":"Conference number for toll calls.","type":"string"},"tollFree":{"description":"Conference number for toll-free calls.","type":"string"}},"required":["accessCodes","toll"]},"Coorganizer":{"description":"Describes a webinar co-organizer. A co-organizer without a GoToWebinar account is marked as external and is returned without a surname","properties":{"email":{"description":"The co-organizer's email address","type":"string"},"external":{"description":"If the co-organizer has no GoToWebinar account, this value is set to 'true'","type":"boolean"},"givenName":{"description":"The co-organizer's given name","type":"string"},"joinLink":{"description":"The co-organizer's join link","type":"string"},"memberKey":{"description":"The co-organizer's organizer key. A new member key is created for external co-organizers","type":"string"},"surname":{"description":"The co-organizer's surname. For external co-organizers this parameter is not returned","type":"string"}},"required":["joinLink","email","memberKey","external","surname","givenName"]},"CoorganizerReqCreate":{"description":"Details used for creating a co-organizer for a webinar. ","properties":{"email":{"description":"The co-organizer's email address. This parameter has to be passed only, if 'external' is set to 'true'","type":"string"},"external":{"description":"If the co-organizer has no GoToWebinar account, this value has to be set to 'true'","type":"boolean"},"givenName":{"description":"The co-organizer's given name. This parameter has to be passed only, if 'external' is set to 'true'","type":"string"},"organizerKey":{"description":"The co-organizer's organizer key. This parameter has to be passed only, if 'external' is set to 'false'","type":"string"}},"required":["external"]},"CreatedPanelist":{"description":"Describes a created panelist","properties":{"email":{"description":"The panelist's email address","type":"string"},"joinLink":{"description":"The panelist's join link","type":"string"},"name":{"description":"The panelist's name","type":"string"},"panelistKey":{"description":"The panelist's key","type":"string"}},"required":["name","email","joinLink","panelistKey"]},"CreatedWebinar":{"description":"Describes a newly created webinar.","properties":{"webinarKey":{"description":"The unique key of the webinar.","type":"string"}},"required":["webinarKey"]},"CustomAnswers":{"description":"Answers to custom questions of the registrant","properties":{"answer":{"description":"Answer to a custom question when registering","type":"string"},"question":{"description":"Custom question for registering","type":"string"}},"required":["answer","question"]},"DateTimeRange":{"description":"A pair of DateTime values, the first of which serves as a start time and the second as an end time of an interval.","properties":{"endTime":{"description":"The ending time of an interval, e.g. 2015-07-13T22:00:00Z","format":"date-time","type":"string"},"startTime":{"description":"The starting time of an interval, e.g. 2015-07-13T10:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"]},"HistoricalWebinar":{"description":"Describes a completed webinar","properties":{"description":{"description":"A short description of the webinar","type":"string"},"organizerKey":{"description":"The key of the webinar organizer","format":"int64","type":"integer"},"subject":{"description":"The webinar subject","type":"string"},"timeZone":{"description":"The timezone where the webinar is taking place","type":"string"},"times":{"description":"Array with startTime and endTime for the webinar sessions","items":{"$ref":"#/components/schemas/DateTimeRange"},"type":"array"},"webinarID":{"description":"The 9-digit webinar ID","type":"string"},"webinarKey":{"description":"The unique key of the webinar","format":"int64","type":"integer"}},"required":["times","description","subject","organizerKey","webinarKey","webinarID","timeZone"]},"Panelist":{"description":"Describes a webinar session panelist","properties":{"email":{"description":"The panelist's email address","type":"string"},"firstName":{"description":"DEPRECATED. The fields 'firstName' and 'lastName' are replaced by the field 'name'","type":"string"},"joinLink":{"description":"The co-organizer's join link","type":"string"},"lastName":{"description":"DEPRECATED. The fields 'firstName' and 'lastName' are replaced by the field 'name'","type":"string"},"name":{"description":"The panelist's name","type":"string"},"panelistId":{"description":"The panelist's ID","format":"int64","type":"integer"}},"required":["joinLink","lastName","email","name","panelistId","firstName"]},"PanelistReqCreate":{"description":"Describes a single panelist","properties":{"email":{"description":"The panelist's email address","type":"string"},"name":{"description":"The panelist's name","type":"string"}},"required":["email","name"]},"Poll":{"description":"A poll or survey launched by an organizer during or after a webinar session; includes the responses given to it by the attendees.","properties":{"numberOfResponses":{"description":"The total number of responses received for this poll or survey","format":"int32","type":"integer"},"question":{"description":"The poll or survey question asked by the webinar organizer","type":"string"},"responses":{"description":"The responses given by the attendees to the poll or survey","items":{"$ref":"#/components/schemas/PollResponse"},"type":"array"}},"required":["responses","question","numberOfResponses"]},"PollAnswer":{"description":"Describes the answer given by a webinar attendee to a poll or survey launched by an organizer.