GET
/
partners
Ruby
require 'dub'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Dub.new(
      security: Models::Shared::Security.new(
        token: 'DUB_API_KEY',
      ),
    )

req = Models::Operations::ListPartnersRequest.new(
  status: Models::Operations::ListPartnersQueryParamStatus::APPROVED,
  country: 'US',
  tenant_id: '1K0NM7HCN944PEMZ3CQPH43H8',
  include_expanded_fields: false,
  search: 'john',
  page_size: 50.0,
)

res = s.partners.list(request: req)

unless res.nil?
  # handle response
end
[
  {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "image": "<string>",
    "description": "<string>",
    "country": "<string>",
    "paypalEmail": "<string>",
    "stripeConnectId": "<string>",
    "payoutsEnabledAt": "<string>",
    "programId": "<string>",
    "groupId": "<string>",
    "partnerId": "<string>",
    "tenantId": "<string>",
    "createdAt": "<string>",
    "status": "pending",
    "links": [
      {
        "id": "<string>",
        "domain": "<string>",
        "key": "<string>",
        "shortLink": "<string>",
        "url": "<string>",
        "clicks": 0,
        "leads": 0,
        "sales": 0,
        "saleAmount": 0
      }
    ],
    "totalCommissions": 0,
    "clickRewardId": "<string>",
    "leadRewardId": "<string>",
    "saleRewardId": "<string>",
    "discountId": "<string>",
    "applicationId": "<string>",
    "bannedAt": "<string>",
    "bannedReason": "tos_violation",
    "clicks": 0,
    "leads": 0,
    "conversions": 0,
    "sales": 0,
    "saleAmount": 0,
    "netRevenue": 0,
    "website": "<string>",
    "websiteTxtRecord": "<string>",
    "websiteVerifiedAt": "<string>",
    "youtube": "<string>",
    "youtubeVerifiedAt": "<string>",
    "youtubeSubscriberCount": 123,
    "youtubeViewCount": 123,
    "twitter": "<string>",
    "twitterVerifiedAt": "<string>",
    "linkedin": "<string>",
    "linkedinVerifiedAt": "<string>",
    "instagram": "<string>",
    "instagramVerifiedAt": "<string>",
    "tiktok": "<string>",
    "tiktokVerifiedAt": "<string>"
  }
]
Partners endpoints require an Advanced plan subscription or higher.

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
status
enum<string>

A filter on the list based on the partner's status field.

Available options:
pending,
approved,
rejected,
invited,
declined,
banned,
archived
Example:

"approved"

​
country
string

A filter on the list based on the partner's country field.

Example:

"US"

​
sortBy
enum<string>
default:saleAmount

The field to sort the partners by. The default is saleAmount.

Available options:
createdAt,
clicks,
leads,
conversions,
sales,
saleAmount,
commissions,
netRevenue
Example:

"saleAmount"

​
sortOrder
enum<string>
default:desc

The sort order. The default is desc.

Available options:
asc,
desc
Example:

"desc"

​
tenantId
string

A case-sensitive filter on the list based on the partner's tenantId field. The value must be a string. Takes precedence over search.

Example:

"1K0NM7HCN944PEMZ3CQPH43H8"

​
includeExpandedFields
boolean

Whether to include stats fields on the partner (clicks, leads, conversions, sales, saleAmount, commissions, netRevenue). If false, those fields will be returned as 0.

Example:

"true"

​
search
string

A search query to filter partners by name, email, or tenantId.

Example:

"john"

​
page
number
default:1

The page number for pagination.

Required range: x > 0
Example:

1

​
pageSize
number
default:100

The number of items per page.

Required range: 0 < x <= 100
Example:

50

Response

200
application/json

The list of partners.

The response is of type object[].