Skip to main content
GET
/
v3
/
exports
/
{export}
Get Export
curl --request GET \
  --url https://app.plugchoice.com/api/v3/exports/{export} \
  --header 'Authorization: Bearer <token>'
{
  "uuid": "<string>",
  "type": "<string>",
  "status": "<string>",
  "filename": "<string>",
  "file_size": 123,
  "row_count": 123,
  "error_message": "<string>",
  "requested_at": "<string>",
  "completed_at": "<string>",
  "failed_at": "<string>",
  "subject": {
    "type": "<string>",
    "id": 123,
    "label": "<string>"
  },
  "download_url": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.plugchoice.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the details and current status of a specific data export.
​
export
string
required
The UUID of the export.

​
Response

​
uuid
string
The unique identifier of the export.
​
type
string
The export type.
​
status
string
The current status of the export. One of pending, processing, ready, failed, cancelled.
​
filename
string
The filename of the exported file. May be null if the export has not completed.
​
file_size
integer
The file size in bytes. May be null if the export has not completed.
​
row_count
integer
The number of rows in the export. May be null if the export has not completed.
​
error_message
string
The error message if the export failed. May be null.
​
requested_at
string
ISO 8601 timestamp of when the export was requested.
​
completed_at
string
ISO 8601 timestamp of when the export completed. May be null.
​
failed_at
string
ISO 8601 timestamp of when the export failed. May be null.
​
subject
object
The subject that was exported. May be null.
​
download_url
string
A signed URL to download the exported file. Available when status is ready. May be null.