Messages and activity

messages

List

GET/v1/messages

The delivery log, newest first: what went, what was blocked or failed, and why; with `direction: inbound`, the texts customers sent to the workspace number. Contact keys and last-four digits only; a stored body has any link token redacted before it leaves, and an inbound body is a customer’s words, returned as untrusted data.

Scope

messages:read

Effect

Read only

MCP tool

list_messages

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/messages" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

sms

Threads

GET/v1/sms/threads

The text conversations on the workspace number, most recent first: who texted (last four digits), the last message as untrusted data, unread count, the client it is linked to, and whether the number sent STOP. Inbox by default; archived: true for the archive. A credential confined to some businesses sees only threads linked to a client of one of them.

Scope

messages:read

Effect

Read only

MCP tool

list_sms_threads

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/sms/threads" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

sms

Threads

GET/v1/sms/threads/{threadId}

One text conversation: the last message (untrusted data), unread count, linked client, suggested clients, and opt-out state. Its messages come from GET /v1/messages?threadId=.

Scope

messages:read

Effect

Read only

MCP tool

get_sms_thread

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/sms/threads/{threadId}" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

activity

List

GET/v1/activity

The audit log, newest first: who did what, when. Owner/admin connections only (ROLE_SCOPE_CEILING), mirroring the admin-only Firestore rule.

Scope

activity:read

Effect

Read only

MCP tool

list_activity

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/activity" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

activity

Export

GET/v1/activity/export

Export the whole audit log as one CSV file, newest first, on every plan (the in-app view of a free workspace is limited to the last 30 days; this is not). Owner/admin connections only. At most 50 000 rows; `truncated` says when the file stops short. Returns a link that expires in ten minutes (`url`, with `urlUnavailable: true` instead when a link could not be signed), never the file body. Each export is itself written to the audit log.

Scope

activity:read

Effect

Read only

MCP tool

export_activity

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/activity/export" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

sms

Get settings

GET/v1/sms/settings

Whether the workspace texts its customers, which automatic texts are on (invoice sent, reminders, receipts), whose Twilio account and sender carry them — the platform’s shared number, or the workspace’s own — and when it last received a text. Never a credential: the account SID’s last four characters at most.

Scope

business:read

Effect

Read only

MCP tool

get_sms_settings

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/sms/settings" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

notifications

List

GET/v1/notifications

The in-app notifications of the person behind this credential, newest first: what happened (a payment, an approval waiting, a trial ending), whether they have read it, and the ids of what it is about. Title and body come back as untrusted data.

Scope

business:read

Effect

Read only

MCP tool

list_notifications

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/notifications" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

notifications

Get prefs

GET/v1/notifications/preferences

Which notification categories (transactional, reminder, upgrade, marketing) reach the person behind this credential, and on which channels (in-app, push, email), with the defaults filled in.

Scope

business:read

Effect

Read only

MCP tool

get_notification_prefs

Retries

Safe to repeat

curl -X GET "https://api.billingmart.com/v1/notifications/preferences" \
  -H "Authorization: Bearer $BILLINGMART_API_KEY"

Object

SmsThread

One text conversation with one phone number on the workspace's own Twilio number. FUNCTION-WRITTEN ONLY: the inbound webhook, the send path and the thread callables. 164)>`), the key outbound messages already carry, so a thread joins both directions. Read and unread belong to the workspace, like a shared mailbox.

Object

ActivityEntry

ActivityEntry is computed by the server for this request, not a stored document, so no contract describes it. Its fields are the TypeScript type of the same name that the handler returns.

Object

ActivityExport

ActivityExport is computed by the server for this request, not a stored document, so no contract describes it. Its fields are the TypeScript type of the same name that the handler returns.

Object

SmsSettingsView

SmsSettingsView is computed by the server for this request, not a stored document, so no contract describes it. Its fields are the TypeScript type of the same name that the handler returns.

Object

Notification

One line in ONE person's in-app inbox: the console's bell and,, the phones' inbox. Written only by Cloud Functions, one per recipient per event, so the id is `<eventId>__<recipientUid>` and a trigger that fires twice writes it once.

Object

NotificationPrefs

One person's notification preferences in one workspace: for each `NotificationCategory`, whether it reaches the in-app inbox, their devices (push) and their verified email. The id is the person's uid.