buymeamalt.Register an application ↗

BMM CONNECT DOCUMENTATION

OAuth profile

Read a creator profile using an existing OAuth grant.

GET/api/connect/v1/me

Authentication and parameters

Send Authorization: Bearer ACCESS_TOKEN, X-BMM-Client-ID and X-BMM-API-Key. No body is required. Requires the active creator grant with profile:read.

Request and response

sh
curl "$BMM_ORIGIN/api/connect/v1/me" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-BMM-Client-ID: $BMM_CLIENT_ID" \
  -H "X-BMM-API-Key: $BMM_API_KEY"
json
{
  "creator": {
    "id": "stable-bmm-creator-id",
    "username": "builder",
    "display_name": "Builder",
    "profile_image": "",
    "profile_url": "https://buymeamalt.com/@builder",
    "support_url": "https://buymeamalt.com/@builder?bmm-partner=OPAQUE_REFERENCE",
    "earnings_shared": false
  }
}

Use id as the BMM identity; usernames can change. Render the returned support_url without rebuilding it or replacing bmm-partner with your application ID. The opaque public source identifies this approved partner/creator connection, cannot read data, and is checked again at checkout. Shared copies retain attribution; direct profile visits are unattributed. Username redirects retain the source. Group checkout attribution is outside Connect’s current scope.

Errors

400 can indicate an invalid callback or invalid/expired grant. 401 indicates credential or access failure. 403 on earnings means permission was not granted. 429 requires backoff. OAuth errors may contain error and error_description; use status and error code, not matching descriptions. Errors and recovery.

← All endpoints