Get User Templates
Description: To get a list of user templates, a HTTP GET request is made to the URL. By default, the results of this end point are paged, refer to page paramater for additional information.
Method: GET
URI: /user-templates/
Parameters:
page
- Can be used to return additional pages of user templates, an empty array will be returned when there are no more records.
- Optionally you can pass 'all' to return all active user templates.
- Default value is 1, if not passed.
query
- Can be used to filter user templates by name based on passed query value.
template_id
- Can be used to filter user templates by a specific template ID.
Headers: Authorization: Third party based authorization header
Returns
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID of the user template. |
| template_version_id | Integer | Unique ID representing the user template version. |
| agency_id | Integer | Unique ID of the user template. |
| user_id | Integer | Unique ID of the user that created the user template. |
| name | String | Name of the user template. |
| template | Boolean | Returns true if user template is a template. |
| finalised | Boolean | Returns true if the user template is finalised. |
| private | Boolean | Returns true if the user template is private. |
| created | Timestamp | Returns Unix timestamp of when user template was created. |
| updated | Timestamp | Returns Unix timestamp of when user template was updated. |
| given_name | String | First name of the transaction's creator. |
| surname | String | Last name of the transaction's creator. |
| template_cost | Integer | Monetary value of user template specified in cents. |
| template_id | Integer | Unique ID representing the user template's template. |
| template_name | String | Name of the template the user template is made from. |
| template_code | String | Template code of the template the user template is made from. |
Example
Request
Response