get
https://partner.gupshup.io/partner/bizgate/app//template
Returns the message templates registered against a WhatsApp app, with optional filters for type, status, element name, and creation window.
Request parameters
Path parameters
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| appId | Identifier of the WhatsApp app the call acts on. | 6f414190-d45c-4671-bca1-fb6c3018cb13 | String | Required |
Query parameters
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| templateType | Filter by template type. Valid values: TEXT, IMAGE, DOCUMENT, VIDEO, LOCATION, PRODUCT, CATALOG, CAROUSEL, ORDER_STATUS, GIF. Any other value is rejected with 400; it used to be forwarded to the upstream service, which ignored it and returned every template. | TEXT | String | Optional |
| useable | Only usable templates | true | Boolean | Optional |
| stages | Pipeline stages filter | APPROVED | String | Optional |
| elementName | Filter by template element name. Omit it to list every template; supplying it blank or whitespace-only is rejected with 400, because upstream would otherwise ignore the filter and return everything as if it had matched. | hello_world | String | Optional |
| startTime | Created after (epoch ms) | 1779000000000 | Integer | Optional |
| endTime | Created before (epoch ms) | 1779099999999 | Integer | Optional |
| status | Status filter | APPROVED | String | Optional |
| data | Additional filter payload | — | String | Optional |
| pageNo | Page number, 0-based. Must not be negative (400). A page past the end is allowed and returns an empty page. | 0 | Integer | Optional |
| pageSize | Page size. Must not be negative (400). | 20 | Integer | Optional |
Sample cURL — List templates for app.
curl --request GET \
--url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/template?templateType=TEXT&useable=true&stages=APPROVED&elementName=hello_world&startTime=1779000000000&endTime=1779099999999&status=APPROVED&pageNo=0&pageSize=20' \
--header 'Authorization: Bearer <UT>' \
--header 'Accept: application/json'Sample success response (200)
{
"status": "success",
"templates": [
{
"id": "tpl-1001",
"elementName": "hello_world",
"languageCode": "en",
"category": "UTILITY",
"status": "APPROVED",
"templateType": "TEXT"
}
]
}Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…