API Reference

Search Contacts

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

Search contacts in an organization.

The default offset is 0 and the default limit is 50. The maximum limit is 500.

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

Search Contact Params

Parameters for searching and filtering contacts.

channels
array of objects

Filter by channels contacts have been opted in or out of

channels
created_at
object

Created At Date in ISO 8601

string

Email address of the contact

string

Filter by the contact's external ID (exact match)

ids
array of uuids

Filter by contact IDs

ids
integer

Number of results to return

string

Can be set to any string or nil/null to return contacts with no name

integer

Number of results to skip

string

Phone number of the contact

updated_at
object

Updated At Date in ISO 8601

Responses

Callback

Updated 18 days ago

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

Updated 18 days ago