Create an export job

POST/api/unstable/exports

Queues a background job that exports one object definition to CSV or XLSX.

Request Body

application/json

objectHandle*string

Object handle to export.

Example"customers"

format*string

File format generated for the export.

Value in"csv" | "xlsx"

Example"csv"

limit?number

Optional maximum number of rows to include.

Example1000

updatedSince?|

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/unstable/exports" \  -H "Content-Type: application/json" \  -d '{    "objectHandle": "customers",    "format": "csv"  }'

{
  "id": "exp_123",
  "status": "queued"
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Create an export job

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`