Addresses1

ApiCredentials6

Asset resources1

Attachments2

Blocks3

BoundaryDrafts6

Categories2

Cities3

Clients5

Compliance exports6

Connection2

Contractors1

Documentation3

Drench records2

Fertiliser records2

Field work records2

Husbandry records2

Image uploads2

LikedContractors3

Locations1

Mobs6

OAuth11

OauthTokens4

Organization Join Links3

Organization Roles7

Organizations5

Paddocks6

Predictions1

Products1

Properties13

PropertySetupDrafts3

Public25

Services7

Sitemap5

Sowing records2

Spray records2

Subscriptions4

Tasks13

Treatment records2

Treatment register1

Users8

Compliance exports

Download a compliance export

Changed on Oct 24, 2026

The zip, as an attachment named zip_name, never cached (Cache-Control: private, no-store). 404 while the export is not ready; 410 once its file has expired (30 days). Only the person who asked for it. First-party web and mobile only.

Two ways in:

Bearer (the web app): GET /compliance-exports/{id}/file with the session's token.
Signed (a phone, or anything that opens a URL with no session): the export's file_url, which is this path with ?sig=<token>. The token names the export and its requester and works without a bearer for 15 minutes from the read that minted it; every read of the export (getComplianceExport, listComplianceExports) mints a fresh one, so read the export just before opening it. A forged, altered or another export's sig is a 401 (even beside a valid bearer); one past its 15 minutes is a 410 with code download_link_expired.

get/compliance-exports/{id}/file

Request

Base URL: https://api.purplegrain.com/api/v1
URL: https://api.purplegrain.com/api/v1/compliance-exports/{id}/file
Auth: one of:
- HTTP bearer
- none

Path parameters

idstring required

The export.

Query parameters

sigstring

The signed download token from file_url. Replaces the bearer for 15 minutes.

Response

The zip, as an attachment.

Changes

Oct 24, 2026e285768a8f1d Revision changes
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the //// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/json)
- warning
  added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)
Oct 24, 202692f716edc989 Revision changes
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property // to the response with the status (media type: application/json)
- info
  added the optional property // to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/vnd.api+json)

Operation history (4 revisions)