Skip to main content
GET
List message templates

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer kai_live_....

Make, edit and revoke keys in Kai, under Settings → API. Kai stores only a hash of the key, so the full key is shown one time. You can change the name and the permissions of a key later without a new key.

Query Parameters

channel_id
string<uuid>

A WhatsApp channel id from GET /channels.

status
enum<string>

Send all to include templates that are not sendable.

Available options:
all
agent
string

The email address or the member id of the teammate who sends the message. It fills the agent_name bindings. An address that no member holds returns agent: null and empty hints.

contact_id
string<uuid>

A contact id. It fills the customer_name bindings.

phone
string

A phone number, as an alternative to contact_id. Kai finds the contact of this number.

contact_name
string

The name that your own system holds for this customer. It wins over the name in Kai, and it fills a customer_first_name binding for a customer that Kai does not know yet.

Response

The channel's templates.

channel_id
string<uuid>
agent
object | null

The teammate that agent named, or null when Kai did not recognize it.

contact
object | null

The contact behind contact_id or phone, or null.

data
object[]