A Payload CMS plugin for import/export functionality
npm install import-export-pluginA plugin for Payload CMS that adds seamless import and export functionality for collection data. This plugin allows admins to easily upload or download data in multiple formats like CSV, JSON, and XLSX through the Payload Admin UI.
---
- Import data into collections from .csv, .json, and .xlsx files.
- Export collection data to .csv, .json, or .xlsx formats.
- Field mapping support during import to match collection fields.
- Built-in support for Payload's Admin UI.
---
Install the plugin using your package manager:
``bashUsing pnpm
pnpm add import-export-plugin
---
⚙️ Configuration
Add the plugin to your Payload config (
or payload.config.js):`ts
import { buildConfig } from 'payload';
import importExportPlugin from 'import-export-plugin';export default buildConfig({
collections: [
// Your Payload collections here
],
plugins: [
importExportPlugin({
collections: {
posts: true, // collection slug name and enable/disable import/export functionality
},
}),
],
});
`📁 File Format Support
| Format | Import | Export |
|--------|--------|--------|
|
| ✅ | ✅ |
| .xlsx`| ✅ | ✅ |---
- Payload CMS v3.29.0 or later
- Node.js v18.20.2 or v20.9.0+
- Supports modern bundlers with ESM support
---
This plugin is open source and licensed under the MIT License. See LICENSE for details.
---
Found a bug or want to improve something? Contributions are welcome!
- Open an issue
- Submit a pull request
---
- Payload Plugin Docs
- Payload GitHub
---
---
---