Skip to main content
POST
Queue report export

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
report_type
enum<string>
required
Available options:
bill_pay_donations_dfa,
invoicing,
cogs,
partner_summary_total,
partner_members,
younegotiate_revenue,
compliance_consumer_pii_opt_out,
compliance_consumer_disputes_no_pay,
compliance_auto_expired_deleted_accounts,
consumer_payments,
super_admin_all_accounts
Example:

"bill_pay_donations_dfa"

start_date
string<date>
required

Start date in YYYY-MM-DD format. The request cannot span more than two months.

Example:

"2026-06-01"

end_date
string<date>
required

End date in YYYY-MM-DD format. Must be on or after start_date and not in the future.

Example:

"2026-06-30"

request_id
string<uuid> | null

Optional idempotency key. Reusing it for the same Superadmin returns the original temporary export.

Example:

"1f4297dd-1466-4d50-812d-d7db59987836"

company_id

Use all_members, omit the field, or pass a company ID from the options endpoint.

Available options:
all_members
Example:

"all_members"

Response

Report export queued, or the existing idempotent export returned.

data
object
required
message
string
Example:

"Your report is being prepared."

Last modified on July 28, 2026