Confirm your subscription includes API access and activate the service in the Sharetru portal.
Sharetru API · v1.0
Move regulated data with code.
Automate site administration and secure file-transfer workflows across users, groups, folders, files, uploads, shares, permissions, network rules, and activity logs.
Before you start
Make your first request
The API feature must be included in your subscription. A site administrator must enable it under Settings ¿ Security ¿ Service Activation.
Generate a site API token and store it securely. Never expose it in client-side application code.
Include X-API-KEY and Accept: application/vnd.api+json.
Usage limits: Requests over the per-second limit return 429. Requests over the monthly allowance return Sharetru status 492. Both include a Retry-After header.
JSON:API conventions
Resource IDs live in data.id. Treat them as opaque strings. Collection endpoints support documented combinations of sorting, filtering, field selection, and pagination.
API reference
Explore every resource
Select an endpoint to inspect parameters, responses, and generated request examples.
No endpoints found
Try a resource name, HTTP method, path, or operation summary.