Export candidate data, results, and reports in various formats.
The Exports API allows you to export candidate data, assessment results, and analytics reports in multiple formats including CSV, JSON, and PDF.
/exports| Name | Type | Required | Description |
|---|---|---|---|
| export_type | string | Required | Type: candidates, results, applications, full_data |
| format | string | Required | Format: csv, json, xlsx, pdf |
| filters | object | Optional | Filters to apply (date range, status, etc.) |
| include_fields | array | Optional | Specific fields to include (default: all) |
const exportJob = await fetch('https://talentscreens.org/api/v1/exports', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
export_type: 'results',
format: 'csv',
filters: {
date_from: '2024-01-01',
date_to: '2024-02-01',
min_score: 70
}
})
});/exports/{export_id}{
"id": "export_yza567",
"export_type": "results",
"format": "csv",
"status": "completed",
"created_at": "2024-02-12T14:00:00Z",
"completed_at": "2024-02-12T14:02:45Z",
"record_count": 187,
"file_size_bytes": 524288,
"download_url": "https://storage.talentscreens.org/exports/...",
"expires_at": "2024-02-19T14:02:45Z"
}/exportsOnce an export is completed, use the download_url to retrieve the file. URLs are pre-signed and expire after 7 days.
curl -o export.csv "https://storage.talentscreens.org/exports/...?signature=..."Large exports may take several minutes to complete. Poll the status endpoint or use webhooks to receive completion notifications. Download URLs expire after 7 days.
| Format | Use Case | Max Records |
|---|---|---|
| CSV | Excel/database import | 50,000 |
| JSON | API integration/scripting | 10,000 |
| XLSX | Complex Excel analysis | 25,000 |
| Printable reports | 1,000 |
Was this article helpful?