Developers

REST API reference

Public examples for Pro and above. Create an API key in workspace settings after you sign in. These snippets use placeholder keys.

Create an API key in API access settings.
Pass it on every request using the X-API-Key header.
Find your workspace ID from GET /v1/workspaces.

Sample request

curl "https://betterknocks.com/api/v1/workspaces" \
  -H "X-API-Key: bk_live_your_key_here"

Response

Status: 200

Response body

{
  "workspaces": [
    {
      "id": "ws_abc123",
      "name": "North Territory",
      "description": "Primary sales territory",
      "ownerId": "user_abc123",
      "isDefaultWorkspace": true,
      "logoUrl": null,
      "createdAt": "2026-01-15T08:00:00.000Z"
    }
  ]
}