Skip to main content
POST
Export Partners

Authorizations

Authorization
string
header
required

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

Headers

accept
enum<string>
default:text/csv
Available options:
t,
e,
x,
/,
c,
s,
v

Body

application/json
name
string
sort_order
enum<string>
Available options:
asc,
desc
sort_by
enum<string>
Available options:
currency,
email,
is_overdue,
num_open_invoices,
name,
oldest_open_invoice_due_date,
phone,
invoice_balance,
total_overdue,
stuut_health_score,
avg_days_past_due,
recent_payments,
last_outreach_at
assignee
any
billing_address
string
invoice_balance
string
num_open_invoices
string
requires_review
boolean

Filter partners that require review (e.g. missing primary email contact or primary phone contact.

with_overdue_invoices
boolean

Search for partners by name, email, or account number.

has_outreach
boolean
outreach_paused
boolean
email
string<email>

Response

Successful response