Templates

Get templates list

Changed on

Retrieves a paginated list of message templates for the authenticated customer. Supports filtering by status, category, and search term.

get/v3/templates

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/templates
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

pageinteger required

Page number (1-indexed)

page_sizeinteger required

Number of items per page

searchstring nullable

Optional search term for filtering templates

statusstring nullable

Optional status filter: APPROVED, PENDING, REJECTED

categorystring nullable

Optional category filter: MARKETING, UTILITY, AUTHENTICATION

is_welcome_playgroundboolean nullable

Accepted and ignored. It used to filter on the welcome-playground marker inside a template's LOB details; that filter is gone and nothing reads this value, so sending it neither narrows nor widens the result. Retained only so a client still passing is_welcome_playground keeps binding instead of the request shape changing under it.

Headers

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Response

Templates retrieved successfully

successboolean

Indicates whether the request was successful

Changes

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status