API reference

Exports

Export of cases and evidence with a digest manifest.

List exports

GET/v1/exports

Scopes
exports:read

Parameters

FieldTypeRequired
cursorquerystringno
limitqueryintegerno

Responses

  • 200ExportList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Create an export

POST/v1/exports

Scopes
exports:write
Required header
Idempotency-Key

Request bodyExportCreate

FieldTypeRequired
fromstring (date-time)yes
tostring (date-time)yes
resource_typesarray of enum: cases, reports, audit, usageyes
purposestringyes
include_mediabooleanyes

Responses

  • 202Export
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Get an export

GET/v1/exports/{export_id}

Scopes
exports:read

Parameters

FieldTypeRequired
export_idpathstring (uuid)yes

Responses

  • 200Export
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Download an export

POST/v1/exports/{export_id}/download

Scopes
exports:download
Required header
Idempotency-Key

Parameters

FieldTypeRequired
export_idpathstring (uuid)yes

Responses

  • 200Download
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503