heybmoDocsOpen HeyBMO

API reference

Account

Your spaces, time zone, home currency and profile.

Base URL https://app.heybmo.comFor agents: llms.txt · OpenAPI

Operations

ReadPOST /api/ops/account.spaces

List your spaces

List the spaces this person can use (their personal space and any shared ones), with the one this call runs in marked current.

MCP tool account_spacesCLI heybmo account spacesLimit readSafe to retryInput

No input: send an empty object.

curl https://app.heybmo.com/api/ops/account.spaces \
  -H "Authorization: Bearer $HEYBMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{}}'
200 response
{
  "output": {
    "spaces": [
      {
        "id": "01a19279-e9c3-7c73-9705-94f082fa3a65",
        "kind": "personal",
        "name": "…",
        "current": false
      }
    ]
  }
}
ReadPOST /api/ops/account.timeZone

Get your time zone

Get this person’s time zone. Reminders and other scheduled work run at wall-clock times in it.

MCP tool account_timeZoneCLI heybmo account timeZoneLimit readSafe to retryInput

No input: send an empty object.

curl https://app.heybmo.com/api/ops/account.timeZone \
  -H "Authorization: Bearer $HEYBMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{}}'
200 response
{
  "output": {
    "timeZone": "…"
  }
}
WritePOST /api/ops/account.changeTimeZone

Change your time zone

Change this person’s time zone (an IANA name like Europe/London or Asia/Tokyo), e.g. after they move or travel. Their scheduled work moves with them and keeps its wall-clock times.

MCP tool account_changeTimeZoneCLI heybmo account changeTimeZoneLimit writeSafe to retryInput
timeZonerequiredtextUp to 64 characters.
curl https://app.heybmo.com/api/ops/account.changeTimeZone \
  -H "Authorization: Bearer $HEYBMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{"timeZone":"Europe/London"}}'
200 response
{
  "output": {
    "timeZone": "…"
  }
}
ReadPOST /api/ops/account.currency

Get your home currency

Get this person’s home currency: money they track in other currencies is totalled in it. Null until it is set.

MCP tool account_currencyCLI heybmo account currencyLimit readSafe to retryInput

No input: send an empty object.

curl https://app.heybmo.com/api/ops/account.currency \
  -H "Authorization: Bearer $HEYBMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{}}'
200 response
{
  "output": {
    "currency": "…"
  }
}
WritePOST /api/ops/account.changeCurrency

Change your home currency

Change this person’s home currency (a code like MAD, USD or EUR), e.g. after they move. Saved amounts keep their own currency; totals are worked out again in the new one with each day’s stored rate.

MCP tool account_changeCurrencyCLI heybmo account changeCurrencyLimit writeSafe to retryInput
currencyrequiredtextA three-letter currency code (ISO 4217), e.g. MAD, USD, EUR, GBP. A currency named without its country is the home currency when the names match; otherwise ask which one.
curl https://app.heybmo.com/api/ops/account.changeCurrency \
  -H "Authorization: Bearer $HEYBMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{"currency":"MAD"}}'
200 response
{
  "output": {
    "currency": "…"
  }
}
ReadPOST /api/ops/account.profile

Get your profile

Get this person’s name, the avatar they designed (null until they do) and the first day of their week.

MCP tool account_profileCLI heybmo account profileLimit readSafe to retryInput

No input: send an empty object.

curl https://app.heybmo.com/api/ops/account.profile \
  -H "Authorization: Bearer $HEYBMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{}}'
200 response
{
  "output": {
    "name": "…",
    "look": {
      "hue": 0,
      "tone": 0,
      "shape": 0
    },
    "weekStart": "monday"
  }
}
WritePOST /api/ops/account.changeProfile

Change your profile

Change this person’s name, avatar or the first day of their week. Only what is given changes. Their email and sign-in details are changed in HeyBMO’s settings, not here.

MCP tool account_changeProfileCLI heybmo account changeProfileLimit writeSafe to retryInput
nametextThe name HeyBMO calls them. Up to 120 characters.
lookobjectThe avatar the person designed.
weekStartmonday | sundayThe first day of the week in calendars.
curl https://app.heybmo.com/api/ops/account.changeProfile \
  -H "Authorization: Bearer $HEYBMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{"name":"Taha"}}'
200 response
{
  "output": {
    "name": "…",
    "look": {
      "hue": 0,
      "tone": 0,
      "shape": 0
    },
    "weekStart": "monday"
  }
}