Get Templates

POST

businesses

{businessId}

get

templates

Get Templates

curl --request POST \
  --url https://api.example.com/v1/businesses/{businessId}/get/templates

const options = {method: 'POST'};

fetch('https://api.example.com/v1/businesses/{businessId}/get/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/businesses/{businessId}/get/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/businesses/{businessId}/get/templates"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/businesses/{businessId}/get/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

Retrieve all WhatsApp templates associated with your business account. Templates with the same name but different language translations are grouped together as a template group. Use this endpoint to check approval status after submitting a new template, to see the category Meta currently applies to each one, and to find the campaigns that send it.

Endpoint

POST https://api.connectly.ai/v1/businesses/{businessId}/get/templates

Request body

The body is optional — send {} to list every template.

Field	Type	Required	Description
`include_campaigns`	boolean	No	When `true`, each template group also returns the campaigns that send it, in `campaigns`. Off by default.
`only_with_campaigns`	boolean	No	When `true`, template groups that no campaign sends are left out of the response. Implies `include_campaigns`, so you can send this flag on its own. Off by default.

include_campaigns adds a field, it does not filter. only_with_campaigns filters: use it when you want the templates you actually send rather than every template on the account. See Returning only the templates you use.

Every other field in the body is accepted for backwards compatibility but does not filter the response.

Response

Returns a list of template groups under entity.templateGroups. Each group contains one or more language variants.

Field	Type	Description
`category`	string	The category Meta currently applies to the template: `UTILITY`, `MARKETING` or `AUTHENTICATION`. This is the billing class in force, so it changes when Meta reclassifies a template.
`campaigns`	array	Campaigns that send any template in the group. Present only when the request set `include_campaigns`.
`campaigns[].id`	string	Campaign ID. Stable for the life of the campaign — key on this.
`campaigns[].name`	string	Campaign name as shown in Connectly. A display label: it can be edited, so do not use it as an identifier.

Meta reclassifies per language, and a template group holds one template per language. When they disagree, the group reports MARKETING and the exact per-language value stays on templates[].externalTemplate.whatsapp.category.

campaigns lists campaigns built on Connectly’s current campaign flows. A template used only by an older campaign returns no campaigns. An empty list means no campaign was found — never that the lookup failed, which returns an error instead.

Campaigns are scoped to the business you query. Templates belong to a WhatsApp Business Account, and several Connectly businesses can share one — so a template that another business on your WhatsApp account sends comes back here with no campaigns.An empty campaigns list means this business sends no campaign with that template, not that the template is unused. To see usage across your whole WhatsApp account, query each business and combine the results yourself.

Template status values:

Status	Description
`MESSAGE_TEMPLATE_STATUS_PENDING`	Submitted to Meta and awaiting review.
`MESSAGE_TEMPLATE_STATUS_APPROVED`	Approved by Meta — ready to use.
`MESSAGE_TEMPLATE_STATUS_REJECTED`	Rejected by Meta. Check `rejectionReason` for details.

Returning only the templates you use

A business on a shared WhatsApp account sees every template on that account, which can be several thousand, while sending only a handful of them. Set only_with_campaigns to get just the ones a campaign in this business sends:

curl -X POST "https://api.connectly.ai/v1/businesses/{businessId}/get/templates" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"only_with_campaigns": true}'

You do not need to send include_campaigns as well — only_with_campaigns implies it, and the surviving groups still carry their campaigns array. The same scoping applies as above: a template that only another business on your WhatsApp account sends has no campaigns here, so it is filtered out too.

Response size

This endpoint is not paginated, and it returns every template on your WhatsApp account rather than only the ones this business created. If the account is shared, expect a large response and several seconds to receive it. only_with_campaigns is currently the only field that narrows the response. The other fields in the request body are accepted but ignored, so they cannot be used to make it smaller.

Example

curl -X POST "https://api.connectly.ai/v1/businesses/{businessId}/get/templates" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"include_campaigns": true}'

{
  "entity": {
    "templateGroups": [
      {
        "id": "order_confirmation",
        "name": "order_confirmation",
        "category": "UTILITY",
        "campaigns": [
          {
            "id": "48728584-8656-438a-9620-6b45ca46e7cb",
            "name": "Order confirmations — September"
          }
        ],
        "templates": [
          {
            "id": "651213231234567",
            "language": { "code": "en" },
            "status": "MESSAGE_TEMPLATE_STATUS_REJECTED",
            "createdAt": "2022-03-09T23:07:01Z",
            "updatedAt": "2022-03-09T23:07:01Z",
            "rejectionReason": "INVALID_FORMAT",
            "templateComponents": [
              {
                "header": {
                  "media": {
                    "type": "TYPE_IMAGE",
                    "example": ["https://example.com/header.png"]
                  }
                }
              },
              {
                "body": {
                  "text": {
                    "text": "Welcome to Connectly!",
                    "example": []
                  }
                }
              },
              {
                "footer": {
                  "text": { "text": "Connectly.ai", "example": [] }
                }
              },
              { "button": { "quickReply": { "text": "Continue" } } },
              { "button": { "quickReply": { "text": "Stop" } } }
            ],
            "externalTemplate": {
              "whatsapp": {
                "id": "651213231234567",
                "name": "order_confirmation",
                "language": "en",
                "status": "REJECTED",
                "rejectedReason": "INVALID_FORMAT",
                "qualityScore": { "score": "UNKNOWN" }
              }
            }
          }
        ]
      }
    ]
  }
}

The externalTemplate.whatsapp object contains the raw template data as returned directly by Meta, alongside Connectly’s own representation in templateComponents. Use templateComponents for the Connectly-native format.

Get Started

Campaigns

Audiences

Messaging

Opt-Outs

Webhooks

Assets

AI Features

Analytics

Business Management

Integrations

Tools

Webchat

Resources

Endpoint

Request body

Response

Returning only the templates you use

Response size

Example

​Endpoint

​Request body

​Response

​Returning only the templates you use

​Response size

​Example

Endpoint

Request body

Response

Returning only the templates you use

Response size

Example