v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Get list of templates

The method allows you to get a list of templates in your account.

get/api/v4/chats/templates

Query parameters

pageinteger

Page of the list of templates

limitinteger

Number of entities returned per request (Max. 50)

filter[external_id]string[]

Filter by external ID

withstring

This method only supports the reviews parameter

Response

200

_pageinteger

Example response

{
  "_page": 1,
  "_links": {
    "self": {
      "href": "https://example.kommo.com/api/v4/chats/templates?page=1&limit=50"
    },
    "next": {
      "href": "https://example.kommo.com/api/v4/chats/templates?page=2&limit=50"
    }
  },
  "_embedded": {
    "chat_templates": [
      {
        "id": 734129,
        "account_id": 29439107,
        "name": "Test template",
        "content": "New content. Contact name - {{contact.name}}",
        "created_at": 1640200627,
        "updated_at": 1640360627,
        "buttons": [
          {
            "text": "Button 1",
            "type": "inline"
          }
        ],
        "external_id": "my_external_id",
        "type": "waba",
        "waba_footer": "my footer",
        "waba_category": "UTILITY",
        "waba_language": "en",
        "waba_examples": {
          "{{contact.name}}": "My contact"
        },
        "waba_header": "Header example",
        "waba_header_type": "text",
        "review_status": "review",
        "is_on_review": true,
        "_embedded": {
          "reviews": [
            {
              "id": 36337,
              "source_id": 13232340,
              "status": "review"
            }
          ]
        },
        "_links": {
          "self": {
            "href": "https://example.kommo.com/api/v4/chats/templates/7349"
          }
        }
      }
    ]
  }
}