Compliance exports

Get a compliance export

Changed on

One export: its status (queued, building, ready, failed), progress while it builds ("Reading records … n of N tasks"), and once ready its counts, missing fields (counts), manifest hash, file_url and expires_at. Only the person who asked for it may read it. First-party web and mobile only. Not cached.

get/compliance-exports/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/compliance-exports/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The export.

Response

The export.

Example response

{
  "export": {
    "zip_name": "purplegrain-compliance-2026-10-20T0915-hillcrest.zip",
    "file_url": "/api/v1/compliance-exports/7f3c…/file?sig=eyJfcmFpbHMiOn…--4b1d…"
  }
}

Changes

  • e285768a8f1dRevision 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)

  • 92f716edc989Revision 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)