SettleFlow API
API ReferenceExports

List exports

GET
/exports

Returns a paginated list of your exports.

X-Api-Key<token>

Merchant API key for authentication

In: header

Query Parameters

page?integer
Range1 <= value
Default1
limit?integer
Range1 <= value <= 300
Default20
sortBy?string
order?string
Default"desc"

Value in

  • "asc"
  • "desc"
status?string

Value in

  • "pending"
  • "processing"
  • "completed"
  • "failed"
type?"payments"

Value in

  • "payments"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/exports"
{  "data": [    {      "id": "string",      "type": "payments",      "format": "csv",      "status": "pending",      "filename": "string",      "size_bytes": 0,      "row_count": 0,      "created_at": "2019-08-24T14:15:22Z",      "completed_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}