Homepage

data_export

Last edit: Nov 10, 2026

Schedules a background export of records, users or both to CSV files, like
pos-cli data export, but with filtering and sorting. Returns the export, whose
status and file can be checked later with the data_exports query; the
generated CSV files can be imported with pos-cli data import.

data_export(
  encryption: PropertyUploadEncryptionInput
  models: DataExportModelsInput
  records: DataExportRecordsInput
  split_files: Boolean = true
  users: DataExportUsersInput
): DataExport!

Arguments

encryption (PropertyUploadEncryptionInput)

Encrypts the generated export file

models (DataExportModelsInput)

Deprecated, use records

records (DataExportRecordsInput)

Records to export, selected like in the records query, at most 5000000 per
export. Pass at least an empty object to export records; when omitted, no
records are exported

split_files (Boolean)

If true, each exported table is split into numbered files of at most 10,000
rows; if false, each table is written to a single file

users (DataExportUsersInput)

Users to export, selected like in the users query, at most 5000000 per
export. Pass at least an empty object to export users; when omitted, no
users are exported

Type

DataExport

Data export task. The export runs in a background job; query it by id until status is done, then download url

Questions?

We are always happy to help with any questions you may have.

contact us