BD logs API

BD logs are curated business narrative entries on your workspace timeline (e.g. OKR completed, major client win). The API supports creating and listing these entries. Compliance audit trails are separate and are not created through this API.

Endpoints

GET /bd-logs, list entries (newest first)
GET /bd-logs/{logId}, get one entry
POST /bd-logs, create entry

List BD logs (GET /bd-logs)

limit, offset, pagination
createdFrom, createdTo, ISO8601 date-time range on created_at (inclusive)
entityType, kpi, okr, task, brief, team, system, goal, challenge, or swot
updateType, major or minor
includeCount, when true, response includes total, limit, and offset alongside logs

curl "https://api.elevale.app/v1/workspaces/{workspaceId}/bd-logs?limit=10&includeCount=true" \
  -H "Authorization: Bearer elv_pat_..."

Get BD log (GET /bd-logs/{logId})

Returns a single log in data.log with the same fields as list items (id, title, description, update_type, source, source_id, entity_type, created_by, created_at, etc.).

curl "https://api.elevale.app/v1/workspaces/{workspaceId}/bd-logs/{logId}" \
  -H "Authorization: Bearer elv_pat_..."

Example list response (with includeCount)

{
  "data": {
    "logs": [{ "id": "...", "title": "...", "update_type": "major", "source": "api" }],
    "total": 477,
    "limit": 10,
    "offset": 0
  },
  "meta": { "requestId": "..." }
}

Scopes and permissions

Requires bd_logs:read (GET) or bd_logs:write (POST), plus the token owner must have read/create permission on the BD Log workspace page.

Create body (POST)

title (required), short headline
description (required), narrative text
updateType (required), major or minor (timeline prominence)
entityType (optional), e.g. kpi, okr, task, system

The API accepts a simpler payload than the in-app BD log form. Fields such as entityId, changeData, custom createdAt, and relatedEntities are not available via the API.

Example request

curl -X POST "https://api.elevale.app/v1/workspaces/{workspaceId}/bd-logs" \
  -H "Authorization: Bearer elv_pat_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Q2 pipeline review completed",
    "description": "Sales team finished quarterly pipeline review with leadership.",
    "updateType": "major",
    "entityType": "system"
  }'

Example success response

{
  "data": {
    "message": "Created BD log: Q2 pipeline review completed",
    "logId": "uuid"
  },
  "meta": { "requestId": "..." }
}

API attribution

Entries created via the API are stored with source api and include change_data marking the integration (apiIntegration: true) and the token name when available.

updateType guidance

minor, routine updates, small milestones
major, significant business events you want prominent on the timeline