GET
List contact profiles surfaced from WhatsApp groups

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q
string

Free-text search over display name, phone number, LID and raw sender id.

country_prefix
string

Comma-separated list of country prefixes to include.

country_prefix_exclude
string

Comma-separated list of country prefixes to exclude.

has_selling
boolean

Restrict to contacts with at least one for_sale listing.

has_buying
boolean

Restrict to contacts with at least one want_to_buy listing.

group_id
string

Comma-separated list of group UUIDs to scope contacts to.

last_seen_from_ms
integer<int64>
last_seen_to_ms
integer<int64>
sort
enum<string>
default:last_seen
Available options:
last_seen,
listings,
messages,
references
direction
enum<string>
Available options:
asc,
desc
cursor
string
page_size
integer
default:50
Required range: 1 <= x <= 200

Response

Cursor page of contacts.

items
object[]
required
has_more
boolean
required
next_cursor
string | null