Authorizations
Default authentication mechanism
Query Parameters
A filter on the list based on the partner's status field.
pending, approved, rejected, invited, declined, deactivated, banned, archived "approved"
A filter on the list based on the partner's country field.
"US"
The field to sort the partners by. The default is saleAmount.
createdAt, clicks, leads, conversions, sales, saleAmount, totalCommissions, netRevenue "saleAmount"
The sort order. The default is desc.
asc, desc "desc"
Filter the partner list based on the partner's email. The value must be a string. Takes precedence over search.
"panic@thedis.co"
Filter the partner list based on the partner's tenantId. The value must be a string. Takes precedence over email and search.
"1K0NM7HCN944PEMZ3CQPH43H8"
A search query to filter partners by ID, name, email, or link.
"john"
Whether to include stats fields on the partner (clicks, leads, conversions, sales, saleAmount, commissions, netRevenue). If false, those fields will be returned as 0.
"true"
The page number for pagination.
x > 01
The number of items per page.
0 < x <= 10050
Response
The list of partners.
The partner's unique ID on Dub.
The partner's full legal name.
190If the partner profile type is a company, this is the partner's legal company name.
190The partner's email address. Should be a unique value across Dub.
190The partner's avatar image.
The partner's country (required for tax purposes).
The partner's PayPal email (for receiving payouts via PayPal).
The partner's Stripe Connect ID (for receiving payouts via Stripe).
The date when the partner enabled payouts.
The program's unique ID on Dub.
The partner's unique ID on Dub.
The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future.
The status of the partner's enrollment in the program.
pending, approved, rejected, invited, declined, deactivated, banned, archived The partner's referral links in this program.
The total commissions paid to the partner for their referrals. Defaults to 0 if includeExpandedFields is false.
The total number of clicks on the partner's links. Defaults to 0 if includeExpandedFields is false.
The total number of leads generated by the partner's links. Defaults to 0 if includeExpandedFields is false.
The total number of leads that converted to paying customers. Defaults to 0 if includeExpandedFields is false.
The total number of sales generated by the partner's links (includes recurring sales). Defaults to 0 if includeExpandedFields is false.
The total amount of sales (in cents) generated by the partner's links. Defaults to 0 if includeExpandedFields is false.
The total net revenue generated by the partner. Defaults to 0 if includeExpandedFields is false.
A brief description of the partner and their background.
5000The partner's group ID on Dub.
If the partner submitted an application to join the program, this is the ID of the application.
If the partner was banned from the program, this is the date of the ban.
If the partner was banned from the program, this is the reason for the ban.
tos_violation, inappropriate_content, fake_traffic, fraud, spam, brand_abuse The partner's website URL (including the https protocol).
The partner's YouTube channel username (e.g. johndoe).
The partner's Twitter username (e.g. johndoe).
The partner's LinkedIn username (e.g. johndoe).
The partner's Instagram username (e.g. johndoe).
The partner's TikTok username (e.g. johndoe).