Skip to main content
Use the export service when you need a complete result set as a file instead of paginated API responses. The export service is asynchronous: you create a job, poll it, then download the file when it is complete.
Export service IDs are not fixed. Each environment assigns them when the catalog is seeded, so always call list_export_services first and use the id returned there. Match the service by stable fields such as name, alias, or slug.

When to use it

Use this flow for result sets that appear in the export catalog. The source guide tells you which result identifier to pass in args — for example a search ID, task ID, analysis ID, or another source-specific key. Do not use this for original leak source files. Those use the separate Download leak files flow and are limited to files under 10 MB. Also check the source guide for specialized export endpoints: Filtered credentials, monitoring matches, Telegram, and reports each document their own file flow.

Export a result set

1

List export services

list_export_services returns the export catalog.
Each entry carries the fields you need for the next step:
Read allowed_types before choosing a format. Read args before creating the export; those parameters are different per service.
2

Create the export

create_export starts the job. Pass:
  • service — the service id from the catalog.
  • type — one of the service’s allowed_types, usually json, csv, or xlsx.
  • args — the service-specific arguments from the catalog.
The response includes the export id, service, type, status, created_at, and organization.
3

Poll until complete

get_export reads the job by query parameter id.
Status moves through:
4

Download

download_export returns the file once the job is COMPLETE.

List previous exports

list_exports returns your export jobs. Filter by status, type, services, from_date, and to_date.
Use this when you need to pick up an export created earlier, or when a workflow creates exports on behalf of several users in the same organization.

Common mistakes