Data Export

Get the status / download URL of an export

Changed on

Poll an export started by POST /v2/data-export. While it runs the status is processing; on success the result carries a short-lived presigned download_url; on failure the error explains why (e.g. the org is too large for the self-service export). Only exports of your own organization are visible.

get/v2/data-export/{task_id}

Request

  • Base URL
    https://api.permit.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

task_idstring required

The export task id from the POST response

Response

Successful Response

task_idstring required

The unique id of the task.

status'processing' | 'success' | 'failure' | 'cancelled' required

An enumeration.

Changes