Skip to content
Share2Us
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Start here
What Share2Us is
Install the CLI
Your first share
Guides
Share a link
Receive files
Encryption
Devices and trust
Transfer over your own network
Run it in the background
Working with AI agents
Interactive forms
Staying up to date
Desktop app
Install and use
Reference
Command reference
API reference
Overview
Auth
Overview
Create a CLI device authorization code.
Approve a pending device code after browser authentication.
Exchange an approved device code for a device credential.
Revoke a CLI session using an approved device code.
Revoke the current device/API session.
Return the authenticated account and user profile.
Register or refresh a browser web session.
List the caller's active device and web sessions.
Revoke one of the caller's sessions.
Uploads
Overview
Create a direct-to-storage upload session.
Get upload session status.
Mark a direct-to-storage upload complete for validation/scanning.
Cancel an upload session that has not become ready.
Shares
Overview
List shares visible to the authenticated account.
Get share metadata.
Delete share metadata and schedule object cleanup.
Revoke a share so it can no longer be downloaded.
Share an existing share with a teammate by email.
Update share expiry within plan limits.
List safe activity events for a share.
Get privacy-safe analytics for one share.
List pending teammate shares awaiting per-file approval.
Approve a pending teammate share for delivery to recipient devices.
Reject a pending teammate share and remove delivery fan-out keys.
Acknowledge receipt of a device inbox share so it is no longer flagged for re-seal.
List in-flight shares the caller sent that need re-sealing to a recipient's new device key (Option B).
Submit a content key re-sealed to a recipient's new device key. Session-only (never an API token).
Mint a short-lived gateway unlock token for a share your own account owns. Session-only (never an API token).
Authorize one direct P2P streaming room on the signalling relay (Pro+).
Account
Overview
Get current usage counters.
Get privacy-safe account analytics.
Get current account plan.
Get effective entitlement rules for the current account.
Close the authenticated account (self-service deletion).
List the account's personal API tokens.
Mint a personal API token.
Revoke a personal API token.
Get the authenticated owner's profile.
Update display name, username, or visibility.
Stream the authenticated owner's avatar image.
Upload or replace the avatar (PNG/JPEG/WebP, up to 2 MB).
Remove the avatar and release its storage.
First-run onboarding status.
Record acceptance of the current terms version (GDPR).
Mark onboarding complete.
Notifications
Overview
List in-app notifications for the current account (newest first).
Register an FCM web-push token for the current account (ADR-018 Phase 6).
Remove an FCM web-push token (opt-out / logout).
Mark notifications read (all unread, or the given ids).
Teammates
Overview
Get the caller account's inbound teammate policy.
Set the caller account's default inbound teammate policy mode.
Upsert a per-sender inbound teammate policy override.
Delete a per-sender inbound teammate policy override.
List suggested teammate contacts from the caller's own sharing history.
Resolve a recipient's key-registered CLI devices for E2E teammate targeting.
Gateway
Overview
Public download gateway for an opaque share ID.
Submit a password challenge for a protected share.
Report an abusive public share.
CLI
Overview
CLI self-update manifest for a platform.
Anonymous CLI install/update telemetry ping (unauthenticated, IP-rate-limited).
Public
Submit a contact-us message (public; rate-limited).
Support
List the authenticated caller's support tickets.
Submit an authenticated support ticket.
Get one of the authenticated caller's support tickets and its thread.
Add a user reply to one of the caller's support tickets.
Close one of the caller's support tickets with resolution feedback.
Upload an evidence attachment for one of the caller's support tickets.
Download one evidence attachment from a caller-owned support ticket.
GitHub
Select theme
Dark
Light
Auto
Overview
Auth
Section titled “Auth”
Device login and current principal endpoints.
Operations
Section titled “Operations”
POST
/v1/auth/device-codes
POST
/v1/auth/device-codes/{id}/approve
POST
/v1/auth/device-codes/{id}/token
POST
/v1/auth/device-codes/{id}/revoke-session
POST
/v1/auth/logout
GET
/v1/auth/me
POST
/v1/auth/web-session
GET
/v1/auth/sessions
POST
/v1/auth/sessions/{id}/revoke