{
  "opencollection": "1.0.0",
  "info": {
    "name": "GetResponse APIv3 Search Contacts",
    "version": "3.2026-07-28T07:58:55+00:00"
  },
  "items": [
    {
      "info": {
        "name": "Search Contacts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get search contacts by contact ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getresponse.com/v3/search-contacts/:searchContactId",
            "params": [
              {
                "name": "searchContactId",
                "value": "pV3r",
                "type": "path",
                "description": "The saved search contact identifier"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Get the definition of a specific contact-search filter."
        },
        {
          "info": {
            "name": "Update search contacts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.getresponse.com/v3/search-contacts/:searchContactId",
            "params": [
              {
                "name": "searchContactId",
                "value": "pV3r",
                "type": "path",
                "description": "The saved search contact identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Update specified search contacts."
        },
        {
          "info": {
            "name": "Delete search contacts",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.getresponse.com/v3/search-contacts/:searchContactId",
            "params": [
              {
                "name": "searchContactId",
                "value": "pV3r",
                "type": "path",
                "description": "The saved search contact identifier"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Delete search contacts"
        },
        {
          "info": {
            "name": "Get contacts by search contacts ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getresponse.com/v3/search-contacts/:searchContactId/contacts",
            "params": [
              {
                "name": "searchContactId",
                "value": "pV3r",
                "type": "path",
                "description": "The saved search contact identifier"
              },
              {
                "name": "sort[name]",
                "value": "desc",
                "type": "query",
                "description": "Sort by name"
              },
              {
                "name": "sort[email]",
                "value": "desc",
                "type": "query",
                "description": "Sort by email"
              },
              {
                "name": "sort[createdOn]",
                "value": "asc",
                "type": "query",
                "description": "Sort by creation date"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "Requested number of results per page"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Get contacts from saved search contacts by ID."
        },
        {
          "info": {
            "name": "Upsert custom fields by search contacts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.getresponse.com/v3/search-contacts/:searchContactId/custom-fields",
            "params": [
              {
                "name": "searchContactId",
                "value": "pV3r",
                "type": "path",
                "description": "The saved search contact identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Makes it possible to add and update custom field values for all contacts that meet the search criteria. This method doesn't remove or overwrite custom fields with the values from the request."
        },
        {
          "info": {
            "name": "Get a saved search contact list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getresponse.com/v3/search-contacts",
            "params": [
              {
                "name": "sort[name]",
                "value": "desc",
                "type": "query",
                "description": "Sort by name"
              },
              {
                "name": "sort[createdOn]",
                "value": "asc",
                "type": "query",
                "description": "Sort by creation date"
              },
              {
                "name": "query[name]",
                "value": "",
                "type": "query",
                "description": "Search by name"
              },
              {
                "name": "query[createdOn][from]",
                "value": "",
                "type": "query",
                "description": "Count data from this date"
              },
              {
                "name": "query[createdOn][to]",
                "value": "",
                "type": "query",
                "description": "Count data to this date"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "Requested number of results per page"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Makes it possible to retrieve a collection of short representations of search-contact (known as custom filters in the panel). Every item represents a basic filter object. You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by."
        },
        {
          "info": {
            "name": "Create search contacts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.getresponse.com/v3/search-contacts",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Makes it possible to create a new search-contact. Please refer to [Segments (search contacts) reference manual](https://apidocs.getresponse.com/v3/case-study/segments-manual)"
        },
        {
          "info": {
            "name": "Search contacts using conditions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.getresponse.com/v3/search-contacts/contacts",
            "params": [
              {
                "name": "sort[name]",
                "value": "desc",
                "type": "query",
                "description": "Sort by name"
              },
              {
                "name": "sort[email]",
                "value": "desc",
                "type": "query",
                "description": "Sort by email"
              },
              {
                "name": "sort[createdOn]",
                "value": "asc",
                "type": "query",
                "description": "Sort by creation date"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "Requested number of results per page"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Makes it possible to get a collection of contacts according to a given condition.  Please refer to [Segments (search contacts) reference manual](https://apidocs.getresponse.com/v3/case-study/segments-manual)"
        }
      ]
    }
  ],
  "bundled": true
}