GET
List marketing templates

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

channel
enum<string>

Narrow to one surface. Omit it for all three. An unrecognised value is a 400 rather than an unfiltered page: a client filtering on "e-mail" and receiving every template in the store would read an sms body as email copy.

Available options:
email,
sms,
push
status
enum<string>

Filter by lifecycle state. Omit it to receive all three. ONLY an active template has a published version behind it, so ?status=active is how you ask what a campaign can send right now; draft has never been published and archived has been retired, and neither is sendable. An unrecognised value is a 400 for the same reason as channel.

Available options:
draft,
active,
archived
updated_after
string<date-time>

Templates touched at or after this RFC3339 instant, for reconciling incrementally instead of re-reading the library on every run. It composes with channel and status. Supplying it CHANGES THE ORDER of this endpoint: the default walk descends created_at, and this one climbs updated_at. The default walk avoids updated_at on purpose, because descending it every save would move a template to the front and you would see the same row twice; ascending, a row can only move FORWARD past your position, so seeing it again is the guarantee rather than the bug and the walk is AT LEAST ONCE. WHAT A MISS COSTS HERE IS THE WRONG BODY ON A SEND: the body columns are what a campaign renders, so a client that missed an edit sends copy the merchant replaced. A cursor from one ordering is refused by the other.

limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object