Returns contact profiles matching the supplied identifiers and optional trait filters. optIn..subscribed is true/false when known, or null when the channel has no status. Filter with true, false, or the sentinel null (e.g. optIn.voice.subscribed=null). The query value null is reserved for trait filters (including contactPhone/contactEmail): it matches SQL NULL or a missing jsonb path, not a stored string "null". Identifiers (phone, email, externalId, profileId) are exact matches only. Empty string (=) matches only stored '' and does not match SQL NULL/missing (use =null). contactPhone=null skips E.164 validation. In query strings, encode phone + as %2B (an unencoded + becomes a space and fails E.164 validation).
Rate Limit
Limit Type
Value
Requests per second
10
If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.
Responses
Updated about 3 hours ago
Did this page help you?
Language
Credentials
Header
Loading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
