Templates

List templates

List templates synced from Meta for the WhatsApp account identified by phone_number_id. Default filter is status=approved.

get/{phone_number_id}/templates

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/{phone_number_id}/templates
  • Auth: HTTP bearer

Path parameters

phone_number_idstring required

Meta WhatsApp Business phone_number_id of the connected account that should send / own this resource. Discoverable via GET /v1/accounts (returned as phone_number_id on each row).

Example:106540352242922

Query parameters

status'approved' | 'pending' | 'rejected' | 'all'

Template review-state filter. Defaults to approved templates; use all to include every state.

Example:approved
languagestring

Filter by Meta template language code.

Example:id
limitstring

Number of items to return. Defaults to 25; minimum 1 and maximum 100.

Example:25
cursorstring

Opaque continuation token from the previous response's next_cursor. Pass it unchanged and keep all other filters the same.

Example:eyJpZCI6IjAxSFhZWkFCQ0RFRkdISktNTlBRUlNUVldYIiwidHMiOiIyMDI2LTA5LTEwVDA5OjAwOjAwLjAwMFoifQ

Response

Template list

has_moreboolean required

Whether another page is available.

next_cursorstring nullable required

Pass this value unchanged as cursor to fetch the next page. null marks the final page.

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "data": [
    {
      "id": "tmpl_01HXYZABCDEFGHJKMNPQRSTVWX",
      "category": "UTILITY",
      "whatsapp_account": {
        "phone_number_id": "106540352242922",
        "customer": {
          "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
        }
      }
    }
  ],
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.