Skip to main content
GET
Export a batch (ideas-json)

Authorizations

x-preuve-key
string
header
required

API key id. Requests are additionally signed with x-preuve-timestamp, x-preuve-nonce, and x-preuve-signature (HMAC-SHA256) - see the Authentication guide.

Path Parameters

batchId
string<uuid>
required

Batch id returned by create.

Query Parameters

format
enum<string>
default:ideas-json
Available options:
ideas-json

Response

The batch export payload.

schemaVersion
integer
exportType
enum<string>
Available options:
batch
exportedAt
string<date-time>
counts
object
ideas
object[]
omittedItems
object[]

Every incomplete item with the reason it was skipped.