Skip to main content
GET
Retrieve a partner

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-13"

Path Parameters

id
string
required

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

Response

partner retrieved

joined_at
string | null
required

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

Example:

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

payout_rates
object[]
required
referred_businesses_count
integer
required

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

Example:

1

user
object
required

The authenticated partner's public profile.