Skip to main content
GET
Retrieve a partner

Autorisations

Authorization
string
header
requis

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

partner:basic:read
referral:basic:read

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

The authenticated partner's user ID, prefixed user_, or me. Other users' profiles are not accessible.

Paramètres de requête

account_id
string

Return payout_rates for this business, prefixed biz_, instead of the caller's own: the business's rate rows, else the platform defaults. Requires company:basic:read on that business, which every team member holds. The rest of the profile stays the caller's.

Réponse

partner retrieved

account_id
string | null
requis

The business whose payout_rates these are, prefixed biz_, when the request sent account_id. null when the rates are the caller's own.

Exemple:

null

certification_complete
boolean
requis

Whether the user finished the partner certification course: every visible quiz and knowledge check has a passing result, or, when the course has none, every visible lesson is marked completed.

Exemple:

false

joined_at
string | null
requis

When the user joined the partner program, as an ISO 8601 timestamp. Null when they have not joined.

Exemple:

"2026-01-01T12:00:00.000Z"

payout_rates
object[]
requis
referred_businesses_count
integer
requis

Number of active first-tier business referrals attributed to the partner, excluding deleted businesses.

Exemple:

1

referring_partner
object | null
requis
obsolète

The user who referred this user. Deprecated: no longer populated. Always null. DEPRECATED: No longer populated. Always null.

user
object
requis

The authenticated partner's public profile.

verification_waitlist_joined
boolean
requis

Whether the user has a pending or approved personal entry on the Verified Partner waitlist.

Exemple:

false

whop_partner_verified_at
string | null
requis

When the user became a verified Whop Partner, as an ISO 8601 timestamp. null if not verified.

Exemple:

null