Downloads are files that have been generated as exports from your administration. These can be CSV exports of contacts, sales invoices, time entries, or various financial reports. Use these endpoints to retrieve a list of available downloads and to download the files.
Download a file
Returns a redirect to the actual file download URL.
The user must have the appropriate permissions to access the download based on its type.
The response is a 302 redirect. The client should follow the Location header to download the actual file. The link is valid for 30 seconds.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .jsonidstring | integer · pattern:^\d+$· requiredThe download ID
A unique record identifier
Responses
Found
List all downloads
Returns a paginated list of all downloads in the administration.
Only downloads that the authenticated user has permission to access will be returned, based on the download type and the user's permissions within the administration.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
per_pageinteger | string · min: 1 · max: 100 · pattern:^\d+$pageinteger | stringdownload_typestringFilter downloads by type. Common download types include:
auditfilebrugstaatexport_ledger_account_report
Check the
download_typefield in the response to see all available types.downloadedboolean | stringfailedboolean | string
Responses
A list of downloads
idstring | integer · pattern:^\d+$A unique record identifier
user_idstring | integer | null · pattern:^\d+$A unique record identifier
download_typestringThe type of download (e.g., export_contacts, export_sales_invoices, auditfile)
filenamestringcontent_typestringfailedbooleandownloadedbooleancreated_atstring · date-timeupdated_atstring · date-time