REST API

    Developer Guide

    Workspace API keys for CRUD and contact ingest from your own systems.

    By Sebastian StreiffertPublished Jan 10, 2026Updated May 29, 20265 min read

    Ways to interact with Lumenbase

    REST API

    Your code

    HTTPS · JSON

    Pull contacts, companies, deals, and tasks from your CRM workspace into a data warehouse, BI tool, or internal dashboard, or push updates back from there. Post leads from marketing forms, your website, or Zapier; sync records from a billing or support system; and keep a mobile app or custom portal on the same data your team sees in Lumenbase.

    Your backends and apps call Lumenbase with a scoped workspace API key.

    Open settings
    Good for
    Backends, mobile apps, scripts
    Sign in
    Workspace API key (scoped)

    What it does

    The REST API is how your servers and apps read and write workspace CRM data. People use it for sync jobs, mobile apps, lead capture from a site, and custom integrations.

    You use a workspace API key with scopes like contacts:read and contact_ingest. You get normal JSON resources back. The Agent API is the separate path for agents (personal token, tool calls).

    How to set up

    1

    Open API settings

    Go to Settings → API (workspace admin).
    2

    Create a scoped key

    Create a key with only the scopes you need. Revoke keys when you are done with them.
    3

    Call the endpoints

    Use the public API reference for paths and examples. Prefer POST /v1-public-contacts for contact ingest. Send Idempotency-Key when a retry might repeat the same submission, and traceparent when you want request tracing.

    Full reference: API documentation

    What you get

    Auth: Workspace API key (scoped)
    Ingest: POST /v1-public-contacts
    Retries: Idempotency-Key header
    Tracing: traceparent header

    Outbound events

    Contact ingest and deal updates through the public API can emit integration events (for example contact.created, contact.updated, deal.updated). Delivery to Zapier or your HTTPS endpoints is configured in the app, not in the REST request itself.

    • Zapier: Zapier setup
    • Webhooks: Settings → Integrations → Webhooks
    HTTPS webhooks include X-Lumenbase-Signature and X-Lumenbase-Delivery-Id on each POST.
    Legacy /public-contacts returns Deprecation and Sunset headers. Use /v1-public-contacts instead.

    Other paths

    • REST: workspace key, CRUD and ingest, for your code
    • Agent API: personal token, discover_tools and execute_tool, for agents
    • App UI: sign in in the browser

    See also: Zapier setup · OpenClaw (MCP)

    All four ways to interact with Lumenbase

    Was this article helpful?