Skip to main content
GET
Get Partners

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:0

Page number, 0 indexed.

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

Number of records per page.

Required range: 1 <= x <= 500
sort_by
enum<string>
default:total_overdue
Available options:
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
enum<string>
default:desc
Available options:
asc,
desc
search
string | null
group_id
string | null
with_overdue_invoices
boolean | null
has_outreach
boolean | null
outreach_paused
boolean | null
segment_id
string | null

Filter by customer segment ID.

segment_exclusive
boolean
default:true

Exclude partners matching higher-priority segments.

business_unit_id__in
string[] | null

Filter by business unit IDs

assignee_id__in
string[] | null
assignee_id__nin
string[] | null
billing_address__country__in
string[] | null
dunning_state_id__in
string[] | null
dunning_state_id__nin
string[] | null
invoice_balance__gte
integer | null
invoice_balance__lte
integer | null
num_open_invoices__gte
integer | null
num_open_invoices__lte
integer | null
missing_information__in
enum<string>[] | null
Available options:
primary_email,
primary_phone,
assignee,
assignee_email_linked,
disabled_email,
disabled_phone
missing_information__nin
enum<string>[] | null
Available options:
primary_email,
primary_phone,
assignee,
assignee_email_linked,
disabled_email,
disabled_phone
missing_information__eq
enum<string>[] | null
Available options:
primary_email,
primary_phone,
assignee,
assignee_email_linked,
disabled_email,
disabled_phone
missing_information__ne
enum<string>[] | null
Available options:
primary_email,
primary_phone,
assignee,
assignee_email_linked,
disabled_email,
disabled_phone
custom_fields
string | null

Response

Successful Response

data
PartnerListSummary · object[]
required

The list of records.

current_page
integer
default:0
required

The current page.

total_records
integer | null
required

Total number of records.

Required range: x >= 0
next_page
integer | null
required

The next page number, if one exists.