Skip to main content
GET
List Partners

Authorizations

Authorization
string
header
required

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

Query Parameters

name
string
page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
limit
integer
default:50

The page size

Required range: 1 <= x <= 200
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
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

Response

Successful response

data
object[]
current_page
integer
default:0

The current page.

total_records
integer
default:0

Total number of records.

next_page
integer | null

The next page, if one exists.