Returns status code

200

Request url

/search-contacts?query[name]=testName&fields=name&sort[createdOn]=desc&page=4&perPage=30

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*
createdOn[from]Y-m-d
createdOn[to]Y-m-d
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
nameasc,desc
createdOnasc,desc
pageintegerSpecify which page of results return.
perPageintegerSpecify how many results per page should be returned

Example Response

[
    {
        "searchContactId": "V",
        "name": "test_name",
        "createdOn": "2014-09-29 12:25:55",
        "href": "https://api.getresponse.com/v3/search-contacts/V"
    },
    {
        "searchContactId": "Zc",
        "name": "second_test_name",
        "createdOn": "2014-02-09 02:21:11",
        "href": "https://api.getresponse.com/v3/search-contacts/Zc"
    }
]

Returns status code

200

Example Response

{
    "searchContactId": "p",
    "href": "http://api.getresponse.new/v3/search-contacts/p",
    "name": "test_conditions",
    "createdOn": "2015-03-06 12:32:58",
    "subscribersType": [
        "subscribed"
    ],
    "sectionLogicOperator": "or",
    "section": [
        {
            "campaignIdsList": [
                "V"
            ],
            "logicOperator": "or",
            "subscriberCycle": [
                "receiving_autoresponder",
                "not_receiving_autoresponder"
            ],
            "subscriptionDate": "all_time",
            "conditions": [
                {
                    "conditionType": "email",
                    "operatorType": "string_operator",
                    "operator": "is",
                    "value": "someEmail"
                },
                {
                    "conditionType": "name",
                    "operatorType": "string_operator",
                    "operator": "not_contains",
                    "value": "someName"
                },
                {
                    "conditionType": "geo",
                    "operatorType": "string_operator",
                    "operator": "is_not",
                    "value": "dsaDa",
                    "scope": "country"
                },
                {
                    "conditionType": "custom",
                    "operatorType": "string_operator",
                    "operator": "assigned",
                    "scope": "T"
                },
                {
                    "conditionType": "subscription_date",
                    "operatorType": "date_operator",
                    "operator": "date_to",
                    "value": "2015-01-01"
                },
                {
                    "conditionType": "subscription_method",
                    "method": "webform",
                    "value": "all"
                },
                {
                    "conditionType": "subscription_method",
                    "method": "import",
                    "value": "all"
                },
                {
                    "conditionType": "last_open_date",
                    "operatorType": "date_operator",
                    "operator": "specific_date",
                    "value": "last_30_days"
                }
            ]
        },
        {
            "campaignIdsList": [
                "V"
            ],
            "logicOperator": "or",
            "subscriberCycle": [
                "receiving_autoresponder",
                "not_receiving_autoresponder"
            ],
            "subscriptionDate": "all_time",
            "conditions": [
                {
                    "conditionType": "last_newsletter_date",
                    "operatorType": "date_operator",
                    "operator": "custom",
                    "value": "2015-01-01/2015-01-24"
                },
                {
                    "conditionType": "sent",
                    "operatorType": "message_operator",
                    "operator": "autoresponder",
                    "value": "K"
                },
                {
                    "conditionType": "not_sent",
                    "operatorType": "message_operator",
                    "operator": "splittest",
                    "value": "J"
                },
                {
                    "conditionType": "phase",
                    "operatorType": "numeric_operator",
                    "operator": "numeric_lt",
                    "value": "15"
                }
            ]
        }
    ]
}

Returns status code

201

Example Request Body

{
    "name": "test_conditions",
    "subscribersType": [
        "subscribed"
    ],
    "sectionLogicOperator": "or",
    "section": [
        {
            "campaignIdsList": [
                "V"
            ],
            "logicOperator": "or",
            "subscriberCycle": [
                "receiving_autoresponder",
                "not_receiving_autoresponder"
            ],
            "subscriptionDate": "all_time",
            "conditions": [
                {
                    "conditionType": "email",
                    "operatorType": "string_operator",
                    "operator": "is",
                    "value": "someEmail"
                },
                {
                    "conditionType": "name",
                    "operatorType": "string_operator",
                    "operator": "not_contains",
                    "value": "someName"
                },
                {
                    "conditionType": "geo",
                    "operatorType": "string_operator",
                    "operator": "is_not",
                    "value": "dsaDa",
                    "scope": "country"
                }
            ]
        }
    ]
}

Example Response

{
    "searchContactId": "p",
    "href": "http://api.getresponse.new/v3/search-contacts/p",
    "name": "test_conditions",
    "subscribersType": [
        "subscribed"
    ],
    "sectionLogicOperator": "or",
    "section": [
        {
            "campaignIdsList": [
                "V"
            ],
            "logicOperator": "or",
            "subscriberCycle": [
                "receiving_autoresponder",
                "not_receiving_autoresponder"
            ],
            "subscriptionDate": "all_time",
            "conditions": [
                {
                    "conditionType": "email",
                    "operatorType": "string_operator",
                    "operator": "is",
                    "value": "someEmail"
                },
                {
                    "conditionType": "name",
                    "operatorType": "string_operator",
                    "operator": "not_contains",
                    "value": "someName"
                },
                {
                    "conditionType": "geo",
                    "operatorType": "string_operator",
                    "operator": "is_not",
                    "value": "dsaDa",
                    "scope": "country"
                }
            ]
        }
    ]
}

Possible Errors


Returns status code

204

Returns status code

201

Example Request Body

{
    "name": "test_conditions",
    "subscribersType": [
        "subscribed"
    ],
    "sectionLogicOperator": "or",
    "section": [
        {
            "campaignIdsList": [
                "V"
            ],
            "logicOperator": "or",
            "subscriberCycle": [
                "receiving_autoresponder",
                "not_receiving_autoresponder"
            ],
            "subscriptionDate": "all_time",
            "conditions": [
                {
                    "conditionType": "email",
                    "operatorType": "string_operator",
                    "operator": "is",
                    "value": "someEmail"
                },
                {
                    "conditionType": "name",
                    "operatorType": "string_operator",
                    "operator": "not_contains",
                    "value": "someName"
                },
                {
                    "conditionType": "geo",
                    "operatorType": "string_operator",
                    "operator": "is_not",
                    "value": "dsaDa",
                    "scope": "country"
                }
            ]
        }
    ]
}

Example Response

{
    "searchContactId": "p",
    "href": "http://api.getresponse.new/v3/search-contacts/p",
    "name": "test_conditions",
    "subscribersType": [
        "subscribed"
    ],
    "sectionLogicOperator": "or",
    "section": [
        {
            "campaignIdsList": [
                "V"
            ],
            "logicOperator": "or",
            "subscriberCycle": [
                "receiving_autoresponder",
                "not_receiving_autoresponder"
            ],
            "subscriptionDate": "all_time",
            "conditions": [
                {
                    "conditionType": "email",
                    "operatorType": "string_operator",
                    "operator": "is",
                    "value": "someEmail"
                },
                {
                    "conditionType": "name",
                    "operatorType": "string_operator",
                    "operator": "not_contains",
                    "value": "someName"
                },
                {
                    "conditionType": "geo",
                    "operatorType": "string_operator",
                    "operator": "is_not",
                    "value": "dsaDa",
                    "scope": "country"
                }
            ]
        }
    ]
}

Returns status code

200

Example Response

[
    {
        "contactId": "V",
        "href": "https://api.getresponse.com/v3/contacts/V",
        "name": "John Smith",
        "email": "jsmith@example.com",
        "origin": "iphone",
        "dayOfCycle": "175",
        "createdOn": "2014-09-29 12:25:55",
        "campaign": {
            "campaignId": "V",
            "name": "TestCampaign",
            "href": "https://api.getresponse.com/v3/campaigns/V"
        },
        "score": "10",
        "reason": "unsubscribe"
    },
    {
        "contactId": "B",
        "href": "https://api.getresponse.com/v3/contacts/B",
        "name": "John Harit",
        "email": "jsmith@example.com",
        "origin": "iphone",
        "dayOfCycle": "175",
        "createdOn": "2014-09-29 12:25:55",
        "campaign": {
            "campaignId": "V",
            "name": "TestCampaign",
            "href": "https://api.getresponse.com/v3/campaigns/V"
        },
        "score": "10",
        "reason": "unsubscribe"
    }
]

The method allows adding and updating custom field values for all contacts that meet search criteria. This method does not remove or overwrite custom fields with values from request.

Returns status code

202

Example Request Body

{
    "customFieldValues": [
        {
            "customFieldId": "n",
            "value": [
                "white"
            ]
        }
    ]
}

Body params

Field nameField typeField description
customFieldValues (required)collectionCollection of customFieldValues that should be upserted to contact
Field nameField typeField description
customFieldId (required)stringId of customField
value (required)setList of assigned values (one or more - depending of customField type, length 1-128)

Possible Errors


This method allows to search contacts without saving the search. Request body contains a query, structured according to our reference and response is a collection of contacts meeting the criteria.

Returns status code

200

Request url

/search-contacts/contacts?sort[name]=asc&page=3&perPage=100

Request params

Field nameField typeField description
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
emailasc,desc
nameasc,desc
createdOnasc,desc
pageintegerSpecify which page of results return.
perPageintegerSpecify how many results per page should be returned

Example Request Body

{
    "subscribersType": [
        "subscribed"
    ],
    "sectionLogicOperator": "or",
    "section": [
        {
            "campaignIdsList": [
                "V"
            ],
            "logicOperator": "or",
            "subscriberCycle": [
                "receiving_autoresponder",
                "not_receiving_autoresponder"
            ],
            "subscriptionDate": "all_time",
            "conditions": [
                {
                    "conditionType": "email",
                    "operatorType": "string_operator",
                    "operator": "is",
                    "value": "someEmail"
                },
                {
                    "conditionType": "name",
                    "operatorType": "string_operator",
                    "operator": "not_contains",
                    "value": "someName"
                },
                {
                    "conditionType": "geo",
                    "operatorType": "string_operator",
                    "operator": "is_not",
                    "value": "dsaDa",
                    "scope": "country"
                }
            ]
        }
    ]
}

Example Response

[
    {
        "contactId": "V",
        "href": "https://api.getresponse.com/v3/contacts/V",
        "name": "John Smith",
        "email": "jsmith@example.com",
        "note": "best contact ever",
        "dayOfCycle": null,
        "origin": "iphone",
        "createdOn": "2014-09-29 12:25:55",
        "changedOn": "2014-10-29 12:25:55",
        "campaign": {
            "campaignId": "V",
            "name": "Test campaign",
            "href": "https://api.getresponse.com/v3/campaigns/V"
        },
        "timeZone": "America/St_Johns",
        "ipAddress": "127.0.0.1",
        "activities": "https://api.getresponse.com/v3/contacts/V/activities",
        "scoring": 10
    },
    {
        "contactId": "p",
        "href": "https://api.getresponse.com/v3/contacts/p",
        "name": "Jane Smith",
        "email": "janesmith@exampl.com",
        "note": null,
        "origin": "sale",
        "createdOn": "2014-06-29 0:55:11",
        "changedOn": null,
        "campaign": {
            "campaignId": "V",
            "name": "Test campaign",
            "href": "https://api.getresponse.com/v3/campaigns/V"
        },
        "timeZone": "America/Juneau",
        "ipAddress": "127.0.0.1",
        "activities": "https://api.getresponse.com/v3/contacts/p/activities",
        "scoring": null
    }
]

Possible Errors