Overview
Return a list of customer templates.
List the templates of a customer
This request will return a list of templates that belong to a customer. It includes the ability to return paged results to limit the number of template items in the response. You can include a page offset, number of items, and template fields that can be returned in the response. It also provides a filter parameter to enable limiting templates returned based on the condition provided.
The Method
API | - | Method |
---|---|---|
REST | POST | https://[Your URL]/api/3.0/templates/fields=:fields&filters=:filters&count=:count&offset=:offset |
Parameters
Optional Parameters
Property | Type | Description |
---|---|---|
fields | array | A comma separated list of template fields to return in the response. |
filters | array | A comma separated list of key value conditions that is used to filter. |
The data returned | ||
count | integer | The number of template items to be returned in the response. |
offset | integer | This is the page of the paginated results to return in the response. |
Example Request
https://[Your URL]/api/3.0/templates?fields=:fields&filters=:filters&count=:count&offset=:offset
Responses
Type | Description |
---|---|
array | An array of templates with id or fields specified in parameter. |