Common ModelsFiles

/files/download/request-meta

Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

created_afterstringOptional
If provided, will only return objects created after this datetime.
created_beforestringOptional
If provided, will only return objects created before this datetime.
cursorstringOptional
The pagination cursor value.
idslist of stringsOptional

If provided, will only return objects with the given IDs. Comma-separated list of strings.

include_deleted_databooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
mime_typesstringOptional
A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our <a href='https://help.merge.dev/en/articles/8615316-file-export-and-download-specification' target='_blank'>export format help center article</a>.
modified_afterstringOptional
If provided, will only return objects modified after this datetime.
modified_beforestringOptional
If provided, will only return objects modified before this datetime.
order_byenumOptional

Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.

Allowed values:
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.

Response

nextstring or nullOptional
previousstring or nullOptional
resultslist of objectsOptional