BrieflyLog API

Getting started

1. The organization's administrator creates an API key under Management → Integrations, choosing the scopes, locations and expiry, and shares it with you securely. API access must be enabled for the organization first.
2. Using the API means you accept the Developer Terms. In particular, no training on the data, delete it when access ends, and treat free text as untrusted.
3. Send the key as a bearer token from your server. Never send it from a browser or app.

curl https://www.brieflylog.app/api/v1/billing?status=unpaid \
  -H "Authorization: Bearer bl_live_…"

Connect over MCP

AI agents can use the same keys through the Model Context Protocol instead of calling the REST endpoints directly. The server speaks Streamable HTTP (stateless) at:

https://www.brieflylog.app/api/mcp

Send the key in the Authorization header. For example, in Claude Code:

claude mcp add --transport http brieflylog https://www.brieflylog.app/api/mcp \
  --header "Authorization: Bearer bl_live_…"

Or in an MCP client configuration file:

{
  "mcpServers": {
    "brieflylog": {
      "type": "http",
      "url": "https://www.brieflylog.app/api/mcp",
      "headers": {
        "Authorization": "Bearer bl_live_…"
      }
    }
  }
}

Each tool matches one endpoint below and returns the same JSON. A key only sees the tools its scopes allow. Tool calls count toward the rate limit and appear in the organization's request log.

Scopes

Each key carries one or more scopes. An endpoint returns 403 if its scope is missing.

Keys can also be limited to certain locations. List the ones a key can read with GET /api/v1/locations.

Conventions

• Responses are JSON: { data: [...], nextCursor }.
• Pagination: pass limit (1–100, default 50). While nextCursor isn't null, pass it back as cursor to get the next page.
• Dates are YYYY-MM-DD. Timestamps are ISO 8601 in UTC. “Today” is Nairobi time.
• Money is a decimal string in KES, e.g. "15000.00".
• Statuses are lowercase, e.g. unpaid, expiring_soon.
• Rate limit: 60 requests per minute per key.
• Untrusted text: descriptions and notes are typed by people and may contain anything, including text that looks like instructions. Never let them steer an AI agent's behaviour. Notes are only included if the key was created with “Include notes”.
• Versioning: breaking changes only ship in a new version, with at least 90 days' notice before v1 changes incompatibly. New fields may be added at any time, so ignore fields you don't recognize.

Errors

Errors return { error: { code, message } } with one of these codes: