API reference

Returns presigned multipart upload URLs: PUT each part_size slice of the file (the last one shorter) to part_urls[n], then complete the upload within 24 hours. Refused before any URL is issued when the file, or the whole send (transfer_total_bytes), is over the plan's size cap, or when the workspace is out of storage. A paid plan over its storage quota answers 413 overage_requires_ad, which a key can't satisfy.

Key scope: transfers.write

An error: file_size_cap, transfer_size_cap, approval_upload_refused, overage_requires_ad, storage_quota_exceeded, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/transfers" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{"name":"…","size":"…"}'

Finishes the upload (the storage provider's own part list decides; send parts: []), stores the file and queues its malware scan. Use the returned file_id with POST /v1/links. A stored size that differs from the declared one aborts the upload (413 size_mismatch).

Key scope: transfers.write

An error: not_found, not_open, not_staged, size_mismatch, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/transfers/{id}/complete" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{"parts":[{"part_number":"…","etag":"…"}]}'

Copies the link's file into your workspace (billed like an upload; the copy finishes in the background, file.copying) and makes a new link to it with the same rules as POST /v1/links. The new link never gives more than the original: it keeps the original's delivery mode unless you ask for a narrower one (422 delivery_not_allowed otherwise), and a password-protected original keeps a password (yours in link.password, or the original's). On economy storage the forward uses one of the original link's downloads (source.consumed_download). The sender sees the forward; your account is named only on links that verify their recipients. On Free with ads on, it needs an ad credit a key can't get (402 ad_required); an API & Agents workspace out of credits gets 402 insufficient_credits.

Key scope: links.write

An error: password_required, download_disabled, expired, exhausted, scan_pending, content_blocked, own_file, encrypted, link_paused, account_under_review, forwarding_disabled, forwarding_unverified, delivery_not_allowed, forward_quota_exhausted, ad_required, overage_requires_ad, storage_quota_exceeded, insufficient_credits, approval_required, content_blocked, policy_forbidden, policy_password_required, policy_ttl_exceeded, free_tier_size, file_size_cap, transfer_size_cap, paid_required, delivery_conflict, e2e_view_unsupported, e2e_view_too_large, viewer_mark_not_on_e2e, not_found, plan_required, invalid_schedule, slug_invalid, slug_taken, allowed_emails_required, brand_not_found, brand_locked, file_budget_exceeded, viewer_mark_plan, viewer_mark_requires_watermark, viewer_mark_requires_verified_access, guests_require_viewer_mark, guests_require_tracked, guests_not_on_e2e, stamp_requires_encryption, stamp_unsupported, policy_locked, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/forwards" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{"slug":"…"}'

Forwarding copies a link you received into your own storage and gives you a new link to it, without downloading it first. It passes the same checks as a download: password, recipient verification, expiry, download limit and safety scan. It is refused for preview-only and watermarked links, end-to-end encrypted links, your own files (use send again) and when the sender or their team turned forwarding off (403 forwarding_disabled). The answer says what it costs (the copy is billed to your workspace like an upload: plan storage, or credits on an API & Agents workspace), whether it uses one of the link's downloads (economy storage), and what the new link may be: never more than the original lets you.

Key scope: files.read

An error: password_required, download_disabled, expired, exhausted, not_yet_available, scan_pending, content_blocked, own_file, encrypted, link_paused, account_under_review, forwarding_disabled, forwarding_unverified, not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/forwards/check" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{"slug":"…"}'

Creates a link for a stored file (file_id from completing an upload). The expiry is clamped to the plan; expiry_capped says why when yours was shortened. Team policy (no public links, a password required, a maximum lifetime) and approval before send apply. Retrying the same create within 2 minutes returns the first link with replayed: true.

Key scope: links.write

An error: file_not_ready, awaiting_approval, approval_required, content_blocked, policy_forbidden, policy_password_required, policy_ttl_exceeded, free_tier_size, file_size_cap, transfer_size_cap, paid_required, delivery_conflict, e2e_view_unsupported, e2e_view_too_large, viewer_mark_not_on_e2e, not_found, plan_required, invalid_schedule, slug_invalid, slug_taken, allowed_emails_required, brand_not_found, brand_locked, file_budget_exceeded, viewer_mark_plan, viewer_mark_requires_watermark, viewer_mark_requires_verified_access, guests_require_viewer_mark, guests_require_tracked, guests_not_on_e2e, stamp_requires_encryption, stamp_unsupported, policy_locked, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/links" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{"file_id":"…"}'

Every link in the workspace, revoked and expired ones included, newest first, 25 per page (up to 100 with limit). Pass next_cursor back as cursor for the next page. With q: the links whose note, subject, file names, recipients or slug match (typos forgiven), best first, 25 a page (page 1–8; see search). An end-to-end link is found by its file type, never its name.

Key scope: links.write

An error unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/links" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

SendFlo fetches the file at a public https address (resolved and checked first: never a private or local network; no redirects; up to 100 MB in 60 seconds), stores it in your workspace and makes a share link for it, as POST /v1/links does. The key also needs transfers.write (the upload). For automation apps (Zapier, Make, n8n) and scripts that have an address, not the file; A2A's send_file with a URL part does the same.

Key scope: links.write

An error: invalid_url, file_unreachable, file_too_large, upload_failed, file_not_ready, awaiting_approval, approval_required, content_blocked, policy_forbidden, policy_password_required, policy_ttl_exceeded, free_tier_size, file_size_cap, transfer_size_cap, paid_required, delivery_conflict, e2e_view_unsupported, e2e_view_too_large, viewer_mark_not_on_e2e, not_found, plan_required, invalid_schedule, slug_invalid, slug_taken, allowed_emails_required, brand_not_found, brand_locked, file_budget_exceeded, viewer_mark_plan, viewer_mark_requires_watermark, viewer_mark_requires_verified_access, guests_require_viewer_mark, guests_require_tracked, guests_not_on_e2e, stamp_requires_encryption, stamp_unsupported, policy_locked, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/links/from-url" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"…"}'

Changes only the fields you send. A file on included (pool) storage keeps its download limit from upload, and once it has been read its access, recipients and a shorter expiry are fixed too (409 pool_locked, with field and why; see capabilities on the link); a file on unlimited-download storage is open to every change within the plan's limits. The password, note, subject, delivery mode and download emails are never locked. Feedback settings apply to every file of the send.

Key scope: links.write

An error: not_found, pool_locked, policy_password_required, invalid_expiry, policy_ttl_exceeded, allowed_emails_required, paid_required, delivery_conflict, e2e_view_unsupported, e2e_view_too_large, viewer_mark_not_on_e2e, feedback_policy_off, rating_scale_locked, empty_patch, viewer_mark_plan, viewer_mark_requires_watermark, viewer_mark_requires_verified_access, guests_require_viewer_mark, guests_require_tracked, guests_not_on_e2e, policy_locked, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X PATCH "https://api.sendflo.app/v1/links/{id}" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Revokes one link for good and frees the file's storage, unless another live link, an open restore window or a safety review still needs it. Answers 204, also for an unknown or already revoked link.

Key scope: links.write

An error unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X DELETE "https://api.sendflo.app/v1/links/{id}" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

The send as one unit: its state, counts and every file's link (revoked ones included).

Key scope: links.write

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/links/{id}/transfer" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Every file stops opening and downloading; recipients see "Paused by the sender". Safe to repeat. 409 transfer_revoked when every file is revoked.

Key scope: links.write

An error: not_found, transfer_revoked, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X PUT "https://api.sendflo.app/v1/links/{id}/transfer/pause" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Lifts your own pause; a Trust & Safety pause stays (paused_by: "trust"). Safe to repeat.

Key scope: links.write

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X DELETE "https://api.sendflo.app/v1/links/{id}/transfer/pause" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Ends every file for good and frees storage (as revoking one link does). storage says what was freed, held on pooled storage, or kept (shared, under review, or in a restore window). Safe to repeat: revoked_now is 0 the second time.

Key scope: links.write

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/links/{id}/transfer/revoke" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

For an assistant that can't reach the person's files (a hosted chat app): open url for the person — the MCP server does it with a URL elicitation. Signed in as the same account, they pick files and send them the way the Send page does; another account is refused. Poll GET /v1/prepared-sends/{id} for the links. Lasts an hour.

Key scope: links.write

An error: no_person, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/prepared-sends" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Key scope: links.write

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/prepared-sends/{id}" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

The newest 100 events of one link. For a whole send, with paging, use GET /v1/links/{id}/transfer/activity.

Key scope: links.write

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/links/{id}/events" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Every file's events, newest first, 50 per page (up to 200 with limit); pass next_cursor back as cursor. The first page also lists the people (up to 200, people_total counts them all) with what they downloaded and the delivery proof; later pages answer people: null. On Team Pro and Team Enterprise each event also carries the IP address and its network, and each person their addresses; other plans see country and device only.

Key scope: links.write

An error: invalid_cursor, not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/links/{id}/transfer/activity" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

A download (sendflo-audit-<slug>-<date>.csv or .json) with the send, its files, the people, your actions and every event, oldest first (100,000 at most). CSV by default (UTF-8 with a byte-order mark, formula-safe cells; columns section,time_utc,file,link_id,person,verified,action,country,device,transport,proof,detail,ip,network, the last two filled on Team Pro and Team Enterprise); JSON with format=json (events carry ip and network on those plans). Proof older than 90 days is left empty, and a note says why.

Key scope: links.write

Response 200 (text/csv): string

An error: invalid_format, not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/links/{id}/transfer/audit" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Everyone listed, verified or emailed, with each file's state for them. Public sends answer manageable: false: per-person control needs Verified or Only-them access.

Key scope: links.write

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/links/{id}/transfer/people" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Sets exactly the files email may open: "all", or link ids of this send (the others are removed). It never widens access: a restore only gives back what you removed. Their emailed links stop working when they can open nothing. 409 public_link on a public send.

Key scope: links.write

An error: not_found, public_link, invalid_email, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/links/{id}/transfer/people/access" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{"email":"…","files":"all"}'

Links created in the last days (1–90, 30 by default), the newest 200, with opens, views, downloads, sign-ups, bytes served and feedback over the same period.

Key scope: links.write

An error unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/reports/transfers" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

The workspace's newest 100 files, newest first.

Key scope: files.read

An error unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/files" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Whether the file can be sent again (and if not, why), its live links, whether a new link reuses the stored bytes (mode: reuse, free) or needs a copy billed like an upload (mode: copy), and the quota it would use.

Key scope: files.read

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/files/{id}/send-again" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

A new link without uploading again, under the same rules as POST /v1/links (team approval included). mode: reuse links the stored bytes (free); mode: copy makes a copy billed like an upload (charged_bytes), finished in the background (file.copying). One at a time per file (409 busy). On Free with ads on, it needs an ad credit a key can't get (402 ad_required).

Key scope: links.write

An error: not_found, send_again_unavailable, ad_required, busy, overage_requires_ad, storage_quota_exceeded, no_flat_target, copy_quota_exhausted, approval_required, awaiting_approval, content_blocked, policy_forbidden, policy_password_required, policy_ttl_exceeded, free_tier_size, file_size_cap, transfer_size_cap, paid_required, delivery_conflict, e2e_view_unsupported, e2e_view_too_large, viewer_mark_not_on_e2e, not_found, plan_required, invalid_schedule, slug_invalid, slug_taken, allowed_emails_required, brand_not_found, brand_locked, file_budget_exceeded, viewer_mark_plan, viewer_mark_requires_watermark, viewer_mark_requires_verified_access, guests_require_viewer_mark, guests_require_tracked, guests_not_on_e2e, stamp_requires_encryption, stamp_unsupported, policy_locked, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/files/{id}/send-again" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{"link":{}}'

Uploads through upload pages, file requests and inboxes, newest first. Rejected uploads stay listed (scan_state: "rejected"). Includes the uploader's answers and contact details. Without parameters: the newest 200. Narrow with file_request_id, inbox_id, since / until (ISO 8601) and scan_state (comma-separated: pending, clean, flagged, released, not_scannable, rejected); page with limit (1–200) and cursor (the previous answer's next_cursor). Where it came from: source (a helpdesk, like zendesk), connection_id and ticket; q searches the uploader's name and email, file names, the request and the reference, best first, 25 a page (page 1–8; see search); an API credential searches the reference only. A malformed value answers 422 invalid_query.

Key scope: inboxes.read

An error: invalid_query, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/inbox-items" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

A storage URL valid for 1 hour (the bytes never pass through the API). Files still being scanned are allowed; blocked ones are refused. Counts against the monthly download allowance (429 when it's used up).

Key scope: files.read

An error: not_found, gone, content_blocked, egress_cap_exceeded, egress_anomaly, view_only, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/inbox-items/{id}/download" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Images, video, audio and PDFs within a size limit (415 otherwise). Waits for the malware scan (425 scan_pending). HEIC and TIFF come back as a rendered copy from your preview allowance (425 preparing while it renders). Counts as a download. A view_only file comes from the protected plane, never the original (425 preparing while its copy is made): a PDF answers its first 5 pages in page_urls (the rest: POST …/preview/pages), and with member_mark each page is your own marked copy (preview_paused when the team's marked views are used up).

Key scope: files.read

An error: not_found, rejected, gone, content_blocked, not_previewable, scan_pending, restoring, relocating, egress_cap_exceeded, egress_anomaly, preview_quota, render_failed, preparing, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/inbox-items/{id}/preview" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

After POST …/preview answered a view-only PDF's first pages: the next count (10 at most) from from, each from the protected plane (your own marked copy with member_mark; null once the team's marked views are used up, with preview_paused).

Key scope: files.read

An error: not_found, not_view_only, gone, preparing, render_failed, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/inbox-items/{id}/preview/pages" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{"from":"…"}'

Newest first, 200 at most, every state, the personal upload link included. limits gives the plan's allowance of reception links (the personal link doesn't count).

Key scope: file_requests.write

An error unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/file-requests" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Creates an upload page at /u/<slug>. A key of your API & Agents workspace pays 1 credit per request, charged only once the request is created (402 insufficient_credits without a balance), and gets the paid features on any plan. Any other key follows its workspace's plan, as in the app (Verified and Only-them access, a custom retention, notification routing, a brand kit and a custom expiry are paid features), and costs no credits. Send an Idempotency-Key header (1 to 128 visible ASCII characters) to retry safely: within 24 hours the same key returns the request it created, marked idempotent-replayed: true, and is never charged twice. Returns notify_webhook_secret once when you set notify.webhook_url.

Key scope: file_requests.write

An error: insufficient_credits, paid_required, reception_link_limit, invalid_webhook, allowed_emails_required, retention_too_long, brand_not_found, brand_locked, invalid_questions, invalid_expiry, invalid_idempotency_key, idempotency_in_progress, team_required, viewer_mark_plan, policy_locked, no_viewable_types, invalid_embed_origins, plan_required, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/file-requests" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

One file request or upload page of this workspace, with how many files it received.

Key scope: file_requests.write

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/file-requests/{id}" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Changes only the fields you send; the address never changes. Only open requests can be changed (409 not_open). Paid features follow your plan, as when creating one (403 paid_required). notify replaces the whole routing; a new webhook_url returns a new notify_webhook_secret once.

Key scope: file_requests.write

An error: not_found, not_open, paid_required, invalid_webhook, allowed_emails_required, retention_too_long, brand_not_found, brand_locked, invalid_questions, invalid_expiry, team_required, viewer_mark_plan, policy_locked, no_viewable_types, invalid_embed_origins, plan_required, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X PATCH "https://api.sendflo.app/v1/file-requests/{id}" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Closes it (cancelled). Safe to repeat.

Key scope: file_requests.write

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/file-requests/{id}/cancel" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

The link's own webhook (notify.webhook_url): every attempt of the last 30 days, newest first — the status your server answered, how long it took, the start of its answer. attempt 0 is a Resend. 404 no_webhook when the link has none.

Key scope: file_requests.write

An error: not_found, no_webhook, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/file-requests/{id}/webhook/deliveries" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Sends the same body again, with the same webhook-id (so your server can tell it's the same event), to the link's current webhook address. Queued: answers 202.

Key scope: file_requests.write

An error: not_found, no_webhook, body_not_kept, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/file-requests/{id}/webhook/deliveries/{deliveryId}/resend" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

A link's webhook pauses after 5 events in a row whose every attempt failed (notify.webhook_paused_at); you're told in the app and by email. Fix your server, then resume. Saving the link's notify resumes it too.

Key scope: file_requests.write

An error: not_found, no_webhook, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/file-requests/{id}/webhook/resume" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

The secret your server signs "verified by your site" tokens with (the script widget, Pro, Team Pro and Team Enterprise; see /docs/widget). null until you issue one with POST.

Key scope: file_requests.write

An error: not_found, plan_required, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/file-requests/{id}/widget-secret" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Issues a new secret for "verified by your site" tokens; the previous one stops working at once. Pro, Team Pro and Team Enterprise.

Key scope: file_requests.write

An error: not_found, plan_required, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/file-requests/{id}/widget-secret" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

The workspace's inboxes, newest first (200 at most).

Key scope: inboxes.read

An error unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/inboxes" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

An inbox with a 12-character address. Items in it expire after default_ttl_seconds (7 days by default, 30 at most). Files reach it through a file request's deliver_to_inbox_id.

Key scope: inboxes.write

An error unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl -X POST "https://api.sendflo.app/v1/inboxes" \
  -H "authorization: Bearer $SENDFLO_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

The 50 newest items. An unknown inbox gives an empty list. Check file.scan_state before you use a file.

Key scope: inboxes.read

An error unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/inboxes/{id}/items" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Every event of the last 30 days, newest first, whether or not an endpoint received it: for polling (Zapier, Make, n8n), catching up after downtime, or a SIEM. Filter by types (comma-separated) and since; page with cursor (the previous page's next).

Key scope: webhooks.read

An error: invalid_since, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/events" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

One event of the last 30 days, as it was sent (its data is the webhook body's data).

Key scope: webhooks.read

Response 200: any

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/events/{id}" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

One attempt from the delivery log: the request body SendFlo sent and your server's answer (its headers and first 2 KB).

Key scope: webhooks.read

Response 200: any

An error: not_found, or unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/webhook-deliveries/{id}" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

Every registered endpoint, newest first, without its secret, with its last 24 hours of deliveries (deliveries_24h, success_rate_24h). A key needs webhooks.read (or webhooks.write). When a workspace's plan stops including webhooks (below Plus), its endpoints keep running for 30 days (plan_pause_at), with a notice and a reminder, then pause (plan_paused) until an upgrade. Events during a pause are kept 30 days: replay them after upgrading. An endpoint pauses (disabled: true, paused_at set) after 5 events in a row whose every attempt failed — one bad event never pauses it — or at once when its address stops being public; you're told in the app and by email. Resume it with POST /v1/webhooks/:id/resume.

Key scope: webhooks.read

An error unauthenticated (401), insufficient_scope (403), invalid_request or invalid_id (422), rate_limited (429).

curl "https://api.sendflo.app/v1/webhooks" \
  -H "authorization: Bearer $SENDFLO_API_KEY"

The URL must be https and public (its name is resolved now; a private answer is refused). events are names from the event list below, a family such as file.*, or * for everything; an unknown name is refused (422 unknown_event). Deliveries are signed the Standard Webhooks way with secret (whsec_…), which is shown only now; see Webhooks above. The access events (access.*: opened, previewed, downloaded) are on Team Pro and Team Enterprise; with team: true the team's owner or an admin makes an endpoint that receives every member's.

Key scope: webhooks.write