List data exports

GET/v1/api/store/{team_slug}/data_export

v1Operation ID v1_public_data_export_index

Lists your team's exports, newest first, 15 per page: everyone's, of every type and status, including exports whose file has expired. This is the Download Center's history.

Use page to read further. The page size is fixed, and there are no filters.

Permission

Any member of the team.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Query parameters

• pageinteger

  The page to read, from 1. Each page holds 15 exports.

  • Default 1
  • Minimum 1

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (12)

  • configobject | nullrequired

    What you asked for: the dates (and date_field) as you sent them, and the columns you chose, without repeats, with schema_version. Null for customer and product exports sent without columns.

    Child fields (5)

    • columnsarray of strings

      Only when you chose columns.

    • date_fieldstring

      Sales order exports only.

    • end_datestring
    • schema_versioninteger

      Only when you chose columns.

    • start_datestring
  • created_atstring (date-time)required
  • created_byinteger | nullrequired

    A plain number for the person who created it. It is not a hash id and no operation takes it; show creator.name instead.

  • creatorobject | nullrequired

    The person who created it; null if their account was deleted. More of their account fields may appear; rely only on these.

    Child fields (3)

    • emailstring
    • idinteger

      The same plain number as created_by, not a hash id.

    • namestring
  • error_codestring | nullrequired

    Why it failed. export_generation_failed: the file could not be built; create a new export. export_attempt_expired: it did not finish in time. export_queue_failed: it could not be queued. Null unless status is failed.

    • One of: "export_generation_failed", "export_attempt_expired", "export_queue_failed"
  • expires_atstring (date-time) | nullrequired

    When the download stops working: 3 days after the export became ready. The file is then deleted; the export stays in the list but can't be downloaded.

  • file_sizeinteger | nullrequired

    File size in bytes, once ready.

  • idstringrequired

    The export id. Use it to poll and to download.

  • progressobjectrequired
    Child fields (2)

    • completedintegerrequired

      Rows written so far, not counting the header row. Updated every 500 rows; product exports update only at the end.

    • totalinteger | nullrequired

      Rows in the file, not counting the header row. Null until the export is ready: there is no total to show a percentage against while it runs.

  • statusstringrequired

    pending: queued. generating: running. ready: the file can be downloaded. failed: see error_code.

    • One of: "pending", "generating", "ready", "failed"
  • typestringrequired
    • One of: "customer_list", "sales_order_list", "invoice_list", "invoice_item_list", "payment_list", "purchase_order_list", "tax_list", "simple_product_list", "variant_product_list"
  • updated_atstring (date-time)required
• statusintegerrequired
• successbooleanrequired
• paginationobject
  Child fields (6)

  • countintegerrequired
  • currentPageintegerrequired
  • linksobject | array of anyrequired

    Links to the neighbouring pages: previous and next, each present only when that page exists. An empty list, [], when there is only one page.

    Child fields (2)

    • nextstring (uri)

      The next page.

    • previousstring (uri)

      The previous page.

  • perPageintegerrequired
  • totalintegerrequired
  • totalPagesintegerrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

• To wait for one export, poll GET /v1/api/store/{team_slug}/data_export/{id} instead of the list.

Related

• GETGet a data export/v1/api/store/{team_slug}/data_export/{id}
• GETDownload a data export's file/v1/api/store/{team_slug}/data_export/{id}/download

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/data_export' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "config": {
        "date_field": "issue_date",
        "end_date": "2026-10-31T23:59:59.999Z",
        "start_date": "2026-10-01T00:00:00Z"
      },
      "created_at": "2026-11-03T09:30:00+00:00",
      "created_by": 1001,
      "creator": {
        "email": "alex@example.com",
        "id": 1001,
        "name": "Alex Rivera"
      },
      "error_code": null,
      "expires_at": "2026-11-06T09:30:40+00:00",
      "file_size": 482113,
      "id": "G59hl28azOL22k",
      "progress": {
        "completed": 1250,
        "total": 1250
      },
      "status": "ready",
      "type": "sales_order_list",
      "updated_at": "2026-11-03T09:30:40+00:00"
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 15,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}