get--v3-sms-templates
Retrieve and filter SMS templates by name, ID, or body, with pagination and sorting to locate the right templates for your messaging campaigns.
Instructions
View SMS Templates
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Allows filtering of results based on your search criteria. The query should be in the format `field_name:value`. 1. **Field Name**: The field within the SMS history you want to filter by. You can use the following fields: - _template_id_ : The ID of the template - _template_name_ : The name of the template - _body_ : The body content of the template. 2. **Value**: The text or keyword you're searching for within the specified field. If left empty after the colon, the filter will look for all templates with any value in the **Field Name**. For example, if you are searching for the template with the name of _sample_name_, the final query would look like this: `q=template_name:sample_name` <div class="info-box"> <h4><i class="fas fa-info-circle"></i> Note:</h4> <div> <p>Some characters have to be encoded. For example, if you are searching for SMS sent from the phone number +61437085284, your search query q would be:<br/></p> <ul> <li>q=from:%2B61437085284</li> </ul> <p>You can use the <a href="https://www.urlencoder.org/" target="_blank">URL encoder</a> to encode the text. If a character is not an alphanumeric character (A-Z, a-z, 0-9), it is typically either reserved or unsafe and should be encoded.</p> </div> </div> | |
| page | No | The page number to retrieve. Use this parameter to navigate through the [pagination](/#pagination) results. The default value is 1. | |
| limit | No | The number of items to return per page. This parameter controls the size of each page of results. The default value is 15. | |
| order_by | No | Specifies the field and order to sort the results by. The value is composed of the field name followed by a colon and the sort direction (_asc_ for ascending or _desc_ for descending). The default sort order is by _template_id_ in ascending order. You can use the following fields: - _template_id_ : The ID of the Template - _template_name_ : The name of the Template - _body_ : The body content of the Template For example, if you want to order by the _template_id_ in descending order, the query would look like this: `order_by=template_id:desc` |