Authentication

The Baselyne API uses API keys to authenticate all requests. Every request must include your API key in the Authorization header.

Making your first request

curl https://baselyne.ca/api/v1/customers \ -H "Authorization: Bearer bsl_live_your_api_key_here"

Getting an API key

  1. Go to Settings → Developer API
  2. Click Create new key
  3. Give your key a name and select the required scopes
  4. Copy the key — it is shown only once

Environments

PrefixEnvironmentUse for
bsl_live_LiveProduction integrations against real data
bsl_test_TestDevelopment and testing

Scopes

API keys are scoped to specific resources. When creating a key, select only the scopes your integration needs.

ScopeAccess
customers:readList and read customers
customers:writeCreate and update customers
jobs:readList and read jobs
jobs:writeCreate and update jobs
invoices:readList and read invoices
invoices:writeCreate and update invoices
employees:readList and read employees
intelligence:readRead churn scores, capacity forecasts
webhooks:writeRegister webhook endpoints

Error responses

// Missing or invalid key (401): { "data": null, "meta": null, "error": { "code": "UNAUTHORIZED", "message": "Invalid or missing API key." } } // Missing scope (403): { "data": null, "meta": null, "error": { "code": "INSUFFICIENT_SCOPE", "message": "This endpoint requires the 'customers:read' scope." } }