STstuut
partners

List Partners

Retrieve a list of partners with invoice stats and outreach state.

get/v2/partners

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, 0 indexed.

limitinteger

Number of records per page.

sort_by'currency' | 'email' | 'is_overdue' | 'num_open_invoices' | 'name' | 'oldest_open_invoice_due_date' | 'phone' | 'invoice_balance' | 'total_overdue' | 'last_outreach_at' | 'account_number' | 'remote_id'
sort_order'asc' | 'desc'
searchstring nullable
delimited_searchboolean
group_idstring nullable
with_overdue_invoicesboolean nullable
has_outreachboolean nullable
outreach_pausedboolean nullable
on_holdboolean nullable

Filter by whether the partner is on an open-ended manual or integration pause.

on_payment_planboolean nullable

Filter by whether the partner has an active payment plan.

segment_idstring nullable

Filter by customer segment ID.

segment_exclusiveboolean

Deprecated and ignored; the segment filter now includes every matching partner.

business_unit_id__instring[] nullable

Filter by business unit IDs

assignee_id__instring[] nullable
assignee_id__ninstring[] nullable
billing_address__country__instring[] nullable
dunning_state_id__instring[] nullable
dunning_state_id__ninstring[] nullable
invoice_balance__gteinteger nullable

Minor units in the organization's base currency (forex-converted).

invoice_balance__lteinteger nullable

Minor units in the organization's base currency (forex-converted).

num_open_invoices__gteinteger nullable
num_open_invoices__lteinteger nullable
missing_information__instring[] nullable
missing_information__ninstring[] nullable
missing_information__eqstring[] nullable
missing_information__nestring[] nullable
custom_fieldsstring nullable

Response

Successful Response

current_pageinteger required

The current page.

total_recordsinteger nullable required

Total number of records.

next_pageinteger nullable required

The next page number, if one exists.

Changes

No recorded changes to this operation across all 2 revisions of this API.