Skip to main content
GET
List the application's WhatsApp contacts, newest first, phones masked: each with its consent status (subscribed, none, unsubscribed), tags and source. Filters: q (a name, or a whole Saudi mobile), status, tag, source.

Authorizations

Authorization
string
header
required

An account token from Settings › Account API in the Tawked console: Authorization: Bearer tk_acct_…

Path Parameters

application
string
required

An application's id (a UUID); list them with applications.applications.list.

Pattern: ^(?:[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})$

Query Parameters

page
integer
Required range: x >= 1
q
string
Maximum string length: 100
source
enum<string>
Available options:
keyword,
salla,
import,
manual
status
enum<string>
Available options:
subscribed,
none,
unsubscribed
tag
string
Maximum string length: 40

Response

Done.

data
object[]
required
next_cursor
string | null
required