Skip to main content
POST
Create a task export job

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
promptApplicationId
string<uuid>
required
filterCriteria
Export filters · object

Date ranges are [since, until] tuples of ISO 8601 strings. As with GET /task, multiple date ranges are combined with OR, and approvedBy/createdBy are combined with OR.

options
Export options · object

Prefer the nested common/csv/json groups. The flat singleCell, includeMetadata, separator, downloadType and columnOrder fields are legacy aliases and are used only when the nested equivalent is absent.

Response

Export job created

id
string<uuid>
required
status
enum<string>
required

pending → processing → completed | failed. expired once the file has been cleaned up.

Available options:
pending,
processing,
completed,
failed,
expired
processedTasks
integer
required
hasFile
boolean
required

Whether an export file has been generated.

createdAt
string<date-time>
required
totalTasks
integer

Number of tasks matched at creation time. Omitted when unknown.

errorMessage
string

Present when status is failed.

completedAt
string<date-time>
expiresAt
string<date-time>

When the generated file stops being downloadable (24 hours after completion).