Public
Shared records

Download a shared compliance export

Changed on

Public (no account): the zip behind GET /shares/{token}, as an attachment. Same 404 / 410 / 429 rules, and a successful download also stamps the share as opened. Never cached.

get/shares/{token}/file

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/shares/{token}/file
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

tokenstring required

The token from the link.

Response

The zip, as an attachment.

Changes

  • 29c5c990d66eRevision changes
    • breaking

      removed the media type application/pdf for the response with the status

    • breaking

      removed the media type text/csv for the response with the status

    • warning

      deleted the query request parameter format

    • info

      added the media type application/zip for the response with the status

    • info

      removed the non-success response with the status