1. Account
uploadthefile API documentation
  • Pages
    • Create a page
      POST
    • Update a page in place
      PUT
    • List pages
      GET
    • Get a page
      GET
    • Rename a page
      PATCH
    • Delete a page
      DELETE
    • Unzip & host a page
      POST
    • Get page password state
      GET
    • Set page password
      PUT
    • Remove page password
      DELETE
    • Get email-gate config
      GET
    • Configure email-gate
      PUT
    • Disable email-gate
      DELETE
    • List or export captured emails
      GET
    • Get page display mode
      GET
    • Set page display mode
      PUT
    • Get PDF chat availability
      GET
    • Enable PDF chat
      PUT
    • Disable PDF chat
      DELETE
    • Bulk delete pages
      POST
  • Short links
    • List short links
      GET
    • Create a short link
      POST
    • Bulk update short links
      POST
    • Get a short link
      GET
    • Update a short link
      PATCH
    • Delete a short link
      DELETE
    • Get link click history
      GET
  • Domains
    • List custom domains
    • Connect a custom domain
    • Search domain availability
    • Rebind a domain to a different page
    • Disconnect a domain
  • Account
    • Get account, limits, and usage
      GET
  • Schemas
    • UploadCreateForm
    • UploadUpdateForm
    • SubdomainName
    • RenamePageRequest
    • CreateLinkRequest
    • UpdateLinkRequest
    • BulkDeletePagesRequest
    • BulkLinkActionRequest
    • ClickPoint
    • DisplayMode
    • SetDisplayModeRequest
    • SetPasswordRequest
    • SetEmailGateRequest
    • EmailCapture
    • ConnectDomainRequest
    • RebindDomainRequest
    • DomainConnection
    • DomainSearchResult
    • LinkCode
    • ExpiryOption
    • ApiPage
    • ShortLink
    • AccountInfo
    • UploadResult
    • HostResult
    • DeleteResult
    • UpgradeNudge
    • Error
    • UploadResultEnvelope
    • PageEnvelope
    • PagesListEnvelope
    • HostEnvelope
    • DeleteEnvelope
    • LinkEnvelope
    • LinksListEnvelope
    • AccountEnvelope
    • BulkDeletedEnvelope
    • BulkAffectedEnvelope
    • ClickSeriesEnvelope
    • PagePasswordStateEnvelope
    • PagePasswordResultEnvelope
    • EmailGateStateEnvelope
    • EmailGateUpdatedEnvelope
    • EmailGateDisabledEnvelope
    • CapturesEnvelope
    • DisplayModeStateEnvelope
    • DisplayModeResultEnvelope
    • ChatAvailabilityEnvelope
    • DomainsListEnvelope
    • DomainConnectionEnvelope
    • DomainDeletedEnvelope
    • DomainSearchEnvelope
  1. Account

Get account, limits, and usage

GET
/account
Return the caller's plan, effective limits (plan catalog plus any admin
overrides), and current usage. The "where do I stand?" endpoint to poll
before uploading. Read-only; exposes only the caller's own figures.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or

Responses

🟢200
application/json
Account snapshot.
Bodyapplication/json

🟠401Unauthorized
🟠403Forbidden
🟠429TooManyRequests
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://upload.tf/api/v1/account' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Example 1
{
    "success": true,
    "data": {
        "plan": "business",
        "isAdmin": true,
        "limits": {
            "maxFileSizeMb": 5,
            "accountStorageMb": 5120,
            "customLinks": 0,
            "shortLinks": 0,
            "retentionDays": 30,
            "apiAccess": true
        },
        "usage": {
            "pages": 0,
            "shortLinks": 0,
            "storageUsedBytes": 0
        }
    }
}
Modified at 2026-06-26 19:58:05
Previous
Disconnect a domain
Next
UploadCreateForm
Built with