Skip to main content
GET
List the invitation dispatches of the caller company

Authorizations

Authorization
string
header
required

Company secret API key.

Query Parameters

channel
enum<string>

Outbound channel of the send.

Available options:
email,
whatsapp
responseType
enum<string>

Only dispatches targeting this tool kind.

Available options:
woku,
nps,
form,
client-form,
csat,
ces
targetId
string<ObjectId>

Only dispatches targeting this specific tool/woku/form id.

createdFrom
string

Lower bound for createdAt (ISO 8601).

createdTo
string

Upper bound for createdAt (ISO 8601).

status
enum<string>

Lifecycle status of the whole invitation.

Available options:
invited,
partially_responded,
responded,
failed
page
number
default:1
Required range: x >= 1
limit
number
default:20
Required range: x >= 1

Response

Paginated dispatches