API reference

GET /me

The workspace, plan and key behind this request

GET /transfers

List transfers, newest first

POST /transfers

Create a transfer

Always creates a draft: the link is not live and nobody is emailed until you call finalize. Returns a tus endpoint and one upload token per file. An unfinalized draft is swept after 24 hours.

GET /transfers/{id}

Transfer detail, files and recipient status

PATCH /transfers/{id}

Change expiry or download limit

DELETE /transfers/{id}

Revoke a transfer

Immediate and irreversible: the per-file encryption keys are destroyed before this returns, so the content is unrecoverable whether or not object storage has caught up.

POST /transfers/{id}/finalize

Send it

Makes the link live and emails any recipients. Safe to retry — finalizing twice does not re-send. Omit recipients for a link-only transfer you share yourself.

POST /transfers/{id}/files

Add files to an unsent transfer

DELETE /transfers/{id}/files/{fileId}

Remove a file from an unsent transfer

GET /transfers/{id}/downloads

Download receipts

One page visit is one download, not one per file — events from the same visit share a sessionId. Most recent 200 events.

GET /collections

List collections

Never includes your vault, which is not reachable from the API at all.

POST /collections

Create a collection

GET /collections/{id}

Collection detail

PATCH /collections/{id}

Rename or re-describe

Title and description only. Sharing settings are deliberately not writable here. Renaming never changes the URL — it has already been sent to people.

DELETE /collections/{id}

Delete a collection and its contents

GET /collections/{id}/files

List files

POST /collections/{id}/files

Register files for upload

Reserves quota under a per-workspace lock and creates any folders implied by path. Returns a tus endpoint and one upload token per file.

DELETE /collections/{id}/files

Delete files

GET /collections/{id}/folders

List folders

Ordered by depth then path, which is not a pre-order traversal — build a tree from parentId rather than trusting the order.

POST /collections/{id}/folders

Create a folder

GET /collections/{id}/guests

List guests

POST /collections/{id}/guests

Invite guests by email

Guests may view and download this one collection. They are free on every plan and are not workspace members.

DELETE /collections/{id}/guests/{guestId}

Remove a guest

GET /contacts

List contacts

POST /contacts

Create a contact

GET /contacts/{id}

Get a contact

PATCH /contacts/{id}

Replace a contact

A full replacement, not a merge: any field you omit is cleared. Send the whole contact back.

DELETE /contacts/{id}

Delete a contact

Revokes nothing — if they were invited to a collection, they keep access.

GET /webhooks

List webhook endpoints

POST /webhooks

Create an endpoint

The response carries the signing secret, once. Free: one endpoint, transfer events.

GET /webhooks/{id}

Get an endpoint

PATCH /webhooks/{id}

Change, pause or resume an endpoint

DELETE /webhooks/{id}

Delete an endpoint

POST /webhooks/{id}/rotate-secret

Replace the signing secret

POST /webhooks/{id}/test

Send a webhook.test event

GET /webhooks/{id}/deliveries

Recent delivery attempts

POST /webhooks/{id}/deliveries/{deliveryId}/retry

Redeliver an event

GET /webhooks/{id}/events

Read events (pull)

Oldest first, after cursor. nextCursor is returned even on the last page, so a poller resumes from it. Kept 30 days.