API Reference

Filter Contacts with WQL

post
https://api.whippy.co/v1/contacts/filter

Filters contacts in an organization using Whippy Query Language (WQL).

Use this endpoint for complex audience-style filters across contacts and related resources
(messages, conversations, tags, segments, custom data, and more).

Returns matching contacts with a total count. Supports limit (default 50, max 500),
offset, sort, and timeout (15s–60s, default 30s).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Filter Contact Params

Request schema for filtering Contacts with WQL.

filter
array of objects
length ≥ 0

Apply multiple filters to the result set using AND logic

filter
integer
≤ 500
Defaults to 50

Limit the number of results

integer
Defaults to 0

Offset the results

sort
array of objects
length ≥ 0

Sort by multiple resources and their columns

sort
integer
Defaults to 15000

Integer representing the query's timeout in milliseconds.
Minimum allowed value is 15000 and maximum allowed value is 60000

Responses

Callback

Updated about 8 hours ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 8 hours ago