Returns a collection of imports, optionally filtered by campaign.

Possible status field values:

  • uploaded
  • review
  • approved
  • rejected
  • finished
  • canceled
  • to_review

Returns status code

200

Request url

/imports?fields=status

Request params

Field nameField typeField description
queryhashUsed to search for resources that meet criteria.
KeyPossible values if fixed
campaignId*
createdOn[from]Y-m-d or ISO8601
createdOn[to]Y-m-d or ISO8601
sorthashEnable sorting using specified field (set as a key) and order (set as a value).
KeyPossible values if fixed
createdOnasc, desc
finishedOnasc, desc
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "importId": "Vnc",
        "campaign": {
            "campaignId": "Vp",
            "name": "test_campaign",
            "href": "https://api.getresponse.com/v3/campaigns/Vp"
        },
        "status": "finished",
        "statistics": {
            "uploaded": 5,
            "invalid": 0,
            "updated": 0,
            "addedToList": 5
        },
        "errorStatistics": {
            "syntaxErrors": 0,
            "alreadyInQueue": 0,
            "invalidDomains": 0,
            "blacklist": 0,
            "policyFailures": 0
        },
        "createdOn": "2015-12-15T11:43:39+0000",
        "finishedOn": null,
        "href": "https://api.getresponse.com/v3/imports/Vnc"
    }
]

Returns a single import by ID.

Possible status field values:

  • uploaded
  • review
  • approved
  • rejected
  • finished
  • canceled
  • to_review

Returns status code

200

Request url

/imports/Vnc?fields=status

Request params

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

Example Response

{
    "importId": "Vnc",
    "campaign": {
        "campaignId": "Vp",
        "name": "test_campaign",
        "href": "https://api.getresponse.com/v3/campaigns/Vp"
    },
    "status": "finished",
    "statistics": {
        "uploaded": 5,
        "invalid": 0,
        "updated": 0,
        "addedToList": 5
    },
    "errorStatistics": {
        "syntaxErrors": 0,
        "alreadyInQueue": 0,
        "invalidDomains": 0,
        "blacklist": 0,
        "policyFailures": 0
    },
    "createdOn": "2015-12-15T11:43:39+0000",
    "finishedOn": null,
    "href": "https://api.getresponse.com/v3/imports/Vnc"
}

Possible Errors