BMM CONNECT DOCUMENTATION

Creator profile

Read an authorised profile and its attributed support link.

GET/api/connect/hosted/me

Authentication and permissions

Send X-BMM-Client-ID and X-BMM-API-Key from your server. The API key authenticates the approved application; creator consent controls access to the account. A key alone does not authorise access to a creator.

Also send X-BMM-User-ID, derived from your authenticated server session. No request body is required. Never accept an arbitrary browser-selected user ID.

Requires an active connection with profile consent.

Request

curl -X GET "$BMM_ORIGIN/api/connect/hosted/me" \
  -H "X-BMM-Client-ID: $BMM_CLIENT_ID" \
  -H "X-BMM-API-Key: $BMM_API_KEY" \
  -H "X-BMM-User-ID: $AUTHENTICATED_PARTNER_USER_ID"

Success response

json

{
  "creator": {
    "id": "creator_456",
    "username": "builder",
    "display_name": "Builder",
    "profile_image": "",
    "environment": "live",
    "profile_url": "https://buymeamalt.com/@builder",
    "support_url": "https://buymeamalt.com/@builder?bmm-partner=OPAQUE_REFERENCE",
    "earnings_shared": false
  }
}

Use the stable id for BMM identity; usernames may change. URLs can be null when the app environment differs from BMM's payment environment. See support links. A missing or revoked connection returns 404. The SDK maps that response to null.

Errors

Status	Meaning
400	Invalid request or unavailable application.
401	Missing, invalid or rotated application credentials.
403	Application not approved, or required permission not granted.
429	Rate limited. Honour Retry-After when supplied and back off.
5xx	Temporary failure. Retry reads with backoff.

Errors contain {"error":"message"}. Do not match error text or cache private responses. Full error guide.

← All endpoints