Skip to content

Create an export

POST
/api/v1/exports
curl --request POST \
--url https://example.com/api/v1/exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "format": "review", "parameters": { "since": "2026-04-15", "space_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "space_name": "example", "until": "2026-04-15" } }'
Media typeapplication/json
object
format
required
string
Allowed values: review resume markdown
parameters

Must be a JSON object when present; null, arrays, and scalars are rejected.

object
since
string | null format: date
space_id
string | null format: uuid
space_name
string | null
until
string | null format: date

Export created

Media typeapplication/json
object
content
string | null
created_at
required
string format: date-time
format
required
string
Allowed values: review resume markdown
id
required
string format: uuid
parameters
required

Export filters. Every field is optional; dates are YYYY-MM-DD. Unknown keys are rejected.

object
since
string | null format: date
space_id
string | null format: uuid
space_name
string | null
until
string | null format: date
status
required
string
Allowed values: pending completed failed

Example

{
"format": "review",
"status": "pending"
}

Malformed JSON

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Authentication required

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Validation failed

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}