Sending GET request to this url, returns collection of WEBINARS resources.

You can narrow down list of resources by passing proper query parameters (list of which you can find below in request params section).

You can specify which page of results you want and how many results per page should be there. You can also specify sort-order using one or more of allowed fields (listed below in request params section).

Last but not least you can even specify which fields from resource you want to get. If you pass param `fields` with list of fields (separated by comma [,]) we will return list of resources with only those fields (we will always add resource id to ensure that you can use that data later on).

 

Returns status code

200

Request url

/webinars?perPage=10&page=4?query[name]=test

Request params

Field nameField typeField description
queryhashUsed to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.
KeyPossible values if fixed
name*
statusupcoming, finished, deleted
campaignIdcampaignId=o5lx,Vgy5
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma
sorthashEnable sorting using specified field (set as a key) and order (set as a value). You can specify multiple fields to sort by.
KeyPossible values if fixed
createdOnasc,desc
startsOnasc,desc
nameasc,desc
perPageintNumber results on page
pageintPage number

Example Response

[
    {
        "webinarId": "T",
        "name": "Webinar name 10",
        "href": "https://api.getresponse.com/v3/conferences/T",
        "createdOn": "2016-10-18 08:43:03",
        "startsOn": "2019-09-20 11:43:03",
        "webinarUrl": "http://webinar.getresponse.com/ycng/test-webinar-1",
        "status": "finished",
        "campaigns": [
            {
                "campaignId": "pZUp5",
                "href": "https://api.getresponse.com/v3/campaigns/pZUp5",
                "name": "1e4cdm_4n745c576apmaa"
            }
        ],
        "newsletters": [
            {
                "newsletterId": "pimcK",
                "href": "https://api.getresponse.com/v3/newsletters/pimcK"
            }
        ],
        "statistics": {
            "registrants": 1246,
            "visitors": 2152,
            "attendees": 660
        }
    },
    {
        "webinarId": "V2",
        "name": "Webinar name 84",
        "href": "https://api.getresponse.com/v3/conferences/V2",
        "createdOn": "2016-10-18 08:43:03",
        "startsOn": "2014-10-10 00:43:03",
        "webinarUrl": "http://webinar.getresponse.com/ycng/test-webinar-1",
        "status": "finished",
        "campaigns": [
            {
                "campaignId": "VQaZy",
                "href": "https://api.getresponse.com/v3/campaigns/VQaZy",
                "name": "4na_57med38iencgbba6a5pfm0"
            }
        ],
        "newsletters": [
            {
                "newsletterId": "pi211",
                "href": "https://api.getresponse.com/v3/newsletters/pi211"
            }
        ],
        "statistics": {
            "registrants": 124,
            "visitors": 215,
            "attendees": 66
        }
    },
    {
        "webinarId": "nM",
        "name": "Webinar name 70",
        "href": "https://api.getresponse.com/v3/conferences/nM",
        "createdOn": "2016-10-18 08:43:03",
        "startsOn": "2018-07-06 23:43:03",
        "webinarUrl": "http://webinar.getresponse.com/ycng/test-webinar-1",
        "status": "finished",
        "campaigns": [
            {
                "campaignId": "VaaIH",
                "href": "https://api.getresponse.com/v3/campaigns/VaaIH",
                "name": "4caa74ei71g6en75pn1cmacm_7"
            }
        ],
        "newsletters": [
            {
                "newsletterId": "aascK",
                "href": "https://api.getresponse.com/v3/newsletters/aascK"
            }
        ],
        "statistics": {
            "registrants": 146,
            "visitors": 212,
            "attendees": 66
        }
    }
]

Sending GET request to this url, returns single WEBINAR resource. You must specify webinarId in the request URL.

The only query parameter you can specify is `fields` which allows you to narrow down list of fields that will be return in resource body (we will always add resource id to ensure that you can use that data later on). You can specify which field to return by passing them as a list separated by comma [,]

Returns status code

200

Request url

/webinars/V?fields=name,status

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

{
    "webinarId": "p4X4",
    "name": "test webinar 1",
    "href": "https://api.getresponse.com/v3/webinars/p4X4",
    "createdOn": "2016-10-17T06:44:52+0000",
    "startsOn": "2016-10-17T07:00:00+0000",
    "webinarUrl": "http://webinar.getresponse.com/ycng/test-webinar-1",
    "status": "finished",
    "campaigns": [
        {
            "campaignId": "o5lx",
            "href": "https://api.getresponse.com/v3/campaigns/o5lx",
            "name": "cmp_name56740b3c7f187"
        }
    ],
    "newsletters": [
        {
            "newsletterId": "LWs8R",
            "href": "https://api.getresponse.com/v3/newsletters/LWs8R"
        }
    ],
    "statistics": {
        "registrants": 0,
        "visitors": 0,
        "attendees": 0
    }
}