Retrieve list of Templates

GET query components

• Passing signature is required. For more information, please check Signature Authentication.
• 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:

  {
    "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:

  {
    // …
    "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⁠.

  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. 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.

  The max_number_of_files property can be used to set a maximum number of files that an upload can have, such as 100. Specify this to prevent users from uploading excessively many files, both via file uploads and via import Robots.

  These properties can be set as part of the Assembly request or as part of the Template.

• 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 Template 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 Template 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 match against Template names. When Builtin Templates are included, their Builtin Template slugs are also searched.

• 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.