API Documentation

Connect data, trigger workflows and extend your platform

Use the OneWorkspace AI API to create secure integrations, automate execution and keep business context connected.

Quickstart

Make your first authenticated request

Generate an API key from workspace settings, store it securely and send it with each request using the bearer token header.

POST/v1/workspaces/{workspace_id}/records
curl --request POST \
  --url https://api.oneworkspace.ai/v1/workspaces/ws_123/records \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "customer",
    "name": "Acme Ltd",
    "owner_id": "usr_456"
  }'

Keep API keys private

Never expose secret keys in browser code or public repositories. Use server-side environment variables and rotate credentials regularly.

01

Authentication

Use bearer tokens and scoped permissions to control application access.

02

Workspaces

Create, read and update workspace configuration and membership.

03

Records

Sync CRM, project, task and custom business records.

04

Workflow Triggers

Start automations when records, statuses or assignments change.

05

Webhooks

Receive signed event payloads when important activity occurs.

06

Errors & Limits

Handle validation errors, rate limits and safe retry behaviour.

Built for reliable integrations

API foundations that protect context and control

Scoped Access

Limit each integration to the workspaces, resources and actions it needs.

Event-Driven Workflows

Use webhooks and triggers to keep connected systems in sync.

Versioned Endpoints

Build against predictable endpoints with clear change management.

Developer support

Need help planning an integration?

Talk with our team about authentication, data mapping, webhooks and workflow architecture.

Login Book Demo