GET
Download a shared export
No sign-in needed For: Accountant, Everyone Conditions
  • The token must match a share link.
  • The link must not be revoked.
  • The link must not be expired (expiry is set when the link is created, 7 days by default, at most 30).
  • The member or agent account who created the link must still be active; links of deleted or deactivated creators are also revoked automatically.
  • The organization that owns the export must still have the accounting module.
  • The book that owns the export must still exist and be active (organization, active company or active client account) and still have accounting enabled.
  • The stored file must still exist.
  • The route is limited to 10 attempts per minute per caller; beyond that the call is refused with a throttling error.
What else happens
  • Adds one to the share’s download count and sets its last download date when the file is served.
  • Writes one entry in the shared activity log for every attempt, successful or refused, with the outcome (unknown_token, revoked, expired, creator_inactive, module_unavailable, book_missing, artifact_missing or downloaded) and the caller IP address.
  • The file is sent with no-store caching and no-referrer headers.
Part of Export and share accounting files.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

token
string
required

The secret share token returned once when the link was created (64 characters). It is the only credential of this route.

Response

200 - application/json

The response is of type object.