Skip to main content
GET
/
api
/
channels
/
whatsapp
/
template
List WhatsApp Templates
curl --request GET \
  --url https://api.hilos.io/api/channels/whatsapp/template \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "name": "<string>",
      "language": "af",
      "components": {},
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category": "ACCOUNT_UPDATE",
      "status": "draft",
      "rejected_reason": "<string>",
      "is_deleted": true,
      "channel": {
        "id": 123,
        "channel_type": "WHATSAPP",
        "name": "<string>",
        "channel_id": "<string>",
        "status": "NEW",
        "created_on": "2023-11-07T05:31:56Z",
        "channel_provider": "META_CLOUD_API",
        "is_sandbox": true
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
category
enum<string>
Available options:
ACCOUNT_UPDATE,
ALERT_UPDATE,
APPOINTMENT_UPDATE,
AUTHENTICATION,
AUTO_REPLY,
ISSUE_RESOLUTION,
MARKETING,
OTP,
PAYMENT_UPDATE,
PERSONAL_FINANCE_UPDATE,
RESERVATION_UPDATE,
SHIPPING_UPDATE,
TICKET_UPDATE,
TRANSACTIONAL,
TRANSPORTATION_UPDATE,
UTILITY
​
category__in
string[]

Multiple values may be separated by commas.

​
channel
integer
​
channel__in
integer[]

Multiple values may be separated by commas.

​
ordering
string

Which field to use when ordering the results.

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
search
string

A search term.

​
status
enum<string>
Available options:
approved,
deleted,
disabled,
draft,
in_appeal,
pending,
pending_deletion,
rejected,
submitted
​
status__in
string[]

Multiple values may be separated by commas.

Response

200 - application/json
​
count
integer
Example:

123

​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

​
results
object[]