Custom lists

Search or filter on custom lists

The Whispir API allows you to query the GET /customlists endpoint using the following filters.

All filter options are to be passed in as URL query parameters.

Search criteria

name

/customlists?name=Category

type

/customlists?type=Message

Note: The API currently results in a 404 Not Found when there are no activities present in the log for a given search criteria. This should not be not confused with a failed response. But rather as No Data Found.


  • JSON
  • XML
HTTP 1.1 GET https://api.<region>.whispir.com/customlists?apikey=[your_api_key]&field=value
Authorization: Basic asdf98nf89asdvasd2r398h8sdf
x-api-key: your_api_key