v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Files

Fetch an External Link

Fetch a previously created External Link resource.

get/files/{file_id}/external_links/{external_link_id}

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

A single External Link

idstring

The ID of the External Link resource.

created_atstring date-time

Timestamp of when the object was created.

durationinteger nullable

Details how long (in minutes) the url is valid for.

expiredboolean

Whether the external link has expired.

expires_atstring date-time

When the external link expires.

file_idstring

The File ID the External Link relates to.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)
type'UPLOAD' | 'DOWNLOAD' | 'VIEW'

Sets whether the link uploads or downloads files from Finix.

urlstring

The URL that can be used to upload, download, or view the File.

user_idstring

The ID of the user that requested to create this link.