Export records as CSV | Runtype Documentation

curl -G https://api.runtype.com/v1/records/export \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d type=customer \
     --data-urlencode search=email:example@domain.com \
     --data-urlencode "name=John Doe" \
     -d distinct=email \
     --data-urlencode includeFields=id,email,created_at \
     -d product_surface_id=prod-surf-12345 \
     --data-urlencode metadata_keys=subscription,status \
     --data-urlencode metadata_keys_all=region,plan \
     -d min_fields=3 \
     -d max_fields=10 \
     --data-urlencode metadata_types=string,number \
     -d has_large_fields=false \
     -d min_size_kb=1 \
     -d max_size_kb=100 \
     --data-urlencode recordFilter=status:active

"id,email,created_at,subscription,status\n123e4567-e89b-12d3-a456-426614174000,john.doe@example.com,2023-11-01T12:00:00Z,Premium,active\n789e0123-e45b-67d8-c901-234567890abc,jane.smith@example.com,2023-10-15T08:30:00Z,Basic,active\n"

Export filtered records as a streamed CSV file. Returns 204 with no body when no records match.

Authentication

AuthorizationBearer

API key or Clerk session token

Query parameters

typestringOptional

searchstringOptional

namestringOptional

distinctstringOptional

includeFieldsstringOptional

product_surface_idstringOptional

metadata_keysstringOptional

metadata_keys_allstringOptional

min_fieldsstringOptional

max_fieldsstringOptional

metadata_typesstringOptional

has_large_fieldsstringOptional

min_size_kbstringOptional

max_size_kbstringOptional

recordFilterstringOptional

Response

CSV export of the filtered records

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error