Skip to main content
POST
Request Export

Authorizations

Authorization
string
header
required

Owner-scoped Pro API key

Headers

Idempotency-Key
string
required

Persist this key with the exact request payload and reuse both after a timeout or confirmation; a changed payload conflicts.

Required string length: 8 - 128
Pattern: ^[-._:a-zA-Z0-9]{8,128}$

Body

application/json

Use edition_id only for edition scope and list_id only for list scope. Renewal scope requires date_basis and window_days; other scopes must omit them. Optional usdots limits the authorized selection.

scope
enum<string>
required
Available options:
edition,
catalog,
list,
renewals
date_basis
enum<string>
required if scope = renewals
Available options:
filing_anniversary,
estimated_policy_renewal,
verified_expiration,
filed_cancellation,
unknown
window_days
required if scope = renewals
edition_id
string<uuid>
required if scope = edition
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
list_id
string<uuid>
required if scope = list
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
filters
object
usdots
string[]
Maximum array length: 25000
Pattern: ^[0-9]{1,16}$

Response

Authorized operation result

data
any
required
meta
object
required
next_cursor
string