Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

export_id
string<uuid>
required

The unique identifier for the export.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

subjects sideloads every subject the export covered, which is up to fifty on a bulk export.

Available options:
organisation,
requester,
subjects

Response

An individual export.

JSON API response object

data
object
required

One request for generated documents, and the artefact that answered it.

Exports are retained as evidence of what was handed over, so the record and its file both outlive any later change to the underlying data.

jsonapi
object
required
included
object[]

Related resources that can be included when an export is returned.

An organisation