Common ModelsFiles

/files

Returns a list of File objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

created_afterdatetimeOptional
If provided, will only return objects created after this datetime.
created_beforedatetimeOptional
If provided, will only return objects created before this datetime.
cursorstringOptional
The pagination cursor value.
drive_idstringOptional

Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive.

expandlist of enumsOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
folder_idstringOptional
Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory.
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/).
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

mime_typestringOptional

If provided, will only return files with these mime_types. Multiple values can be separated by commas.

modified_afterdatetimeOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforedatetimeOptional
If provided, only objects synced by Merge before this date time will be returned.
namestringOptional
If provided, will only return files with this name. This performs an exact match.
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.
remote_created_afterdatetimeOptional
If provided, will only return files created in the third party platform after this datetime.
remote_created_beforedatetimeOptional
If provided, will only return files created in the third party platform before this datetime.
remote_idstringOptional
The API provider's ID for the given object.

Response

nextstring or nullOptional
previousstring or nullOptional
resultslist of objectsOptional