BuzzMeBro Me API

openapi: 3.2.0
info:
  title: BuzzMeBro partner Me API
  version: 1.0.0
  description: 'BuzzMeBro partners (front desk and concierge staff, property managers, condo boards, leasing agents, movers, student housing offices) share a link with renters. Every apartment that signs up through their link or code pays the partner 50% of what that apartment pays BuzzMeBro (after sales tax, refunds, chargebacks and Stripe’s fee), every month, for as long as it stays. Only money actually collected counts: nothing on signups or free months. Only direct referrals: never on friends those apartments refer. Canada only for now.


    Order: partner_program_info, then partner_apply, partner_send_code (we text the person a code; ask them to read it to you), partner_confirm_code, partner_terms_link (the PERSON opens it and accepts the terms themselves), then partner_claim_key once to receive their partner key. With the key: partner_get_links, partner_get_kit, partner_get_stats, partner_payout_link (Stripe’s own page where the PERSON adds their bank, once they have money ready), partner_rotate_key.


    Send the partner key only as "Authorization: Bearer " (REST) or in the partner_key argument (MCP), never in a URL. Never invent earnings: say only what partner_get_stats returns, and never promise income.'
  contact:
    email: support@buzzmebro.com
    url: https://buzzmebro.com/partners
  termsOfService: https://buzzmebro.com/partners/terms
servers:
- url: https://buzzmebro.com/api/partner/v1
tags:
- name: Me
paths:
  /me/links:
    get:
      operationId: partnerGetLinks
      summary: The partner’s link, code and QR
      description: Returns the partner’s share link, typed code, a QR code (SVG) and their dashboard address.
      security:
      - partnerKey: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Refused, with an error sentence.
      tags:
      - Me
  /me/kit:
    get:
      operationId: partnerGetKit
      summary: Ready-to-send messages for residents
      description: Returns ready texts, a resident email, a move-in text and email to forward to new tenants, desk card and move-in insert wording with the partner’s link, links to the partner’s printable move-in package (move-in insert and QR card PDFs with their own QR and code), plus the house rules for sharing (honest words only, no pressure, never ask residents for phone numbers or door codes).
      security:
      - partnerKey: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Refused, with an error sentence.
      tags:
      - Me
  /me/stats:
    get:
      operationId: partnerGetStats
      summary: The partner’s numbers
      description: Returns status, visits, signups, free months, paying apartments, collected revenue, earnings by state (on hold, ready, paid, reversed), the share ledger (apartments as codes only, never names or addresses) and payout history. Quote only these numbers.
      security:
      - partnerKey: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Refused, with an error sentence.
      tags:
      - Me
  /me/payout-link:
    post:
      operationId: partnerPayoutLink
      summary: Link for the person to add their bank on Stripe
      description: 'Returns a one-time link to a BuzzMeBro page that sends the person to Stripe’s own secure page, where THEY confirm their identity and add their bank. You never see or type bank details. Payouts start once they have at least $25 ready. First-time setup only: once payouts work, payout changes are made by the partner on their signed-in dashboard. The partner gets a text whenever this link is made.'
      security:
      - partnerKey: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Refused, with an error sentence.
      tags:
      - Me
  /me/sublinks:
    get:
      operationId: partnerListSublinks
      summary: The partner’s tracked links
      description: Lists the extra tracked links (one per location, building or staff member) with each one’s visits, apartments and earnings. Every apartment and every dollar rolls up to the partner.
      security:
      - partnerKey: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Refused, with an error sentence.
      tags:
      - Me
    post:
      operationId: partnerCreateSublink
      summary: Add a tracked link
      description: Adds a tracked link with its own code for one location, building or staff member (up to 50). Renters who use it count for this partner, with the same two-months-free perk.
      security:
      - partnerKey: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Refused, with an error sentence.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  minLength: 1
                  maxLength: 60
                  description: A name for the link, e.g. "King St location".
              required:
              - label
              additionalProperties: false
      tags:
      - Me
  /me/sublinks/{sublink_id}/disable:
    post:
      operationId: partnerDisableSublink
      summary: Switch off a tracked link
      description: 'Switches off one tracked link: its code stops bringing new apartments. Apartments it already brought stay with the partner.'
      parameters:
      - name: sublink_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      security:
      - partnerKey: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Refused, with an error sentence.
      tags:
      - Me
  /me/key/rotate:
    post:
      operationId: partnerRotateKey
      summary: Replace the partner key
      description: Revokes the current partner key and returns a new one (shown once). Use it if the key may have leaked. The partner gets a text whenever the key is replaced.
      security:
      - partnerKey: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Refused, with an error sentence.
      tags:
      - Me
components:
  securitySchemes:
    partnerKey:
      type: http
      scheme: bearer
      description: The partner key from partner_claim_key.