Get templates from metalibrary

Returns entries from the shared WhatsApp template library, filterable by industry, use case, category, language, and free-text search.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Query parameters

KeyDescriptionValuesData TypeRequired/Optional
elementNameSearch by template element nameorder_shipped—Optional
multiSearchMulti-field search — overrides elementName when provided——Optional
topicFilter by topic——Optional
usecaseFilter by use case——Optional
industryFilter by industry——Optional
languageCodeFilter by language codeen—Optional
templateCategoryFilter by template categoryUTILITY—Optional
pageNoPage number (0-based)0—Optional
pageSizePage size (default 100)20—Optional

Sample cURL — Get templates from metalibrary.

curl --request GET \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/template/metalibrary?elementName=order_shipped&languageCode=en&templateCategory=UTILITY&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
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

Query Params
string

Search by template element name

string

Multi-field search — overrides elementName when provided

string

Filter by topic

string

Filter by use case

string

Filter by industry

string

Filter by language code

string

Filter by template category

integer

Page number (0-based)

integer

Page size (default 100)

Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json