Developer Docs

Authorization: Bearer mk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

https://buildmyrider.com

curl -X GET "https://buildmyrider.com/api/v1/rider/MYR-AB12CD" \
  -H "Authorization: Bearer mk_your_api_key"

{
  "mrn": "MYR-AB12CD",
  "name": "Jane Smith",
  "birthday": { "month": "3", "day": "14" },
  "favorite_travel": "Beach destinations",
  "retrieved_by": "The Grand Hotel",
  "retrieved_at": "2026-04-23T10:00:00.000Z",
  "riders": [
    {
      "trip_mode": "leisure",
      "vibe": "luxury",
      "breakfast": "Avocado toast and fresh juice",
      "juice": "Green juice",
      "coffee": "Oat milk flat white",
      "activity": "Morning yoga",
      "news": "The New York Times",
      "snack": "Dark chocolate",
      "beverage": "Sparkling water",
      "liquor": "Champagne",
      "indulgence": "Long bath with candles",
      "gift": "Fresh flowers",
      "scent": "Jasmine",
      "children": null,
      "partner_mrn": "MYR-XY99ZZ",
      "share_id": "abc123"
    }
  ]
}

curl -X GET "https://buildmyrider.com/api/v1/rider/MYR-AB12CD/opportunities" \
  -H "Authorization: Bearer mk_your_api_key"

{
  "mrn": "MYR-AB12CD",
  "name": "Jane Smith",
  "trip_mode": "leisure",
  "vibe": "luxury",
  "retrieved_by": "The Grand Hotel",
  "retrieved_at": "2026-04-23T10:00:00.000Z",
  "insights": [
    {
      "icon": "🌱",
      "label": "Morning Drink",
      "value": "Plant-based preference — have oat or almond milk available."
    },
    {
      "icon": "🧘",
      "label": "Morning Ritual",
      "value": "Wellness-oriented — offer a quiet space or yoga mat on request."
    }
  ],
  "opportunities": [
    {
      "category": "Wellness",
      "icon": "🧘",
      "title": "In-room yoga or meditation session",
      "description": "Jane practices yoga. Offer a private in-room session with a local instructor.",
      "revenue_estimate": "$50–150 per session",
      "email_subject": "Your peaceful morning — in-room yoga available during your stay",
      "email_body": "Hi Jane,\n\nWe noticed you enjoy yoga..."
    }
  ],
  "opportunity_summary": {
    "total_count": 3,
    "categories": ["Wellness", "Food & Beverage", "Welcome"],
    "estimated_revenue_range": "$20–150 per stay"
  }
}

const MRN = 'MYR-AB12CD'
const API_KEY = process.env.MY_RIDER_API_KEY

const res = await fetch(
  `https://buildmyrider.com/api/v1/rider/${MRN}`,
  { headers: { Authorization: `Bearer ${API_KEY}` } }
)

if (!res.ok) {
  const { error } = await res.json()
  throw new Error(error)
}

const guest = await res.json()
console.log(guest.name, guest.riders[0].coffee)

import os, requests

MRN = "MYR-AB12CD"
API_KEY = os.environ["MY_RIDER_API_KEY"]

response = requests.get(
    f"https://buildmyrider.com/api/v1/rider/{MRN}",
    headers={"Authorization": f"Bearer {API_KEY}"}
)
response.raise_for_status()

guest = response.json()
print(guest["name"], guest["riders"][0]["coffee"])

// Run this when a reservation is confirmed
async function sendPreArrivalEmail(mrn, guestEmail) {
  const res = await fetch(
    `https://buildmyrider.com/api/v1/rider/${mrn}/opportunities`,
    { headers: { Authorization: `Bearer ${process.env.MY_RIDER_API_KEY}` } }
  )
  const data = await res.json()

  if (!data.opportunities?.length) return

  // Pick the highest-value opportunity
  const top = data.opportunities[0]

  await sendEmail({
    to: guestEmail,
    subject: top.email_subject,
    body: top.email_body,
  })
}