API Reference

Exports data subject requests in the specified format.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The export format (e.g., JSON, CSV, PDF).

string
required
Body Params

The export query parameters.

boolean
array of strings | null
cols
boolean

Includes request logs, only available for single request export

boolean

Includes request attachments, only available for single request export

boolean
boolean | null
boolean | null
boolean
string | null
int32 | null
array of int32s | null
workflows
array of strings | null
states
array of strings | null
purposes
string
string
int32 | null
array of int32s | null
users
array of uuids | null
ids
array of uuids | null
tags
string | null

Comma separated list of fields

int32
1 to 2147483647

Pagination index (1 based, page 1 = 1, page 2 = 2...)

int32
1 to 9999

Size of the result page (default: 20, max 500)

int32 | null

The number of items to skip (if not provided, it will use the default page and size prop)

string | null

The field to sort

boolean

True to sort ascending

string | null

A serialized as json filter string using the JsonRuleEngine.net format
https://github.com/antoinebidault/JsonRuleEngine.Net
The filters is a query param, that's why he must be properly serialized as a json string and url encoded
e.g. {"field":"ProcessingType", "operator":"notEqual", "value": "Done"}
The field prop must match one property name of the object (present in the output results)
The operator can be equal,
notEqual,
lessThan,
lessThanInclusive,
greaterThan,
greaterThanInclusive,
in,
notIn,
contains,
doesNotContains,
isNull,
isNotNull,
isEmpty
You can combine the filters as following :
{ "separator":"Or","rules": [{"field":"ProcessingType", "operator":"notEqual", "value": "Done"},{"field":"ProcessingType", "operator":"isNull"}]}
Serialize the filter param as following:
?filters=${uriEncodeComponent(JSON.stringify({"field":"ProcessingType", "operator":"notEqual", "value": "Done"}))}

Responses
200

Export completed successfully.

400

Invalid export parameters.

403

Forbidden if the user lacks permission.

Language
Credentials
Click Try It! to start a request and see the response here!