Files

Download File

Download File

get/file-storage/files/{id}/download

Path parameters

idstring required

ID of the record you are acting upon.

Query parameters

fieldsstring nullable

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: fields=name,email,addresses.city<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-follow-redirectsboolean

Set to false to opt out of the redirect to the presigned download URL. Instead of a 30x response, you receive a 200 JSON body { url, expires_at } containing the URL and its expiry, which you can fetch explicitly. Use this if your client automatically forwards the Authorization header onto redirects, since the downstream storage provider will reject that request. Any value other than false (or omitting the header) preserves the default redirect behavior.

Response

File Download. When the request includes x-apideck-follow-redirects: false and the download would otherwise redirect to a presigned URL, the response body is instead an application/json object { url, expires_at } — fetch url explicitly (without the Authorization header) to retrieve the file.

Changes

Changed in 1 of the 66 revisions of this API.1

    • added the new optional header request parameter x-apideck-follow-redirects

      new-optional-request-parameter