List templates

GET/v1/templates

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

statusstring

categorystring

languagestring

searchstring

channel_idstring

limitinteger<int32>

min 1 · max 100 · default: 20

offsetinteger<int32>

min 0 · default: 0

Responses

200OK

itemsTemplateItem[] | nullrequired

Show properties

Array of TemplateItem

body_textstringrequired

builder_jsonany

builder_versioninteger<int32>

buttonsTemplateButtonInput[] | null

Show properties

Array of TemplateButtonInput

examplestring

flow_actionstring

flow_idstring

navigate_screenstring

otp_typestring

package_namestring

phone_numberstring

signature_hashstring

textstringrequired

typestringrequired

urlstring

categorystringrequired

channel_idstring

components_jsonanyrequired

created_atstringrequired

editor_modestring

footer_textstring

header_formatstringrequired

header_handlestring

header_textstring

idstringrequired

languagestringrequired

meta_synced_atstring

meta_template_idstring

namestringrequired

organization_idstringrequired

quality_scorestring

rejection_reasonstring

statusstringrequired

updated_atstringrequired

variablesTemplateVariableItem[] | null

Show properties

Array of TemplateVariableItem

component_typestringrequired

display_namestringrequired

example_valuestringrequired

idstringrequired

positioninteger<int32>required

source_keystring

source_typestringrequired

metaPaginationMetarequired

Show properties

cursorstring

has_morebooleanrequired

limitinteger<int64>required

next_cursorstring

offsetinteger<int64>

totalinteger<int64>

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/templates"

const response = await fetch("/v1/templates", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/templates",
)

Response

{
  "items": [
    {
      "body_text": "string",
      "builder_json": "string",
      "builder_version": 0,
      "buttons": [
        {
          "example": "string",
          "flow_action": "string",
          "flow_id": "string",
          "navigate_screen": "string",
          "otp_type": "string",
          "package_name": "string",
          "phone_number": "string",
          "signature_hash": "string",
          "text": "string",
          "type": "string",
          "url": "string"
        }
      ],
      "category": "string",
      "channel_id": "string",
      "components_json": "string",
      "created_at": "string",
      "editor_mode": "string",
      "footer_text": "string",
      "header_format": "string",
      "header_handle": "string",
      "header_text": "string",
      "id": "string",
      "language": "string",
      "meta_synced_at": "string",
      "meta_template_id": "string",
      "name": "string",
      "organization_id": "string",
      "quality_score": "string",
      "rejection_reason": "string",
      "status": "string",
      "updated_at": "string",
      "variables": [
        {
          "component_type": "string",
          "display_name": "string",
          "example_value": "string",
          "id": "string",
          "position": 0,
          "source_key": "string",
          "source_type": "string"
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true,
    "limit": 0,
    "next_cursor": "string",
    "offset": 0,
    "total": 0
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}