storage
file
get/storage/{connection_id}/file

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/storage/{connection_id}/file
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

parent_idstring

The parent ID to filter by

referencestring

The referenced entity ID to filter by (e.g. linked accounting record for storage_file)

typestring

The type to filter by

expandboolean

Whether to flatten grouped or recurring items into individual entries.

fulltextstring

The fulltext to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
descriptionstring
parent_idstring
user_idstring

(reference to HrisEmployee)

sizenumber
type'FILE' | 'FOLDER'
mime_typestring
download_urlstring

This link expires after 1 hour. When you need to retrieve the contents of a file, call the "Retrieve a file" endpoint again to get a new download_url.

hashstring
datastring

base64 encoded file contents used to create/update only

versionstring
web_urlstring
tagsstring[]

labels

rawobject

Changes

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

    • breaking

      the response's body type changed from no type to array for status