> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://commify.ferndocs.com/api-reference/templates/get-all-templates-v-3/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://commify.ferndocs.com/_mcp/server. # Get all templates (v3) GET http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v3/templates Reference: https://commify.ferndocs.com/api-reference/templates/get-all-templates-v-3 ## Authentication - `X-API-Key` header (required) — Your Commify API key. ## Request ### Query parameters - `PageSize` (string, optional) - `PageNo` (string, optional) - `SortBy` (string, optional) - `SortOrder` (string, optional) - `Search` (string, optional) - `CreatedStartDate` (datetime, optional) - `CreatedEndDate` (datetime, optional) - `Tags` (string, optional) - `Channel` (string, optional) - `TemplateType` (string, optional) ### Headers - `AccountReference` (string, required) — Mandatory AccountReference header ## Response ### 200 OK - `data` (GetAllTemplatesV3Response, optional, nullable) - `errors` (list of ErrorDto, optional, nullable) ## Errors ### 400 Bad Request Error Bad Request - `errors` (list of ErrorDto, optional, nullable) ## Types ### GetAllTemplatesV3Response - `templates` (list of GetAllTemplatesV3ResponseTemplatesItems, optional) - `totalCount` (GetAllTemplatesV3ResponseTotalCount, optional) - `currentPage` (GetAllTemplatesV3ResponseCurrentPage, optional) - `totalPages` (GetAllTemplatesV3ResponseTotalPages, optional) ### ErrorDto - `errorCode` (string, required) - `errorMessage` (string, required) - `metadata` (map from string to string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItems - `id` (string, optional) - `createTimestamp` (datetime, optional) - `lastUpdateTimestamp` (datetime, optional) - `name` (string, optional, nullable) - `content` (GetAllTemplatesV3ResponseTemplatesItemsContent, optional) - `accountReference` (string, optional, nullable) - `createdBy` (string, optional) - `lastUpdatedBy` (string, optional) - `type` (enum, optional) - Allowed values: `None`, `Text`, `RichCard`, `Media` - `messageType` (enum, optional) - Allowed values: `None`, `MarketingAndResearch`, `NotificationsAndReminders`, `AuthenticationAndSecurity`, `PaymentsAndCollections`, `InternalOperations`, `CustomerSupport`, `Unknown` - `channelSettings` (list of GetAllTemplatesV3ResponseTemplatesItemsChannelSettingsItems, optional, nullable) - `variables` (list of GetAllTemplatesV3ResponseTemplatesItemsVariablesItems, optional) - `isLocked` (boolean, optional) - `tags` (list of GetAllTemplatesV3ResponseTemplatesItemsTagsItems, optional) ### GetAllTemplatesV3ResponseTotalCount ### GetAllTemplatesV3ResponseCurrentPage ### GetAllTemplatesV3ResponseTotalPages ### GetAllTemplatesV3ResponseTemplatesItemsContent - `text` (GetAllTemplatesV3ResponseTemplatesItemsContentText, optional) - `richCard` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCard, optional) - `file` (GetAllTemplatesV3ResponseTemplatesItemsContentFile, optional) - `conversationButtons` (list of GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItems, optional) ### GetAllTemplatesV3ResponseTemplatesItemsChannelSettingsItems - `channel` (enum, optional) - Allowed values: `None`, `Sms`, `Rcs`, `Whatsapp` - `settings` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsVariablesItems - `key` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsTagsItems - `id` (string, optional) - `text` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentText - `value` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCard - `config` (any, optional) - `cards` (list of GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItems, optional) - `preferredStyling` (map from string to string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentFile - `fileUrl` (string, optional, nullable) - `fileName` (string, optional, nullable) - `text` (string, optional, nullable) - `sizeBytes` (GetAllTemplatesV3ResponseTemplatesItemsContentFileSizeBytes, optional) - `contentType` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItems - `id` (string, optional, nullable) - `web` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsWeb, optional) - `phone` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPhone, optional) - `location` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsLocation, optional) - `calendar` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsCalendar, optional) - `text` (string, optional, nullable) - `payment` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPayment, optional) - `reply` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsReply, optional) - `reportTag` (string, optional, nullable) - `preferredStyling` (map from string to string, optional, nullable) - `order` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsOrder, optional) - `metadata` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsMetadata, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItems - `header` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsHeader, optional) - `title` (string, optional, nullable) - `description` (string, optional, nullable) - `buttons` (list of GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItems, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentFileSizeBytes ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsWeb - `url` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPhone - `msisdn` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsLocation - `label` (string, optional, nullable) - `lat` (string, optional, nullable) - `lng` (string, optional, nullable) - `variableName` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsCalendar - `title` (string, optional, nullable) - `description` (string, optional, nullable) - `startAtUtc` (string, optional, nullable) - `endAtUtc` (string, optional, nullable) - `variableName` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPayment - `requestId` (string, optional, nullable) - `lineItems` (list of GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPaymentLineItemsItems, optional) - `currency` (string, optional, nullable) - `paymentMethod` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPaymentPaymentMethod, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsReply - `text` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsOrder ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsMetadata - `public` (map from string to string, optional, nullable) - `private` (any, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsHeader - `adaptiveCard` (any, optional) - `file` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsHeaderFile, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItems - `id` (string, optional, nullable) - `web` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsWeb, optional) - `phone` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPhone, optional) - `location` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsLocation, optional) - `calendar` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsCalendar, optional) - `text` (string, optional, nullable) - `payment` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPayment, optional) - `reply` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsReply, optional) - `reportTag` (string, optional, nullable) - `preferredStyling` (map from string to string, optional, nullable) - `order` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsOrder, optional) - `metadata` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsMetadata, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPaymentLineItemsItems - `type` (string, optional, nullable) - `text` (string, optional, nullable) - `subText` (string, optional, nullable) - `amount` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPaymentLineItemsItemsAmount, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPaymentPaymentMethod - `merchantId` (string, optional, nullable) - `merchantName` (string, optional, nullable) - `acceptedCards` (list of string, optional) - `countryCodes` (list of string, optional) - `billingAddressRequired` (boolean, optional) - `tokenisationData` (GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPaymentPaymentMethodTokenisationData, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsHeaderFile - `fileUrl` (string, optional, nullable) - `fileName` (string, optional, nullable) - `text` (string, optional, nullable) - `sizeBytes` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsHeaderFileSizeBytes, optional) - `contentType` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsWeb - `url` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPhone - `msisdn` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsLocation - `label` (string, optional, nullable) - `lat` (string, optional, nullable) - `lng` (string, optional, nullable) - `variableName` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsCalendar - `title` (string, optional, nullable) - `description` (string, optional, nullable) - `startAtUtc` (string, optional, nullable) - `endAtUtc` (string, optional, nullable) - `variableName` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPayment - `requestId` (string, optional, nullable) - `lineItems` (list of GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPaymentLineItemsItems, optional) - `currency` (string, optional, nullable) - `paymentMethod` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPaymentPaymentMethod, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsReply - `text` (string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsOrder ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsMetadata - `public` (map from string to string, optional, nullable) - `private` (any, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPaymentLineItemsItemsAmount ### GetAllTemplatesV3ResponseTemplatesItemsContentConversationButtonsItemsPaymentPaymentMethodTokenisationData - `type` (string, optional, nullable) - `tokenisationParameters` (map from string to string, optional, nullable) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsHeaderFileSizeBytes ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPaymentLineItemsItems - `type` (string, optional, nullable) - `text` (string, optional, nullable) - `subText` (string, optional, nullable) - `amount` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPaymentLineItemsItemsAmount, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPaymentPaymentMethod - `merchantId` (string, optional, nullable) - `merchantName` (string, optional, nullable) - `acceptedCards` (list of string, optional) - `countryCodes` (list of string, optional) - `billingAddressRequired` (boolean, optional) - `tokenisationData` (GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPaymentPaymentMethodTokenisationData, optional) ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPaymentLineItemsItemsAmount ### GetAllTemplatesV3ResponseTemplatesItemsContentRichCardCardsItemsButtonsItemsPaymentPaymentMethodTokenisationData - `type` (string, optional, nullable) - `tokenisationParameters` (map from string to string, optional, nullable) ## Examples **Response** ```json { "data": null, "errors": null } ``` **SDK Code** ```python import requests url = "http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v3/templates" headers = { "AccountReference": "AccountReference", "X-API-Key": "" } response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v3/templates'; const options = { method: 'GET', headers: {AccountReference: 'AccountReference', 'X-API-Key': ''} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v3/templates" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("AccountReference", "AccountReference") req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v3/templates") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) request["AccountReference"] = 'AccountReference' request["X-API-Key"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v3/templates") .header("AccountReference", "AccountReference") .header("X-API-Key", "") .asString(); ``` ```php request('GET', 'http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v3/templates', [ 'headers' => [ 'AccountReference' => 'AccountReference', 'X-API-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v3/templates"); var request = new RestRequest(Method.GET); request.AddHeader("AccountReference", "AccountReference"); request.AddHeader("X-API-Key", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "AccountReference": "AccountReference", "X-API-Key": "" ] let request = NSMutableURLRequest(url: NSURL(string: "http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v3/templates")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```