CSV API

The CSV API allows you to export and import records in standard CSV format.

Consult the Data Import and Export documentation for a full explanation of how records can be imported and exported in Pakk. Everything that is explained there is relevant to CSV API. If in doubt, try running CSV exports/imports from the admin panel and observe the structure of requests.

POST {root}/export/{entityname}

  • Exports a list of records in CSV format

  • Uses the familiar filtering arguments to filter down records for export

  • Allows specification of exactly which fields (columns) to export

POST {root}/import/{entityname}

  • Import a CSV file

  • In order to establish the correct format and naming for columns, the easiest approach is to first do a CSV Export and observe the column names

  • Consult the Data Import and Export documentation for more explanation around required/disallowed fields

Last updated