Retrieve a partner
Retrieves the authenticated user's public profile, enrollment date, partner verification timestamp, verification waitlist status, partner certification completion, active direct business referral count, and default payout rates. Use me or the authenticated user's own user ID; other users are not accessible. Users who have not enrolled have a null joined_at. Create and manage referral links through /partner_referral_requests.
Response
partner retrieved
Example response
{
"joined_at": "2026-01-01T12:00:00.000Z",
"payout_rates": [
{
"duration": {
"unit": "month",
"value": 600
},
"rates": [
{
"income_source": "card_interchange",
"percentage": 10
}
],
"tier": "second"
}
],
"referred_businesses_count": 1,
"user": {
"id": "user_xxxxxxxxxxxxxx",
"name": "Dana Whitfield",
"profile_picture": {
"url": "https://ui-avatars.com/api/"
},
"username": "danawhitfield"
}
}Changes
Changed in 16 of the 74 revisions of this API.34
- ○
the security scope
partner:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
- ○
the security scope
referral:basic:readwas removed from the endpoint's security schemebearerAuthapi-security-scope-removed
- ○
- ○
the security scope
partner:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
- ○
the security scope
referral:basic:readwas removed from the endpoint's security schemebearerAuthapi-security-scope-removed
- ○
- ○
the security scope
partner:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
- ○
the security scope
referral:basic:readwas removed from the endpoint's security schemebearerAuthapi-security-scope-removed
- ○
- ○
the security scope
partner:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
- ○
the security scope
referral:basic:readwas removed from the endpoint's security schemebearerAuthapi-security-scope-removed
- ○
- ○
the security scope
partner:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
- ○
the security scope
referral:basic:readwas removed from the endpoint's security schemebearerAuthapi-security-scope-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
the security scope
partner:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
- ○
the security scope
referral:basic:readwas removed from the endpoint's security schemebearerAuthapi-security-scope-removed
- ○
added the required property
to the response with the statusresponse-required-property-added
- ○
- ○
the security scope
partner:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
- ○
the security scope
referral:basic:readwas removed from the endpoint's security schemebearerAuthapi-security-scope-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
the security scope
partner:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
- ○
the security scope
referral:basic:readwas removed from the endpoint's security schemebearerAuthapi-security-scope-removed
- ○
- ○
the security scope
partner:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
- ○
the security scope
referral:basic:readwas removed from the endpoint's security schemebearerAuthapi-security-scope-removed
- ○
- ○
the security scope
partner:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
- ○
the security scope
referral:basic:readwas removed from the endpoint's security schemebearerAuthapi-security-scope-removed
- ○
Of the 74 revisions, 1 has no diff computed.