Skip to main content
GET
/
v2
/
partners
List Partners
curl --request GET \
  --url https://api.example.com/v2/partners \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "account_number": "<string>",
      "assignee_id": "<string>",
      "currency": "ADP",
      "email": "<string>",
      "name": "<string>",
      "legal_name": "<string>",
      "phone": "<string>",
      "parent_id": "<string>",
      "remote_id": "<string>",
      "subsidiary_count": 1,
      "last_outreach_at": "2023-11-07T05:31:56Z",
      "last_outreach_to": "<string>",
      "last_outreach_channel": "email",
      "is_email_outreach_manually_paused": true,
      "is_call_outreach_manually_paused": true,
      "invoice_stats": {
        "invoice_balance": "<string>",
        "total_overdue": "<string>",
        "num_overdue_invoices": 1,
        "num_open_invoices": 1,
        "oldest_open_invoice_due_date": "2023-11-07T05:31:56Z"
      },
      "contact_completeness": {
        "has_primary_email": true,
        "has_primary_phone": true,
        "is_email_disabled": true,
        "is_phone_disabled": true
      },
      "active_dispute_count": 0,
      "terminal_dispute_count": 0,
      "object": "<string>"
    }
  ],
  "current_page": 0,
  "total_records": 1,
  "next_page": 123
}

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
​
delimited_search
boolean
default:false
​
group_id
string | null
​
with_overdue_invoices
boolean | null
​
has_outreach
boolean | null
​
outreach_paused
boolean | null

Only truthy values are supported.

​
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

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.