Returns status code

200

Request url

/forms?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*
createdOncreatedOn[from]={Y-m-d}&createdOn[to]={Y-m-d} - It can be also UTC format
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
nameasc,desc
perPageintNumber results on page
pageintPage number

Example Response

[
    {
        "webformId": "Fur",
        "formId": "Fur",
        "name": "Webform - 07.08.2015",
        "href": "https://api.getresponse.com/v3/forms/Fur",
        "campaign": {
            "campaignId": "o5lx",
            "href": "https://api.getresponse.com/v3/campaigns/o5lx",
            "name": "campaign_name55f69a1b0ff01"
        },
        "hasVariants": "true",
        "scriptUrl": "https://app.getresponse.com/view_webform_v2.js?u=ycng&webforms_id=113103",
        "status": "published",
        "createdOn": "2015-08-07T07:37:57+0000",
        "statistics": {
            "visitors": 0,
            "uniqueVisitors": 0,
            "subscribed": 0
        }
    }
]

Returns status code

200

Request url

/forms/V?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": "Fur",
    "formId": "Fur",
    "name": "Webform - 07.08.2015",
    "href": "https://api.getresponse.com/v3/forms/Fur",
    "campaign": {
        "campaignId": "o5lx",
        "href": "https://api.getresponse.com/v3/campaigns/o5lx",
        "name": "campaign_name55f69a1b0ff01"
    },
    "hasVariants": "true",
    "scriptUrl": "https://app.getresponse.com/view_webform_v2.js?u=ycng&webforms_id=113103",
    "status": "published",
    "createdOn": "2015-08-07T07:37:57+0000",
    "statistics": {
        "visitors": 0,
        "uniqueVisitors": 0,
        "subscribed": 0
    }
}

Returns status code

200

Request url

/forms/V/variants?fields=winner,variantName

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": "Y29",
        "formId": "Y29",
        "variant": "0",
        "variantName": "Variant A",
        "winner": "no",
        "status": "enabled",
        "createdOn": "2015-08-07T07:37:57+0000",
        "numberOfVisitors": "0",
        "numberOfUniqueVisitors": "0",
        "numberOfSubscribers": "0"
    },
    {
        "webformId": "YJN",
        "formId": "YJN",
        "variant": "1",
        "variantName": "Variant B",
        "winner": "no",
        "status": "enabled",
        "createdOn": "2015-08-07T07:38:10+0000",
        "numberOfVisitors": "0",
        "numberOfUniqueVisitors": "0",
        "numberOfSubscribers": "0"
    },
    {
        "webformId": "YxP",
        "formId": "YxP",
        "variant": "2",
        "variantName": "Variant C",
        "winner": "no",
        "status": "enabled",
        "createdOn": "2015-08-07T07:38:10+0000",
        "numberOfVisitors": "0",
        "numberOfUniqueVisitors": "0",
        "numberOfSubscribers": "0"
    }
]