Overview
The Core API Exports feature allows you to download large datasets from your Pelcro account. Exports run in the background - you request an export, and when it's ready, you receive an email with a download link.
Enterprise Feature: Exports are available exclusively for Enterprise accounts.
How It Works
- Request an export - Send a POST request specifying the data type and filters. You receive an export ID immediately.
- Wait for the email - The system processes your request in the background. When complete, you receive an email notification.
- Download your file - Use the export ID to download your CSV or ZIP file. Each file can only be downloaded once.
Example: To export all active subscriptions from January 2024, you would request a subscriptions export with date_from set to January 1st, date_to set to January 31st, and status set to active. Within a few minutes, you'll receive an email with a link to download your CSV file.
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/core/exports | List available export types |
POST | /api/v1/core/exports | Request a new export |
GET | /api/v1/core/exports/{uuid} | Download a completed export |
Important Behaviors
- Enterprise only: Exports require an enterprise-tier account. Non-enterprise accounts receive a 403.
- Async processing: Exports are queued and processed in the background. Poll the list endpoint to check status.
- One at a time: Bulk exports of the same type cannot run simultaneously.
- Date range limit: Export date ranges are restricted to 6 months maximum.
- Auto-cleanup: Downloaded export files are automatically deleted from storage after download.
- Events:
ExportRequestedandExportFailedevents are fired during processing.
Available Export Types
| Export Type | What You Get |
|---|---|
subscriptions | All subscription details including plan, status, billing cycle, and customer info |
memberships | Membership records for membership-type products |
invoices | Invoice records with line items, amounts, and payment status |
payments | Payment transactions including amount, method, and status |
refunds | Refund records with amounts and reasons |
customers | Customer profiles including name, email, and account details |
customers_metadata | Custom metadata fields you've defined for customers |
newsletters | Newsletter subscription records |
addresses | Customer shipping and billing addresses |
balance_transactions | Customer balance credits and debits |
credit_note | Credit notes issued to customers |
orders | E-commerce order records with fulfillment status |
campaign_reports | Marketing campaign performance data |
accounting | Complete monthly accounting package (11 reports in a ZIP file) |
Processing Time
Most exports complete within a few minutes. Larger exports with hundreds of thousands of records may take 15-30 minutes. You'll receive an email as soon as your export is ready.
File Retention
Export files are temporary. Each file can only be downloaded once - after you download it, the file is automatically deleted. If you need the data again, simply request a new export.