Retrieve list of Assemblies
https://api2.transloadit.com/assemblies?signature={SIGNATURE}¶ms={PARAMS}
Retrieves a list of Assemblies for your account. They are sorted by creation date descending.
GET query components
-
Passing
signature
is required. For more information please check Signature Authentication. -
Passing
params
is required. It should be first JSON encoded and then URL Encoded with the keys as shown in the table below.
Supported keys inside the params
query component
-
auth
ObjectrequiredContains at least your Transloadit Auth Key in the
key
property.If you enable Signature Authentication, you'll also set an expiry date for the request in the
expires
property like so:{ "key": "23c96d084c744219a2ce156772ec3211", "expires": "2023/01/01 16:53:14+00:00" }
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 as1048576
(1 MB). Specify this to prevent users from uploading excessively large files.When using this key, make sure that it is specified as a hidden
max_size
form field, since settingmax_size
in a Template will have no effect.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.
-
page
Integer ⋅ default:1
Specifies the current page, within the current pagination
-
pagesize
Integer(1
-5000
) ⋅ default:50
Specifies how many Assemblies to be received per API request, which is useful for pagination.
-
type
String ⋅ default:"all"
Specifies the types of Assemblies to be retrieved. This can be one of
all
,uploading
,executing
,canceled
,completed
,failed
orrequest_aborted
. -
fromdate
StringrequiredSpecifies the minimum Assembly UTC creation date/time. Only Assemblies 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 Assemblies before this time will be retrieved. Use the format
Y-m-d H:i:s
. -
keywords
Array of Strings ⋅ default:[]
Specifies keywords to be matched in the Assembly Status. The Assembly fields checked include the
id
,redirect_url
,fields
, andnotify_url
, as well as error messages and files used.
Response
Here’s an example response body:
We either return the error codeASSEMBLY_LIST_ERROR
or a JSON list of found Assemblies.