Orbit API

Verifies a key and returns the workspace it belongs to. Use it as a connection test.

curl https://orbitdao.io/api/public/v1/me -H "Authorization: Bearer $ORBIT_API_KEY"

{ "data": { "workspace": { "id": "...", "name": "Orbit", "slug": "orbit" },
            "api_key": { "id": "...", "name": "Zapier" }, "api_version": "v1" } }

Lists contacts. Filters: status, owner_id, tag, hot_lead, q (name, email or company), updated_since.

curl "https://orbitdao.io/api/public/v1/contacts?status=in_conversation&limit=50" \
  -H "Authorization: Bearer $ORBIT_API_KEY"

Creates a contact. name is required. If email matches an existing contact the record is updated instead and deduplicated: true is returned — send "deduplicate": false to force a new record.

Writable fields: name, email, phone, company, title, country, city, website, linkedin_url, industry, notes, status, lead_source, source, deal_value, deal_probability, expected_close_date, deal_type, tags, contact_type, hot_lead, priority.

Fetch, update or delete a single contact. PATCH accepts any writable field above; changes emit the matching contact.* webhook events.

curl -X PATCH https://orbitdao.io/api/public/v1/contacts/$ID \
  -H "Authorization: Bearer $ORBIT_API_KEY" -H "Content-Type: application/json" \
  -d '{ "status": "negotiation", "deal_value": 24000 }'

Reads the note timeline for a contact, or appends one. POST body: content (required), note_type.

The pipeline view. Orbit tracks the opportunity on the contact record, so a deal id is the contact id. Filters: stage, open=true (excludes won and lost), min_value, updated_since. Responses include a summary.total_value.

Reads or updates a single opportunity using deal vocabulary: stage, value, probability, expected_close_date, deal_type, hot_lead.

The workspace's configured stages, in order — use it to build a board without hard-coding stage keys.

Lists or creates tasks. Filters: status (todo, in_progress, blocked, done), priority (low, medium, high, urgent), assignee_id, contact_id, due_before, q.

Writable fields: title (required), description, status, priority, due_date, assignee_id, contact_id, goal_id, tags, estimated_minutes, logged_minutes, priority_star, project_key.

Single task read, update and delete. Setting status to done emits task.completed.

The machine-readable catalogue of every event Orbit can emit, grouped by object — the same list documented on the webhooks page.

Creates a contact in the workspace that owns the API key, then fires the lead.received and contact.created webhook events.

Accepts application/json or application/x-www-form-urlencoded (for direct HTML form posts). CORS is open, so it can be called from the browser.

Body: name (required), email, phone, company, title, country, linkedin_url, lead_source, notes, deal_value, tags (array or comma-separated string, max 20).

curl -X POST https://orbitdao.io/api/public/leads \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ada Lovelace",
    "email": "ada@example.com",
    "company": "Analytical Engines",
    "lead_source": "Website form",
    "deal_value": 12000,
    "tags": ["inbound", "enterprise"]
  }'

# 201 Created
{ "ok": true, "contact_id": "0f0b1f2c-..." }

Keyless variant for embedded forms. The source key identifies a lead source configured under Lead Sync, so submissions are attributed automatically. Same body fields as above; intended for public forms where an API key cannot be kept secret.

Sends a message to the Beam AI chatbot and returns its reply. Bearer-authenticated with a Beam key.

Body: message (required, ≤4000 chars), conversationId (UUID, optional — omit to start a new conversation), visitor (name, email, phone).

curl -X POST https://orbitdao.io/api/public/beam/v1/message \
  -H "Authorization: Bearer $BEAM_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "message": "Do you integrate with Gmail?" }'

Lists Beam conversations for the workspace, newest first. Bearer-authenticated with a Beam key.

Lists leads captured by Beam. Bearer-authenticated with a Beam key.

The Beam embed script. Drop it into any site to render the chat widget; no key is exposed to the browser beyond the public workspace identifier.

<script src="https://orbitdao.io/beam.js" data-orbit-tenant="your-workspace" async></script>