Skip to main content
GET
List a scheduled or sent campaign's recipients in the order it reached them, phones masked: each with its status (queued, skipped, failed, sent, delivered, read), why, and the button tapped. Filters: status (delivered, read, replied, failed), q (a name or a whole Saudi mobile).

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})$
campaign
string
required

A campaign's id (a UUID); list them with campaigns.campaigns.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
status
enum<string>
Available options:
delivered,
read,
replied,
failed

Response

Done.

data
object[]
required
next_cursor
string | null
required