v3

OpenAPI 3.0.0Dex Terms of Service2026-07-311481984.7 KB
contacts

Filter contacts

Retrieve contacts matching advanced filter criteria. Accepts filter conditions in the request body, supporting the same pagination as the list endpoint.

post/v1/contacts/filter

Query parameters

takeinteger
skipinteger
cursorstring uuid
ignore_mergeboolean

Filter by the ignore_merge flag (excluded from merge suggestions).

is_starredboolean

Match starred (true) or non-starred (false) contacts.

is_archivedboolean

Match archived (true) or active (false) contacts. Defaults to false when omitted.

has_location_exactstring

Location: exact string match (not fuzzy).

has_never_keep_in_touchboolean

Filter by the never_keep_in_touch flag.

has_tagstring uuid

Match contacts carrying this single tag id.

has_emailboolean

Match contacts that have (true) or lack (false) at least one email.

has_phone_numberboolean

Match contacts that have (true) or lack (false) at least one phone number.

{"stackTrail":"paths:/v1/contacts/filter:post:parameters:4:schema","oasType":"schema","type":"unknown"}
linkedin_databoolean
groups_countboolean
coordinatesboolean
linkedin_databoolean
groups_countboolean
coordinatesboolean

Response

Successful response

errorboolean required