--- title: "Get account WhatsApp templates" method: GET path: "/whatsapp/1/templates" tags: ["channels", "whatsapp", "whatsapp-service-management", "whatsapp-template-management"] --- # Get account WhatsApp templates `GET /whatsapp/1/templates` ## Request - Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from) - URL: `https://api.infobip.com/whatsapp/1/templates` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `https://api.infobip.com/auth/1/oauth2/token` - API key in header `Authorization` - API key in header `Authorization` - HTTP basic Retrieve all templates associated with your account based on the provided filter criteria. ## Query parameters - `sender` string[] - `status` string[] - `name` string - `language` string[] - `category` string[] - `applicationId` string - `entityId` string - `page` integer - `size` integer - `orderBy` string ## Response `200` List of all filtered templates - F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaTemplatesApiResponsePaginated - `results` F7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414bTemplateApiResponse[], required: The list of the results for this page. - `id` string: Template ID. - `businessAccountId` integer: Business account ID to which template belongs. - `name` string: Name of the template. - `language` 'af' | 'sq' | 'ar' | 'ar_EG' | 'ar_AE' | 'ar_LB' | 'ar_MA' | 'ar_QA' | 'az' | 'bn' | 'bn_IN' | 'bg' | 'ca' | 'zh_CN' | 'zh_HK' | 'zh_TW' | 'hr' | 'cs' | 'da' | 'nl' | 'nl_BE' | 'en' | 'en_GB' | 'en_US' | 'en_AE' | 'en_AU' | 'en_CA' | 'en_GH' | 'en_IE' | 'en_IN' | 'en_JM' | 'en_MY' | 'en_NZ' | 'en_QA' | 'en_SG' | 'en_UG' | 'en_ZA' | 'et' | 'fil' | 'fi' | 'fr' | 'fr_BE' | 'fr_CA' | 'fr_CH' | 'fr_CI' | 'fr_MA' | 'ka' | 'de' | 'de_AT' | 'de_CH' | 'el' | 'gu' | 'ha' | 'he' | 'hi' | 'hu' | 'id' | 'ga' | 'it' | 'ja' | 'kn' | 'kk' | 'rw_RW' | 'ko' | 'ky_KG' | 'lo' | 'lv' | 'lt' | 'mk' | 'ms' | 'ml' | 'mr' | 'nb' | 'fa' | 'pl' | 'pt_BR' | 'pt_PT' | 'pa' | 'ro' | 'ru' | 'sr' | 'si_LK' | 'sk' | 'sl' | 'es' | 'es_AR' | 'es_CL' | 'es_CO' | 'es_CR' | 'es_DO' | 'es_EC' | 'es_HN' | 'es_MX' | 'es_PA' | 'es_PE' | 'es_ES' | 'es_UY' | 'sw' | 'sv' | 'ta' | 'te' | 'th' | 'tr' | 'uk' | 'ur' | 'uz' | 'vi' | 'zu' | 'unknown': Template language, one template with same name can have multiple transliterations. - `status` 'APPROVED' | 'IN_APPEAL' | 'PENDING' | 'REJECTED' | 'PENDING_DELETION' | 'DELETED' | 'REINSTATED' | 'FLAGGED' | 'FIRST_PAUSED' | 'SECOND_PAUSED' | 'DISABLED' | 'ARCHIVED' | 'UNKNOWN': Status of the template. - `category` 'MARKETING' | 'AUTHENTICATION' | 'UTILITY': Category of the template. - `structure` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaDefaultTemplateStructureApiData, required: Structure of the created template. Can consist of body (mandatory), header, footer, buttons, carousel, limited time offer, call permission request and shortening options. - `header` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaHeaderApiData: Template header. Can be `image`, `document`, `video`, `location` or `text`. - `format` 'TEXT' | 'IMAGE' | 'VIDEO' | 'GIF' | 'DOCUMENT' | 'LOCATION' - `body` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaBodyApiData, required: Template body. - `text` string, required: Plain text or text with placeholders. Placeholders have to be correctly formatted and in the correct order, regardless of other sections. Example: {{1}}, {{2}}, {{3}}... - `examples` string[]: Placeholders examples. The number of examples has to be the same as the number of placeholders. Examples cannot contain placeholders. - `footer` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaFooterApiData: Template footer. - `text` string, required: Plain text, up to 60 characters. - `buttons` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaButtonApiData[]: Template buttons. Can contain 1 to 10 buttons which include up to 2 URL buttons, one phone number button, one `copy code` button and one `flow` button. `quick reply` and non `quick reply` buttons have to be grouped together. - `type` 'PHONE_NUMBER' | 'URL' | 'QUICK_REPLY' | 'COPY_CODE' | 'FLOW' | 'CATALOG' | 'MULTI_PRODUCT' | 'ORDER_DETAILS' | 'VOICE_CALL' | 'REQUEST_CONTACT_INFO' - `carousel` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaCarouselApiData: Template carousel. Applicable only for MARKETING category. - `cards` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaCardApiData[], required: List of cards. - `header` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaHeaderApiData, required: Template header. Can be `image`, `document`, `video`, `location` or `text`. - `format` 'TEXT' | 'IMAGE' | 'VIDEO' | 'GIF' | 'DOCUMENT' | 'LOCATION' - `body` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaBodyApiData, required: Template body. - `text` string, required: Plain text or text with placeholders. Placeholders have to be correctly formatted and in the correct order, regardless of other sections. Example: {{1}}, {{2}}, {{3}}... - `examples` string[]: Placeholders examples. The number of examples has to be the same as the number of placeholders. Examples cannot contain placeholders. - `buttons` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaButtonApiData[], required: Card buttons. Can contain 1 to 2 buttons. - `type` 'PHONE_NUMBER' | 'URL' | 'QUICK_REPLY' | 'COPY_CODE' | 'FLOW' | 'CATALOG' | 'MULTI_PRODUCT' | 'ORDER_DETAILS' | 'VOICE_CALL' | 'REQUEST_CONTACT_INFO' - `limitedTimeOffer` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaLimitedTimeOfferApiData: Limited time offer. - `hasExpiration` boolean: Indicates whether offer expiration details will appear in the delivered message. If set to true, copy code button must be included in the buttons array, and must appear first in the array. - `text` string, required: Offer details text. Up to 16 characters. - `callPermissionRequest` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaCallPermissionRequestApiData: Call permission request. Presence of this object enables a call permission request feature, no fields are required. When header is media type call permission request will not be displayed on end-user's device. - `shorteningOptions` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaShorteningOptionsApiData: URL shortening options. Applicable only if at least one dynamic URL button is present. Modifying this provided URL outside of our company's services may lead to unexpected results. - `customDomain` string, required: Custom domain to be used for URL shortening. - `type` 'TEXT' | 'MEDIA' | 'UNSUPPORTED': Template structure type. - `quality` 'HIGH' | 'MEDIUM' | 'LOW' | 'UNKNOWN': Quality of the template. - `validityPeriod` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaValidityPeriodApiData: Template validity period in which WhatsApp will try to deliver a template message. Supported ranges are dependent on template category: 10 seconds to 15 minutes for Authentication, 30 seconds to 12 hours for Utility, and 12 to 48 hours for Marketing. Marketing validity periods apply only to messages sent through the Marketing Messages API and are ignored by the Cloud API. - `amount` integer, required: Template validity period amount. - `timeUnit` 'SECONDS' | 'MINUTES' | 'HOURS': Message template validity period time unit. - `platform` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaPlatform: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `entityId` string: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `applicationId` string: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `createdAt` string, date-time: Creation date of the template. - `lastUpdatedAt` string, date-time: Last update date of the template. - `libraryTemplateName` string: Name of the library template from which this template was created. If not present, the template was not created using the template library. - `paging` F9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16beaPageInfo, required: Contains information about the page. - `page` integer, required: Requested page number. - `size` integer, required: Requested page size. - `totalPages` integer, required: The total number of pages of the results matching the requested parameters. - `totalResults` integer, required: The total number of the results matching the requested parameters. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `429`: Too Many Requests - `500`: Internal Server Error --- [API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)