Create Company Export
Companies
Create Company Export
Create an asynchronous export job to generate a downloadable file of companies
POST
Create Company Export
Overview
This endpoint creates an asynchronous export job that generates a downloadable file containing company data for a specific date range. The export is processed in the background and returns a presigned download URL when complete. Use this endpoint when you need to extract large volumes of company data efficiently. For real-time needs, use the List Companies endpoint instead.When to use exports: Exports are ideal for bulk data extraction (10,000+ companies). For smaller datasets, use the paginated list endpoint.
Request Body
Required Parameters
Start date and time for exporting companies in
YYYY-MM-DD HH:MM:SS format. Exports companies created from this timestamp in your space’s timezone.Example: 2024-01-15 00:00:00End date and time for exporting companies in
YYYY-MM-DD HH:MM:SS format. Must be after start_date. Exports companies created until this timestamp in your space’s timezone.Example: 2024-01-15 23:59:59Response
Success Response (202 Accepted)
Unique identifier for the export job. Use this to check status with the Get Company Export endpoint.
Current status of the export. Will be
queued immediately after creation.Error Response
Error description explaining what went wrong
Export File Format
Completed exports are delivered as gzipped NDJSON (Newline-Delimited JSON) files. Each line contains a complete JSON object representing one company record.Example Requests
Status Codes
| Status Code | Description |
|---|---|
| 202 | Export job created and queued for processing |
| 401 | Missing or invalid API key |
| 403 | API key doesn’t have permission or subscription is inactive |
| 422 | Invalid parameters provided (check error message for details) |
| 429 | Too many requests - rate limit exceeded. See Rate Limiting |
Next Steps
After creating an export, poll the Get Company Export endpoint to check the status and retrieve the download URL when ready.Notes
- Rate Limit: This endpoint has a limit of 5 requests per minute per Space. See Rate Limiting for details.
- Processing Time: Exports typically complete within seconds to a few minutes depending on data volume
- Date Range: Specify any date range using
start_dateandend_date(interpreted in your space’s timezone) - Export Capacity: Can handle 100,000+ companies per export efficiently
- Status Checking: Use the Get Company Export endpoint to check status (30 requests/min limit)
- File Expiration: Download URLs expire after 15 minutes for security. Retrieve the file promptly after completion.
- Security: Export files use UUID-based filenames with time-limited presigned URLs to prevent unauthorized access
- Date Filtering: Companies are filtered by
created_attimestamp - only companies created within the specified date range are included