Introduction to the Elevale API

The Elevale REST API lets you connect external tools-automation platforms, custom scripts, and internal systems-to your workspace data. All requests are scoped to a single workspace and authenticated with a personal access token (PAT).

Base URL

Production: https://api.elevale.app/v1/workspaces/{workspaceId}

Replace {workspaceId} with your workspace UUID (found in the app URL or workspace settings). Every resource path lives under this prefix.

Legacy (debugging only): Direct Supabase edge URL is documented in the OpenAPI spec; prefer the production host above.

Health check

GET https://api.elevale.app/health - no authentication required. Returns API status.

Authentication

Send your PAT on every request:

Authorization: Bearer elv_pat_your_token_here

Create tokens in Workspace Settings → Integrations → API Access Tokens. See Personal access tokens (PATs) for full details.

Request format

Use Content-Type: application/json for POST and PATCH bodies.
Field names are camelCase (e.g. dueDate, updateType).
List endpoints support limit (max 100) and offset query parameters.

Quick test

Use the repository smoke-test script with environment variables ELEVALE_PAT and WORKSPACE_ID:

node scripts/testOpenApi.cjs
node scripts/testOpenApi.cjs --get-all
node scripts/testOpenApi.cjs --create-task
node scripts/testOpenApi.cjs --create-bd-log

Reading data

All list and detail GET endpoints support pagination, filters, and optional expansions. See Reading data (GET API) for query parameters, examples, and the recommended list-then-detail workflow.

Related guides

Reading data (GET API) - query params, filters, and examples
Personal access tokens (PATs) - create, revoke, and security
Scopes and permissions - what each scope allows
Requests, responses, and errors - response envelope and rate limits