Returns status code

200

Request url

/webforms?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*
modifiedOnmodifiedOn[from]={Y-m-d}&modifiedOn[to]={Y-m-d}
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
modifiedOnasc,desc
perPageintNumber results on page
pageintPage number

Example Response

[
    {
        "webformId": "aebN",
        "name": "Webform 2014/03/24",
        "href": "https://api.getresponse.com/v3/webforms/aebN",
        "campaign": {
            "campaignId": "o5lx",
            "href": "https://api.getresponse.com/v3/campaigns/o5lx",
            "name": "campaign_name55f69a1b0ff01"
        },
        "scriptUrl": "https://app.getresponse.com/view_webform.js?u=ycng&wid=1848703",
        "status": "disabled",
        "modifiedOn": "2014-04-04T06:44:29+0000",
        "statistics": {
            "opened": 1,
            "subscribed": 0
        }
    }
]

Returns status code

200

Request url

/webforms/1?fields=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

{
    "webformId": "yrKy",
    "name": "First Web Form",
    "href": "https://api.getresponse.com/v3/webforms/yrKy",
    "campaign": {
        "campaignId": "o5lx",
        "href": "https://api.getresponse.com/v3/campaigns/o5lx",
        "name": "campaign_name55f69a1b0ff01"
    },
    "scriptUrl": "https://app.getresponse.com/view_webform.js?u=ycng&wid=2203303",
    "status": "enabled",
    "modifiedOn": "2014-04-04T06:45:16+0000",
    "statistics": {
        "opened": 2,
        "subscribed": 0
    }
}