Skip to main content
GET
Download your own transfer

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer yk_live_…. Scopes: transfers:read, transfers:write, collections:read, collections:write, contacts:read, contacts:write, webhooks:read, webhooks:write. A write scope implies read of the same resource.

Path Parameters

id
string
required

Transfer id. Never the share slug, which is a capability.

Response

Signed download URLs.

Signed download URLs for a transfer or collection.

kind
string
required

Currently one of: transfer, collection. Treat unknown values as unknown, not as an error.

title
string | null
required

A collection's title, or your own transfer's title when you ask for its links. Null when resolving a transfer link someone shared with you: a transfer's title is never shown to recipients.

message
string | null
required

The sender's note on a transfer.

expiresAt
string<date-time> | null
required

When the transfer or collection itself expires. Null for one that keeps things forever.

e2ee
boolean
required

End-to-end encrypted: the bytes are ciphertext, and the key is in the # part of the link.

complete
boolean
required

False while a transfer is still uploading. files lists what has arrived so far; ask again later.

zipUrl
string<uri> | null
required

Everything in one ZIP (resumable with Range). Null for a single file, or while incomplete.

urlsExpireAt
string<date-time>
required

When the signed URLs stop working. Ask again for fresh ones.

files
any[]
required
e2eeMeta
string | null