# Retrieve list of Templates

GET`https://api2.transloadit.com/templates?signature={SIGNATURE}&params={PARAMS}`

###### Warning

This endpoint requires your Auth Key to have the `templates:read` scope.

## GET query components

* Passing `signature` is required. For more information, please check [Signature Authentication](/docs/api/authentication.md).
* Passing `params` is required. It should contain a JSON encoded object with the keys as shown in the table below.

## Supported keys inside the `params` field

* ### `auth` — **required**

`object`\
Contains at least your Transloadit Auth Key in the `key` property.\
If you enable Signature Authentication, you must also set an expiry date for the request in the expires property:\
![](/_next/static/media/copy.8f7d2926.svg?dpl=dpl_4duA7gehCzBDXmXrDeYXjKa1tZoa)

```jsonc
{  
  "key": "23c96d084c744219a2ce156772ec3211",  
  "expires": "2009-08-28T01:02:03.000Z"  
}  
```

We strongly recommend including the `nonce` property — a randomly generated, unique value per request that prevents duplicate processing upon retries, can aid in debugging, and avoids attack vectors such as signature key reuse:\
![](/_next/static/media/copy.8f7d2926.svg?dpl=dpl_4duA7gehCzBDXmXrDeYXjKa1tZoa)

```jsonc
{  
  // …  
  "nonce": "04ac6cb6-df43-41fb-a7fd-e5dd711a64e1"  
}  
```

The `referer` property is a regular expression to match against the HTTP referer of this upload, such as `"example\.org"`. Specify this key to make sure that uploads only come from your domain.\
Uploads without a referer will always pass (as they are turned off for some browsers) making this useful in just a handful of use cases. For details about regular expressions, see [Mozilla's RegExp documentation](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global%5FObjects/RegExp).\
The `max_size` property can be used to set a maximum size that an upload can have in bytes, such as `1048576` (1 MB). Specify this to prevent users from uploading excessively large files.\
This can be set as part of the Assembly request or as part of the Template.\
The file size is checked as soon as the upload is started and if it exceeds the maximum size, the entire upload process is canceled and the Assembly will error out, even if it contains files that do not exceed the `max_size` limitation.\
If you want to just ignore the files that exceed a certain size, but process all others, then please use [🤖/file/filter](/docs/robots/file-filter.md).

* ### `page`

`number` (default: `1`)\
Specifies the current page, within the current pagination

* ### `pagesize`

`number` (default: `50`)\
Specifies how many Templates to be received per API request, which is useful for pagination.

* ### `sort`

`id | name | created | modified` (default: `"created"`)\
The field to sort by.

* ### `order`

`asc | desc` (default: `"desc"`)\
The sort direction. Can be `"desc"` for descending (default) or `"asc"` for ascending.

* ### `fromdate` — **required**

`string`\
Specifies the minimum Assembly UTC creation date/time. Only Templates after this time will be retrieved. Use the format `Y-m-d H:i:s`.

* ### `todate`

`string` (default: `"NOW()"`)\
Specifies the maximum Assembly UTC creation date/time. Only Templates before this time will be retrieved. Use the format `Y-m-d H:i:s`.

* ### `keywords`

`Array<string>` (default: `[]`)\
Specifies keywords to be matched in the Assembly Status. The Assembly fields checked include the `id`, `redirect_url`, `fields`, and `notify_url`, as well as error messages and files used.

* ### `include_builtin`

`none | latest | all | exclusively-latest | exclusively-all`\
Include Builtin Templates in the results. Use `latest` (recommended) or `all`. Prefix with `exclusively-` to return only Builtin Templates.

## Response

Either returns with the error code `TEMPLATE_LIST_ERROR` or with a JSON list of found Templates. Use `include_builtin` to include Transloadit-maintained Builtin Templates in the results.
