Sign in
Partners

Retrieve a partner

Retrieves the authenticated user's public profile, enrollment date, 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. Retrieve referral URLs and promotion links from GET /partners/links.

get/partners/{id}

Response

partner retrieved

joined_atstring nullable required

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

referred_businesses_countinteger required

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

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