The zerosoft API.
REST and JSON.

Link, CRM, Cal, Track, Docs, Chat, Agents and most other apps expose a REST API with JSON responses and personal keys.

Download OpenAPI 3.1 spec Connect Claude and the CLI

Base URL

https://zerosoft.ai/api/v1

Authentication

Every request needs an API key, sent as a Bearer token. For browser sessions the Google OAuth flow creates the session cookie.

Authorization: Bearer zs_live_9f3k...

Create keys in Dashboard → Settings → API keys. A key is shown exactly once: copy it and store it like a password. Each key allows 100 requests per minute.

Every key has scopes, chosen when you create it. Write scopes include read. Keys created before scopes existed have all of them. A request without the needed scope gets 403 insufficient_scope.

ScopeDescription
crm:readRead contacts, companies, deals, activities, tasks, pipelines, products, quotes, tags, templates, sequences and forms.
crm:writeCreate, update and delete CRM records, enroll in sequences, tag records (includes crm:read).
links:readList links and read their stats.
links:writeCreate, update and delete short links (includes links:read).
cal:readList event types and bookings.
cal:writeCreate and cancel bookings (includes cal:read).
agents:runSend messages to your AI agents.
robots:runList and run robots, read their runs and batches.
chat:readList Chat conversations and read their messages.
chat:writeReply, assign, resolve and reopen Chat conversations (includes chat:read).
groups:readRead WhatsApp chats, messages and tickets in Lines.
groups:writeSend WhatsApp messages and create tickets in Lines.
voice:readRead Voice dictations, meetings and transcripts.
voice:writeDictate and upload meeting audio to Voice.
track:readRead Track issues and customer requests.
track:writeCreate Track issues from customer requests (email, forms, Flow).
docs:readRead Docs pages, databases, rows and comments, and search.
docs:writeCreate and edit Docs pages, rows and comments (includes docs:read).
talk:readRead Talk channels and messages you are a member of.
talk:writePost Talk messages and create channels.
boards:readRead boards, their outline and search inside them.
boards:writeCreate boards, add stickies and shapes, rename, move and trash them.
design:readRead Design designs and their pages.
shop:readRead Shop products and orders.
shop:writeCreate Shop products.
hiring:readRead Hiring jobs and the candidates the key's owner can see.
sign:readRead Sign envelopes the key's owner can see (no files).
analytics:readRead Pulse projects, events, persons and run queries.
analytics:writeChange Pulse projects, insights, dashboards, cohorts and flags.
bi:readRead Analytics questions, dashboards and collections and run queries.
bi:writeCreate and change Analytics questions, dashboards, collections and subscriptions.
social:readRead Social posts on the accounts you can see.
social:writeCreate Social drafts and scheduled posts (with approval if you need it).
people:readRead the People directory: public profile fields only, never salary or personal data.
books:readRead Books invoices (with the Books role of the person who created the key).
books:writeCreate draft invoices in Books.
forms:readRead Forms forms and their responses, only the forms the key's owner can see.
send:readRead the documents the person can see, with their links and visits.
calls:readRead the calls the person can see, with transcripts and analysis.
calls:writeCreate and edit calls, comments and clips, and send the notetaker to a meeting.
notes:readRead notes the key's owner can see, and their tasks.
notes:writeCreate and edit the notes of the key's owner.

A key acts as the person who created it: if your workspace limits members to their own (or their team’s) CRM records, the API returns only those records.

Google OAuth sign-in

GET/api/auth/signin/google

Redirect the user to start the Google OAuth flow. After success they return to the app with a session cookie.

curl -X GET "https://zerosoft.ai/api/auth/signin/google" \
  -H "Authorization: Bearer zs_live_9f3k..."

CRM · Contacts

People and leads.

List contacts

GET/api/v1/crm/contacts

List contacts. Filters: q, page, pageSize (max 100).

Scope crm:read

NameTypeRequiredDescription
qstringNoSearch query.
lifecyclestringNoLifecycle stage (lead, sql, opportunity, customer).
pageintegerNoPage number.
pageSizeintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/crm/contacts" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "contacts": [
    {
      "id": "b1f47ac2-…",
      "first_name": "Ana",
      "last_name": "Garcia",
      "email": "ana@kallpa.co",
      "lifecycle_stage": "sql",
      "company_id": null,
      "created_at": "2026-07-18 10:04:11"
    }
  ],
  "total": 142,
  "page": 1,
  "pageSize": 25
}

Create a contact

POST/api/v1/crm/contacts

Create a new contact.

Scope crm:write

NameTypeRequiredDescription
firstNamestringNoFirst name.
lastNamestringNoLast name.
emailstringNoEmail address.
lifecycleStagestringNoLifecycle stage (lead, sql, opportunity, customer).
companyIdstringNoLinked company id.
curl -X POST "https://zerosoft.ai/api/v1/crm/contacts" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "firstName": "Ana",
  "lastName": "Garcia",
  "email": "ana@kallpa.co",
  "lifecycleStage": "sql"
}'

Request

{
  "firstName": "Ana",
  "lastName": "Garcia",
  "email": "ana@kallpa.co",
  "lifecycleStage": "sql"
}

Response · 201

{
  "id": "b1f47ac2-…",
  "first_name": "Ana",
  "last_name": "Garcia",
  "email": "ana@kallpa.co",
  "lifecycle_stage": "sql",
  "created_at": "2026-07-18 10:04:11"
}

Get a contact

GET/api/v1/crm/contacts/{id}

Read one contact by id.

Scope crm:read

NameTypeRequiredDescription
idstringYesRecord id.
curl -X GET "https://zerosoft.ai/api/v1/crm/contacts/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Update a contact

PATCH/api/v1/crm/contacts/{id}

Update any property of a contact.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
firstNamestringNoFirst name.
lifecycleStagestringNoLifecycle stage (lead, sql, opportunity, customer).
companyIdstring | nullNoPrimary company id. It's associated if needed; the previous primary stays associated. null removes the primary.
curl -X PATCH "https://zerosoft.ai/api/v1/crm/contacts/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "lifecycleStage": "opportunity"
}'

Request

{
  "lifecycleStage": "opportunity"
}

Delete a contact

DELETE/api/v1/crm/contacts/{id}

Permanently deletes the contact. Its activities stay, unlinked.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
curl -X DELETE "https://zerosoft.ai/api/v1/crm/contacts/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

CRM · Companies

Organizations and accounts.

List companies

GET/api/v1/crm/companies

List companies. Filters: q, page, pageSize.

Scope crm:read

NameTypeRequiredDescription
qstringNoSearch query.
pageintegerNoPage number.
pageSizeintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/crm/companies" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "companies": [
    {
      "id": "c7a1…",
      "name": "Norte Labs",
      "domain": "nortelabs.co",
      "industry": "Software"
    }
  ],
  "total": 40,
  "page": 1,
  "pageSize": 25
}

Create a company

POST/api/v1/crm/companies

Create a new company.

Scope crm:write

NameTypeRequiredDescription
namestringYesCompany name.
domainstringNoDomain name.
industrystringNoIndustry.
parentCompanyIdstring | nullNoParent company id (hierarchy). null makes it top-level. A company can't be its own ancestor.
curl -X POST "https://zerosoft.ai/api/v1/crm/companies" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "name": "Norte Labs",
  "domain": "nortelabs.co",
  "industry": "Software"
}'

Request

{
  "name": "Norte Labs",
  "domain": "nortelabs.co",
  "industry": "Software"
}

Get a company

GET/api/v1/crm/companies/{id}

Read one company by id.

Scope crm:read

NameTypeRequiredDescription
idstringYesRecord id.
curl -X GET "https://zerosoft.ai/api/v1/crm/companies/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Update a company

PATCH/api/v1/crm/companies/{id}

Update any property of a company.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
namestringNoCompany name.
domainstringNoDomain name.
industrystringNoIndustry.
parentCompanyIdstring | nullNoParent company id (hierarchy). null makes it top-level. A company can't be its own ancestor.
curl -X PATCH "https://zerosoft.ai/api/v1/crm/companies/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "industry": "Cloud infrastructure",
  "parentCompanyId": "{company_id}"
}'

Request

{
  "industry": "Cloud infrastructure",
  "parentCompanyId": "{company_id}"
}

Delete a company

DELETE/api/v1/crm/companies/{id}

Permanently deletes the company. Contacts keep existing without a company.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
curl -X DELETE "https://zerosoft.ai/api/v1/crm/companies/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

CRM · Deals

Opportunities and pipelines.

List deals

GET/api/v1/crm/deals

List deals. Filter: pipelineId.

Scope crm:read

NameTypeRequiredDescription
pipelineIdstringNoPipeline id.
pageintegerNoPage number.
pageSizeintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/crm/deals" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "deals": [
    {
      "id": "d9e2…",
      "name": "Norte Labs — New business",
      "amount": 24000,
      "currency": "USD",
      "stage_id": "{stage_id}"
    }
  ],
  "total": 36,
  "page": 1,
  "pageSize": 25
}

Create a deal

POST/api/v1/crm/deals

Create a deal in a pipeline stage.

Scope crm:write

NameTypeRequiredDescription
pipelineIdstringYesPipeline id.
stageIdstringYesStage id.
namestringNoDeal name.
amountnumberNoDeal amount.
currencystringNoCurrency code.
contactIdsstring[]NoIDs of the contacts to enroll (1–500).
companyIdstringNoPrimary company of the deal.
companyIdsstring[]NoOther companies to associate with the deal.
curl -X POST "https://zerosoft.ai/api/v1/crm/deals" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "pipelineId": "{pipeline_id}",
  "stageId": "{stage_id}",
  "name": "Norte Labs — New business",
  "amount": 24000,
  "currency": "USD",
  "contactIds": [
    "{contact_id}"
  ],
  "companyId": "{company_id}"
}'

Request

{
  "pipelineId": "{pipeline_id}",
  "stageId": "{stage_id}",
  "name": "Norte Labs — New business",
  "amount": 24000,
  "currency": "USD",
  "contactIds": [
    "{contact_id}"
  ],
  "companyId": "{company_id}"
}

Get a deal

GET/api/v1/crm/deals/{id}

Read one deal by id.

Scope crm:read

NameTypeRequiredDescription
idstringYesRecord id.
curl -X GET "https://zerosoft.ai/api/v1/crm/deals/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Update a deal

PATCH/api/v1/crm/deals/{id}

Update amount, stage or dates.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
namestringNoDeal name.
amountnumberNoDeal amount.
addContactIdsstring[]NoIDs of the contacts to enroll (1–500).
companyIdstringNoPrimary company of the deal.
amountOverridebooleanNotrue keeps a manual amount even with line items; false recalculates it from the line items. Editing amount on a deal with line items turns it on.
curl -X PATCH "https://zerosoft.ai/api/v1/crm/deals/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "amount": 28000,
  "closeDate": "2026-11-30",
  "amountOverride": true
}'

Request

{
  "amount": 28000,
  "closeDate": "2026-11-30",
  "amountOverride": true
}

Move a deal to a stage

POST/api/v1/crm/deals/{id}/move

Moves the deal to another stage of its pipeline. Won/lost stages close it; a lost stage needs lostReason. If the stage requires properties the deal lacks, it answers 422 missing_required with the list; send them in fields to fill them in and move in one call. Fires deal.stage_changed (and deal.won / deal.lost).

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
stageIdstringYesStage id.
lostReasonstringNoWhy it was lost (required for lost stages).
fieldsobjectNoProperties the stage requires, saved before moving: amount, closeDate, ownerId, priority, source, description and custom (custom field values by name).
curl -X POST "https://zerosoft.ai/api/v1/crm/deals/{id}/move" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "stageId": "{stage_id}"
}'

Request

{
  "stageId": "{stage_id}"
}

Delete a deal

DELETE/api/v1/crm/deals/{id}

Permanently deletes the deal.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
curl -X DELETE "https://zerosoft.ai/api/v1/crm/deals/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

CRM · Activities

The timeline of a contact, company or deal: notes, calls, meetings, emails and tasks. Meetings booked in Cal show up here automatically.

List a record's timeline

GET/api/v1/crm/activities

Most recent first. Pass exactly one of contactId, companyId or dealId.

Scope crm:read

NameTypeRequiredDescription
contactId | companyId | dealIdstringYesThe record whose timeline you want.
typenote | task | call | meeting | emailNoKind of activity.
limitintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/crm/activities" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "activities": [
    {
      "id": "a12…",
      "type": "meeting",
      "subject": "Intro call",
      "due_at": "2026-11-03 13:00:00",
      "duration_min": 30,
      "contact_id": "{contact_id}"
    }
  ]
}

Log an activity

POST/api/v1/crm/activities

Log a note, call, meeting or email on a record. Tasks have their own endpoint.

Scope crm:write

NameTypeRequiredDescription
typenote | call | meeting | emailYesKind of activity.
subjectstringNoTask subject.
bodystringNoFree text: notes, call summary, email body.
contactIdstringNoLinked contact id.
dealIdstringNoLinked deal id.
curl -X POST "https://zerosoft.ai/api/v1/crm/activities" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "type": "call",
  "subject": "Discovery call",
  "body": "Budget approved for Q1.",
  "durationMin": 25,
  "contactId": "{contact_id}"
}'

Request

{
  "type": "call",
  "subject": "Discovery call",
  "body": "Budget approved for Q1.",
  "durationMin": 25,
  "contactId": "{contact_id}"
}

CRM · Tasks

Activities and follow-ups.

List tasks

GET/api/v1/crm/tasks

List tasks. bucket: overdue, today, upcoming, done.

Scope crm:read

NameTypeRequiredDescription
bucketoverdue | today | upcoming | doneNoFilter bucket: overdue, today, upcoming, done.
pageintegerNoPage number.
pageSizeintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/crm/tasks" \
  -H "Authorization: Bearer zs_live_9f3k..."

Create a task

POST/api/v1/crm/tasks

Create a task, optionally linked to a record.

Scope crm:write

NameTypeRequiredDescription
subjectstringYesTask subject.
dueAtstring (ISO 8601)NoDue date in ISO format.
contactIdstringNoLinked contact id.
companyIdstringNoLinked company id.
dealIdstringNoLinked deal id.
curl -X POST "https://zerosoft.ai/api/v1/crm/tasks" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "subject": "Follow-up call",
  "dueAt": "2026-07-25T15:00:00Z",
  "dealId": "{deal_id}"
}'

Request

{
  "subject": "Follow-up call",
  "dueAt": "2026-07-25T15:00:00Z",
  "dealId": "{deal_id}"
}

Update a task

PATCH/api/v1/crm/tasks/{id}

Edit or complete a task.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
subjectstringNoTask subject.
donebooleanNoMark as done.
curl -X PATCH "https://zerosoft.ai/api/v1/crm/tasks/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "done": true
}'

Request

{
  "done": true
}

CRM · Pipelines & stages

Sales pipelines and their stages.

List pipelines

GET/api/v1/crm/pipelines

List pipelines with their stages.

Scope crm:read

curl -X GET "https://zerosoft.ai/api/v1/crm/pipelines" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "pipelines": [
    {
      "id": "{pipeline_id}",
      "name": "Sales",
      "position": 0,
      "stages": [
        {
          "id": "{stage_id}",
          "name": "Qualified",
          "position": 0,
          "probability": 20,
          "isWon": false,
          "isLost": false
        },
        {
          "id": "{stage_id}",
          "name": "Won",
          "position": 5,
          "probability": 100,
          "isWon": true,
          "isLost": false
        }
      ]
    }
  ]
}

CRM · Products & line items

Product catalog and the line items of each deal. While a deal has line items, its amount is the sum of their net totals (after discount, before tax) unless amountOverride is on.

List products

GET/api/v1/crm/products

Products in the catalog, active first, sorted by name.

Scope crm:read

NameTypeRequiredDescription
qstringNoSearch by name or SKU.
activebooleanNotrue = active only, false = archived only.
pageintegerNoPage number.
pageSizeintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/crm/products" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "products": [
    {
      "id": "{product_id}",
      "name": "Pro plan",
      "sku": "PRO-Y",
      "description": "",
      "price": 1200,
      "currency": "USD",
      "recurring": "yearly",
      "tax_pct": 21,
      "active": 1,
      "created_at": "2026-10-13 12:00:00",
      "updated_at": "2026-10-13 12:00:00"
    }
  ],
  "total": 12,
  "page": 1,
  "pageSize": 25
}

Create a product

POST/api/v1/crm/products

Adds a product to the catalog. Without currency it uses the workspace base currency.

Scope crm:write

NameTypeRequiredDescription
namestringYesProduct name.
skustringNoSKU or internal code.
descriptionstringNoDescription shown on line items and quotes.
pricenumberNoUnit price.
currencystringNoISO currency code (defaults to the workspace base currency).
recurringnone | monthly | yearlyNoBilling interval: none, monthly or yearly.
taxPctnumberNoTax percentage (0-100).
activebooleanNofalse archives the product (hidden from pickers).
curl -X POST "https://zerosoft.ai/api/v1/crm/products" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "name": "Pro plan",
  "sku": "PRO-Y",
  "price": 1200,
  "currency": "USD",
  "recurring": "yearly",
  "taxPct": 21
}'

Request

{
  "name": "Pro plan",
  "sku": "PRO-Y",
  "price": 1200,
  "currency": "USD",
  "recurring": "yearly",
  "taxPct": 21
}

Response · 201

{
  "id": "{product_id}",
  "name": "Pro plan",
  "sku": "PRO-Y",
  "description": "",
  "price": 1200,
  "currency": "USD",
  "recurring": "yearly",
  "tax_pct": 21,
  "active": 1,
  "created_at": "2026-10-13 12:00:00",
  "updated_at": "2026-10-13 12:00:00"
}

Get a product

GET/api/v1/crm/products/{id}

Returns one product.

Scope crm:read

NameTypeRequiredDescription
idstringYesRecord id.
curl -X GET "https://zerosoft.ai/api/v1/crm/products/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "{product_id}",
  "name": "Pro plan",
  "sku": "PRO-Y",
  "description": "",
  "price": 1200,
  "currency": "USD",
  "recurring": "yearly",
  "tax_pct": 21,
  "active": 1,
  "created_at": "2026-10-13 12:00:00",
  "updated_at": "2026-10-13 12:00:00"
}

Update a product

PATCH/api/v1/crm/products/{id}

Updates the fields you send. Line items already on deals don't change.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
pricenumberNoUnit price.
activebooleanNofalse archives the product (hidden from pickers).
curl -X PATCH "https://zerosoft.ai/api/v1/crm/products/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "price": 1320,
  "active": true
}'

Request

{
  "price": 1320,
  "active": true
}

Delete a product

DELETE/api/v1/crm/products/{id}

Deletes the product. Line items that used it stay on their deals as custom items.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
curl -X DELETE "https://zerosoft.ai/api/v1/crm/products/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

List a deal's line items

GET/api/v1/crm/deals/{id}/line-items

Line items with their computed subtotal, discount, net, tax and total, plus the deal totals. Amounts are rounded per line to the deal currency.

Scope crm:read

NameTypeRequiredDescription
idstringYesDeal id.
curl -X GET "https://zerosoft.ai/api/v1/crm/deals/{id}/line-items" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "currency": "USD",
  "items": [
    {
      "id": "{line_item_id}",
      "deal_id": "{deal_id}",
      "product_id": "{product_id}",
      "name": "Pro plan",
      "sku": "PRO-Y",
      "description": "",
      "quantity": 2,
      "unit_price": 1200,
      "discount_pct": 10,
      "tax_pct": 21,
      "recurring": "yearly",
      "position": 0,
      "subtotal": 2400,
      "discount": 240,
      "net": 2160,
      "tax": 453.6,
      "total": 2613.6,
      "created_at": "2026-10-13 12:00:00",
      "updated_at": "2026-10-13 12:00:00"
    }
  ],
  "totals": {
    "subtotal": 2400,
    "discount": 240,
    "net": 2160,
    "tax": 453.6,
    "total": 2613.6
  },
  "amountOverride": false
}

Add a line item

POST/api/v1/crm/deals/{id}/line-items

From a product (copies name, price, tax and recurrence; the price is converted to the deal currency when there is an exchange rate) or custom (name and unitPrice). Recalculates the deal amount.

Scope crm:write

NameTypeRequiredDescription
idstringYesDeal id.
productIdstringNoCatalog product id. Omit it for a custom line item.
namestringNoLine item name (required for custom items).
quantitynumberNoQuantity (can be fractional).
unitPricenumberNoUnit price in the deal currency.
discountPctnumberNoDiscount percentage (0-100).
taxPctnumberNoTax percentage (0-100).
curl -X POST "https://zerosoft.ai/api/v1/crm/deals/{id}/line-items" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "productId": "{product_id}",
  "quantity": 2,
  "discountPct": 10
}'

Request

{
  "productId": "{product_id}",
  "quantity": 2,
  "discountPct": 10
}

Response · 201

{
  "id": "{line_item_id}",
  "deal_id": "{deal_id}",
  "product_id": "{product_id}",
  "name": "Pro plan",
  "sku": "PRO-Y",
  "description": "",
  "quantity": 2,
  "unit_price": 1200,
  "discount_pct": 10,
  "tax_pct": 21,
  "recurring": "yearly",
  "position": 0,
  "subtotal": 2400,
  "discount": 240,
  "net": 2160,
  "tax": 453.6,
  "total": 2613.6,
  "created_at": "2026-10-13 12:00:00",
  "updated_at": "2026-10-13 12:00:00"
}

Update a line item

PATCH/api/v1/crm/deals/{id}/line-items/{itemId}

Updates quantity, price, discount, tax or text and recalculates the deal amount.

Scope crm:write

NameTypeRequiredDescription
idstringYesDeal id.
itemIdstringYesLine item id.
quantitynumberNoQuantity (can be fractional).
discountPctnumberNoDiscount percentage (0-100).
curl -X PATCH "https://zerosoft.ai/api/v1/crm/deals/{id}/line-items/{itemId}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "quantity": 3,
  "discountPct": 15
}'

Request

{
  "quantity": 3,
  "discountPct": 15
}

Delete a line item

DELETE/api/v1/crm/deals/{id}/line-items/{itemId}

Removes the line item and recalculates the deal amount.

Scope crm:write

NameTypeRequiredDescription
idstringYesDeal id.
itemIdstringYesLine item id.
curl -X DELETE "https://zerosoft.ai/api/v1/crm/deals/{id}/line-items/{itemId}" \
  -H "Authorization: Bearer zs_live_9f3k..."

CRM · Quotes

Quotes created from a deal's line items. Each quote keeps a snapshot of the items and has a public page (public_url) where the customer accepts or declines. Accepting fires the Flow event quote.accepted and the quote_accepted workflow trigger.

List quotes

GET/api/v1/crm/quotes

Quotes of the workspace, newest first. Sent quotes past their expiration date are returned as expired.

Scope crm:read

NameTypeRequiredDescription
dealIdstringNoOnly quotes of this deal.
statusdraft | sent | accepted | declined | expiredNoFilter by status.
pageintegerNoPage number.
pageSizeintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/crm/quotes" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "quotes": [
    {
      "id": "{quote_id}",
      "deal_id": "{deal_id}",
      "deal_name": "Norte Labs — New business",
      "number": "Q-2026-0003",
      "title": "Norte Labs — Pro plan",
      "status": "draft",
      "currency": "USD",
      "items": [
        {
          "name": "Pro plan",
          "sku": "PRO-Y",
          "description": "",
          "quantity": 2,
          "unit_price": 1200,
          "discount_pct": 10,
          "tax_pct": 21,
          "recurring": "yearly",
          "subtotal": 2400,
          "discount": 240,
          "net": 2160,
          "tax": 453.6,
          "total": 2613.6
        }
      ],
      "subtotal": 2400,
      "discount_total": 240,
      "tax_total": 453.6,
      "total": 2613.6,
      "expires_at": "2026-11-30",
      "terms": "Payment within 30 days of acceptance.",
      "notes": "",
      "sender_name": "Lucía Pérez",
      "sender_email": "lucia@zerosoft.ai",
      "sender_company": "Zerosoft",
      "recipient_name": "Ana Garcia",
      "recipient_email": "ana@nortelabs.co",
      "recipient_company": "Norte Labs",
      "sent_at": null,
      "accepted_at": null,
      "declined_at": null,
      "signer_name": "",
      "public_url": "https://zerosoft.ai/q/7Jx2kQ…",
      "created_at": "2026-10-13 12:00:00"
    }
  ],
  "total": 3,
  "page": 1,
  "pageSize": 25
}

Create a quote

POST/api/v1/crm/quotes

Creates a draft quote from the deal's current line items (the deal needs at least one). Defaults: expires in 30 days, recipient = first contact and primary company of the deal.

Scope crm:write

NameTypeRequiredDescription
dealIdstringYesDeal whose line items become the quote.
titlestringNoQuote title (defaults to the deal name).
expiresAtstringNoExpiration date, YYYY-MM-DD.
termsstringNoTerms and conditions.
notesstringNoNotes for the customer.
senderNamestringNoSender details shown on the quote.
senderEmailstringNoSender details shown on the quote.
senderCompanystringNoSender details shown on the quote.
recipientNamestringNoRecipient details (default: the deal's first contact and primary company).
recipientEmailstringNoRecipient details (default: the deal's first contact and primary company).
recipientCompanystringNoRecipient details (default: the deal's first contact and primary company).
curl -X POST "https://zerosoft.ai/api/v1/crm/quotes" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "dealId": "{deal_id}",
  "title": "Norte Labs — Pro plan",
  "expiresAt": "2026-11-30",
  "terms": "Payment within 30 days of acceptance.",
  "senderName": "Lucía Pérez",
  "senderEmail": "lucia@zerosoft.ai",
  "senderCompany": "Zerosoft"
}'

Request

{
  "dealId": "{deal_id}",
  "title": "Norte Labs — Pro plan",
  "expiresAt": "2026-11-30",
  "terms": "Payment within 30 days of acceptance.",
  "senderName": "Lucía Pérez",
  "senderEmail": "lucia@zerosoft.ai",
  "senderCompany": "Zerosoft"
}

Response · 201

{
  "id": "{quote_id}",
  "deal_id": "{deal_id}",
  "deal_name": "Norte Labs — New business",
  "number": "Q-2026-0003",
  "title": "Norte Labs — Pro plan",
  "status": "draft",
  "currency": "USD",
  "items": [
    {
      "name": "Pro plan",
      "sku": "PRO-Y",
      "description": "",
      "quantity": 2,
      "unit_price": 1200,
      "discount_pct": 10,
      "tax_pct": 21,
      "recurring": "yearly",
      "subtotal": 2400,
      "discount": 240,
      "net": 2160,
      "tax": 453.6,
      "total": 2613.6
    }
  ],
  "subtotal": 2400,
  "discount_total": 240,
  "tax_total": 453.6,
  "total": 2613.6,
  "expires_at": "2026-11-30",
  "terms": "Payment within 30 days of acceptance.",
  "notes": "",
  "sender_name": "Lucía Pérez",
  "sender_email": "lucia@zerosoft.ai",
  "sender_company": "Zerosoft",
  "recipient_name": "Ana Garcia",
  "recipient_email": "ana@nortelabs.co",
  "recipient_company": "Norte Labs",
  "sent_at": null,
  "accepted_at": null,
  "declined_at": null,
  "signer_name": "",
  "public_url": "https://zerosoft.ai/q/7Jx2kQ…",
  "created_at": "2026-10-13 12:00:00"
}

Get a quote

GET/api/v1/crm/quotes/{id}

Returns the quote with its items and public_url.

Scope crm:read

NameTypeRequiredDescription
idstringYesRecord id.
curl -X GET "https://zerosoft.ai/api/v1/crm/quotes/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "{quote_id}",
  "deal_id": "{deal_id}",
  "deal_name": "Norte Labs — New business",
  "number": "Q-2026-0003",
  "title": "Norte Labs — Pro plan",
  "status": "draft",
  "currency": "USD",
  "items": [
    {
      "name": "Pro plan",
      "sku": "PRO-Y",
      "description": "",
      "quantity": 2,
      "unit_price": 1200,
      "discount_pct": 10,
      "tax_pct": 21,
      "recurring": "yearly",
      "subtotal": 2400,
      "discount": 240,
      "net": 2160,
      "tax": 453.6,
      "total": 2613.6
    }
  ],
  "subtotal": 2400,
  "discount_total": 240,
  "tax_total": 453.6,
  "total": 2613.6,
  "expires_at": "2026-11-30",
  "terms": "Payment within 30 days of acceptance.",
  "notes": "",
  "sender_name": "Lucía Pérez",
  "sender_email": "lucia@zerosoft.ai",
  "sender_company": "Zerosoft",
  "recipient_name": "Ana Garcia",
  "recipient_email": "ana@nortelabs.co",
  "recipient_company": "Norte Labs",
  "sent_at": null,
  "accepted_at": null,
  "declined_at": null,
  "signer_name": "",
  "public_url": "https://zerosoft.ai/q/7Jx2kQ…",
  "created_at": "2026-10-13 12:00:00"
}

Update or send a quote

PATCH/api/v1/crm/quotes/{id}

Edits a draft. status: "sent" publishes the public link (draft → sent). Accepting and declining happen on the public page. Non-draft quotes answer 409 not_draft.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
statusstringNo"sent" publishes the quote.
refreshItemsbooleanNoRe-snapshot the deal's current line items (drafts only).
expiresAtstringNoExpiration date, YYYY-MM-DD.
curl -X PATCH "https://zerosoft.ai/api/v1/crm/quotes/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "refreshItems": true,
  "status": "sent"
}'

Request

{
  "refreshItems": true,
  "status": "sent"
}

CRM · Leads

Leads are prospects before they become a deal: owner, stage of the lead pipeline, contact and company. Converting a lead creates a deal from the app. Custom fields of leads go in custom; fields a key cannot edit return 403 field_readonly and hidden fields are left out of responses.

List leads

GET/api/v1/crm/leads

Leads visible to the key, newest first.

Scope crm:read

NameTypeRequiredDescription
qstringNoSearch query.
statusopen | qualified | disqualifiedNoOnly leads in stages of this type.
stageIdstringNoStage of the lead pipeline.
contactIdstringNoAssociated contact.
companyIdstringNoAssociated company.
pageintegerNoPage number.
pageSizeintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/crm/leads" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "leads": [
    {
      "id": "f1c2…",
      "owner_id": "usr_…",
      "name": "Ana Gómez",
      "stage_id": "stg_…",
      "stage_name": "Connected",
      "stage_kind": "open",
      "contact_id": "c7a1…",
      "company_id": "co_…",
      "source": "form",
      "disqualify_reason": "",
      "deal_id": null,
      "converted_at": null,
      "custom": "{}",
      "created_at": "2026-10-24 12:00:00",
      "updated_at": "2026-10-24 12:00:00"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 25
}

Create a lead

POST/api/v1/crm/leads

Needs a name, a contact or a company. Without a name it takes the contact name (or the company name). Without stageId it starts in the first open stage.

Scope crm:write

NameTypeRequiredDescription
namestringNoLead name.
contactIdstringNoAssociated contact.
companyIdstringNoAssociated company.
stageIdstringNoStage of the lead pipeline.
ownerIdstringNoWorkspace member who owns it. Defaults to the key creator.
sourcestringNoSource (organic, referral, ads, social, email, event, form, other).
customobjectNoCustom fields of leads.
curl -X POST "https://zerosoft.ai/api/v1/crm/leads" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "contactId": "{contact_id}",
  "source": "form"
}'

Request

{
  "contactId": "{contact_id}",
  "source": "form"
}

Response · 201

{
  "id": "f1c2…",
  "owner_id": "usr_…",
  "name": "Ana Gómez",
  "stage_id": "stg_…",
  "stage_name": "Connected",
  "stage_kind": "open",
  "contact_id": "c7a1…",
  "company_id": "co_…",
  "source": "form",
  "disqualify_reason": "",
  "deal_id": null,
  "converted_at": null,
  "custom": "{}",
  "created_at": "2026-10-24 12:00:00",
  "updated_at": "2026-10-24 12:00:00"
}

Get a lead

GET/api/v1/crm/leads/{id}

A lead with its stage, contact, company and deal.

Scope crm:read

NameTypeRequiredDescription
idstringYesRecord id.
curl -X GET "https://zerosoft.ai/api/v1/crm/leads/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "f1c2…",
  "owner_id": "usr_…",
  "name": "Ana Gómez",
  "stage_id": "stg_…",
  "stage_name": "Connected",
  "stage_kind": "open",
  "contact_id": "c7a1…",
  "company_id": "co_…",
  "source": "form",
  "disqualify_reason": "",
  "deal_id": null,
  "converted_at": null,
  "custom": "{}",
  "created_at": "2026-10-24 12:00:00",
  "updated_at": "2026-10-24 12:00:00"
}

Update a lead

PATCH/api/v1/crm/leads/{id}

Change the stage, owner, contact, company, source, disqualify reason or custom fields.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
stageIdstringNoStage of the lead pipeline.
disqualifyReasonstringNoWhy the lead was disqualified.
curl -X PATCH "https://zerosoft.ai/api/v1/crm/leads/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "stageId": "{stage_id}"
}'

Request

{
  "stageId": "{stage_id}"
}

Response · 200

{
  "id": "f1c2…",
  "owner_id": "usr_…",
  "name": "Ana Gómez",
  "stage_id": "stg_…",
  "stage_name": "Connected",
  "stage_kind": "open",
  "contact_id": "c7a1…",
  "company_id": "co_…",
  "source": "form",
  "disqualify_reason": "",
  "deal_id": null,
  "converted_at": null,
  "custom": "{}",
  "created_at": "2026-10-24 12:00:00",
  "updated_at": "2026-10-24 12:00:00"
}

Delete a lead

DELETE/api/v1/crm/leads/{id}

Deletes the lead and its notes and tasks. The contact, company and deal stay.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
curl -X DELETE "https://zerosoft.ai/api/v1/crm/leads/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

CRM · Custom objects

Records of the custom objects an admin defined (for example vehicles or properties). Each record has a name (the primary property), an owner and its properties in custom. Field permissions apply as in contacts.

List custom objects

GET/api/v1/crm/objects

Objects of the workspace with the properties the key can see.

Scope crm:read

curl -X GET "https://zerosoft.ai/api/v1/crm/objects" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "objects": [
    {
      "id": "obj_…",
      "slug": "vehicles",
      "singular": "Vehicle",
      "plural": "Vehicles",
      "primary_label": "Plate",
      "properties": [
        {
          "name": "model",
          "label": "Model",
          "type": "text",
          "options": [],
          "readOnly": false
        }
      ]
    }
  ]
}

List records

GET/api/v1/crm/objects/{slug}/records

Records of an object, newest first.

Scope crm:read

NameTypeRequiredDescription
slugstringYesObject slug (from List custom objects).
qstringNoSearch query.
pageintegerNoPage number.
pageSizeintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/crm/objects/{slug}/records" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "records": [
    {
      "id": "rec_…",
      "object_id": "obj_…",
      "owner_id": "usr_…",
      "name": "AB 123 CD",
      "custom": "{\"model\":\"Hilux\",\"year\":2023}",
      "created_at": "2026-10-24 12:00:00",
      "updated_at": "2026-10-24 12:00:00"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 25
}

Create a record

POST/api/v1/crm/objects/{slug}/records

Values in custom are checked against the type of each property; unknown properties are ignored.

Scope crm:write

NameTypeRequiredDescription
slugstringYesObject slug (from List custom objects).
namestringYesValue of the primary property.
ownerIdstringNoWorkspace member who owns it. Defaults to the key creator.
customobjectNoProperty values by name.
curl -X POST "https://zerosoft.ai/api/v1/crm/objects/{slug}/records" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "name": "AB 123 CD",
  "custom": {
    "model": "Hilux",
    "year": 2023
  }
}'

Request

{
  "name": "AB 123 CD",
  "custom": {
    "model": "Hilux",
    "year": 2023
  }
}

Response · 201

{
  "id": "rec_…",
  "object_id": "obj_…",
  "owner_id": "usr_…",
  "name": "AB 123 CD",
  "custom": "{\"model\":\"Hilux\",\"year\":2023}",
  "created_at": "2026-10-24 12:00:00",
  "updated_at": "2026-10-24 12:00:00"
}

Get a record

GET/api/v1/crm/objects/{slug}/records/{id}

The record with the ids of its associated contacts, companies and deals.

Scope crm:read

NameTypeRequiredDescription
slugstringYesObject slug (from List custom objects).
idstringYesRecord id.
curl -X GET "https://zerosoft.ai/api/v1/crm/objects/{slug}/records/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "rec_…",
  "object_id": "obj_…",
  "owner_id": "usr_…",
  "name": "AB 123 CD",
  "custom": "{\"model\":\"Hilux\",\"year\":2023}",
  "created_at": "2026-10-24 12:00:00",
  "updated_at": "2026-10-24 12:00:00",
  "associations": {
    "contacts": [
      "c7a1…"
    ],
    "companies": [],
    "deals": []
  }
}

Update a record

PATCH/api/v1/crm/objects/{slug}/records/{id}

Change the name, owner or properties.

Scope crm:write

NameTypeRequiredDescription
slugstringYesObject slug (from List custom objects).
idstringYesRecord id.
customobjectNoProperty values by name.
curl -X PATCH "https://zerosoft.ai/api/v1/crm/objects/{slug}/records/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "custom": {
    "model": "Hilux",
    "year": 2024
  }
}'

Request

{
  "custom": {
    "model": "Hilux",
    "year": 2024
  }
}

Response · 200

{
  "id": "rec_…",
  "object_id": "obj_…",
  "owner_id": "usr_…",
  "name": "AB 123 CD",
  "custom": "{\"model\":\"Hilux\",\"year\":2023}",
  "created_at": "2026-10-24 12:00:00",
  "updated_at": "2026-10-24 12:00:00"
}

Delete a record

DELETE/api/v1/crm/objects/{slug}/records/{id}

Deletes the record with its notes and tasks.

Scope crm:write

NameTypeRequiredDescription
slugstringYesObject slug (from List custom objects).
idstringYesRecord id.
curl -X DELETE "https://zerosoft.ai/api/v1/crm/objects/{slug}/records/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

CRM · Associations

Many-to-many links between contacts, companies and deals. A contact or deal can have several companies; one of them is primary. contact.company_id always mirrors the primary company.

List associations

GET/api/v1/crm/associations

All records linked to a contact, company or deal. Companies also return their parent and child companies.

Scope crm:read

NameTypeRequiredDescription
typecontact | company | dealYesRecord type: contact, company or deal.
idstringYesRecord id.
curl -X GET "https://zerosoft.ai/api/v1/crm/associations" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "companies": [
    {
      "id": "{company_id}",
      "name": "Norte Labs",
      "domain": "nortelabs.co",
      "is_primary": true,
      "label": "decision_maker"
    },
    {
      "id": "{company_id}",
      "name": "Norte Holding",
      "domain": "norte.com",
      "is_primary": false,
      "label": "billing"
    }
  ],
  "deals": [
    {
      "id": "{deal_id}",
      "name": "Norte Labs — New business",
      "amount": 24000,
      "currency": "USD"
    }
  ]
}

Associate two records

POST/api/v1/crm/associations

Links contact ↔ company, deal ↔ company or deal ↔ contact (in either order). primary makes the company the primary one; label only applies to contact ↔ company. Linking an existing association updates its primary flag and label.

Scope crm:write

NameTypeRequiredDescription
fromTypecontact | company | dealYesType of the first record.
fromIdstringYesId of the first record.
toTypecontact | company | dealYesType of the second record.
toIdstringYesId of the second record.
primarybooleanNoMake this the primary company of the contact or deal.
labelstringNoContact ↔ company label: employee, decision_maker, billing, champion, influencer, former_employee (or empty).
curl -X POST "https://zerosoft.ai/api/v1/crm/associations" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "fromType": "contact",
  "fromId": "{contact_id}",
  "toType": "company",
  "toId": "{company_id}",
  "primary": true,
  "label": "decision_maker"
}'

Request

{
  "fromType": "contact",
  "fromId": "{contact_id}",
  "toType": "company",
  "toId": "{company_id}",
  "primary": true,
  "label": "decision_maker"
}

Response · 201

{
  "ok": true
}

Remove an association

DELETE/api/v1/crm/associations

Unlinks two records (query parameters). Removing the primary company promotes the oldest remaining one.

Scope crm:write

NameTypeRequiredDescription
fromTypecontact | company | dealYesType of the first record.
fromIdstringYesId of the first record.
toTypecontact | company | dealYesType of the second record.
toIdstringYesId of the second record.
curl -X DELETE "https://zerosoft.ai/api/v1/crm/associations" \
  -H "Authorization: Bearer zs_live_9f3k..."

CRM · Tags

Workspace tags for contacts, companies and deals.

List tags

GET/api/v1/crm/tags

Tags with how many contacts, companies and deals use each one.

Scope crm:read

curl -X GET "https://zerosoft.ai/api/v1/crm/tags" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "tags": [
    {
      "id": "{tag_id}",
      "name": "Enterprise",
      "color": "crm",
      "created_at": "2026-10-13 12:00:00",
      "contacts": 18,
      "companies": 4,
      "deals": 7
    }
  ]
}

Create a tag

POST/api/v1/crm/tags

Names are unique per workspace (case-insensitive). A duplicate answers 409 duplicate_tag.

Scope crm:write

NameTypeRequiredDescription
namestringYesTag name (up to 60 characters).
colorstringNoColor: crm, link, cal, track, chat, docs, flow, agents, notes, board or robots.
curl -X POST "https://zerosoft.ai/api/v1/crm/tags" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "name": "Enterprise",
  "color": "crm"
}'

Request

{
  "name": "Enterprise",
  "color": "crm"
}

Response · 201

{
  "id": "{tag_id}",
  "name": "Enterprise",
  "color": "crm",
  "created_at": "2026-10-13 12:00:00"
}

Update a tag

PATCH/api/v1/crm/tags/{id}

Renames the tag or changes its color.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
namestringNoTag name (up to 60 characters).
colorstringNoColor: crm, link, cal, track, chat, docs, flow, agents, notes, board or robots.
curl -X PATCH "https://zerosoft.ai/api/v1/crm/tags/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "color": "cal"
}'

Request

{
  "color": "cal"
}

Delete a tag

DELETE/api/v1/crm/tags/{id}

Deletes the tag and removes it from every record.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
curl -X DELETE "https://zerosoft.ai/api/v1/crm/tags/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Tag or untag records

POST/api/v1/crm/tags/{id}/records

Adds or removes the tag on up to 1000 records. Ids from other workspaces are ignored. Returns how many records changed.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
entitycontact | company | dealYesRecord type: contact, company or deal.
idsstring[]YesRecord ids.
actionadd | removeYesadd or remove.
curl -X POST "https://zerosoft.ai/api/v1/crm/tags/{id}/records" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "entity": "contact",
  "ids": [
    "{contact_id}"
  ],
  "action": "add"
}'

Request

{
  "entity": "contact",
  "ids": [
    "{contact_id}"
  ],
  "action": "add"
}

Response · 200

{
  "changed": 1
}

CRM · Forms

Lead capture forms and their submissions. Each submission also creates or updates a contact and logs a "Form submitted" activity.

List forms

GET/api/v1/crm/forms

Forms newest first, with status, response and partial counts, last response and who can open them.

Scope crm:read

curl -X GET "https://zerosoft.ai/api/v1/crm/forms" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "forms": [
    {
      "id": "{form_id}",
      "name": "Contact us",
      "key": "contact-us",
      "slug": "contact-us",
      "token": "a1b2c3d4e5f6a7b8c9d0",
      "status": "active",
      "fields": [
        {
          "id": "email",
          "type": "email",
          "label": "Email",
          "property": "email",
          "required": true
        }
      ],
      "submission_count": 42
    }
  ]
}

List form submissions

GET/api/v1/crm/forms/{id}/submissions

Submissions of a form, newest first, with the submitted values, UTM parameters and the linked contact.

Scope crm:read

NameTypeRequiredDescription
idstringYesRecord id.
pageintegerNoPage number.
pageSizeintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/crm/forms/{id}/submissions" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "submissions": [
    {
      "id": "{submission_id}",
      "formId": "{form_id}",
      "contactId": "{contact_id}",
      "contactCreated": true,
      "values": {
        "email": "ana@kallpa.co",
        "first_name": "Ana"
      },
      "utm": {
        "utm_source": "google",
        "utm_campaign": "spring"
      },
      "pageUrl": "https://kallpa.co/pricing?utm_source=google",
      "referrer": "",
      "createdAt": "2026-10-13 14:02:11"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 25
}

CRM · Email templates & sequences

Shared email templates and snippets, and multi-step sales sequences. Sequence emails are sent from the sender's connected Gmail; steps run on the hourly scheduler.

List email templates

GET/api/v1/crm/email-templates

Templates and snippets shared in the workspace. Variables go between double curly braces (contact.first_name, contact.company, deal.name, owner.first_name, contact.custom.x), with an optional fallback after a pipe.

Scope crm:read

NameTypeRequiredDescription
kindtemplate | snippetNoFilter by kind: template or snippet.
curl -X GET "https://zerosoft.ai/api/v1/crm/email-templates" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "templates": [
    {
      "id": "{template_id}",
      "kind": "template",
      "name": "Intro",
      "subject": "Quick question, {{contact.first_name}}",
      "body": "Hi {{contact.first_name | there}}, I saw {{contact.company}} is hiring…",
      "created_by": "u_123",
      "created_at": "2026-10-13 12:00:00",
      "updated_at": "2026-10-13 12:00:00"
    }
  ]
}

Get an email template

GET/api/v1/crm/email-templates/{id}

Returns one template or snippet.

Scope crm:read

NameTypeRequiredDescription
idstringYesRecord id.
curl -X GET "https://zerosoft.ai/api/v1/crm/email-templates/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

List sequences

GET/api/v1/crm/sequences

Sequences with their number of steps and enrollments.

Scope crm:read

curl -X GET "https://zerosoft.ai/api/v1/crm/sequences" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "sequences": [
    {
      "id": "{sequence_id}",
      "name": "Outbound — 3 touches",
      "timezone": "America/Argentina/Buenos_Aires",
      "window_start": "09:00",
      "window_end": "17:00",
      "business_days": 1,
      "step_count": 4,
      "active_count": 12,
      "total_count": 40
    }
  ]
}

Enroll contacts in a sequence

POST/api/v1/crm/sequences/{id}/enroll

Enrolls up to 500 contacts. Contacts that are already enrolled, unsubscribed or without email are returned in skipped. The sender needs Gmail connected with send permission.

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
contactIdsstring[]YesIDs of the contacts to enroll (1–500).
senderIdstringNoWorkspace member whose Gmail sends the emails. Defaults to the contact owner, then the sequence creator.
curl -X POST "https://zerosoft.ai/api/v1/crm/sequences/{id}/enroll" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "contactIds": [
    "{contact_id}"
  ]
}'

Request

{
  "contactIds": [
    "{contact_id}"
  ]
}

Response · 201

{
  "enrolled": [
    "{contact_id}"
  ],
  "skipped": []
}

Unenroll a contact

POST/api/v1/crm/sequences/{id}/unenroll

Removes the contact from the sequence (status exited, reason manual).

Scope crm:write

NameTypeRequiredDescription
idstringYesRecord id.
contactIdstringYesLinked contact id.
curl -X POST "https://zerosoft.ai/api/v1/crm/sequences/{id}/unenroll" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "contactId": "{contact_id}"
}'

Request

{
  "contactId": "{contact_id}"
}

Response · 200

{
  "exited": 1
}

Contact panel for an email address

GET/api/v1/crm/extension/sidebar

What the Gmail extension shows next to an email: the contact with that address, its company, deals and open tasks. contact is null if nobody in the CRM you can see has it.

Scope crm:read

NameTypeRequiredDescription
emailstringYesEmail address.
curl -X GET "https://zerosoft.ai/api/v1/crm/extension/sidebar" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "email": "ana@acme.com",
  "contact": {
    "id": "{contact_id}",
    "name": "Ana Pérez",
    "email": "ana@acme.com",
    "url": "/app/crm/contacts/{contact_id}"
  },
  "company": {
    "id": "{company_id}",
    "name": "Acme",
    "domain": "acme.com",
    "url": "/app/crm/companies/{company_id}"
  },
  "deals": [
    {
      "id": "{deal_id}",
      "name": "Acme renewal",
      "amount": 12000,
      "currency": "USD",
      "stage": "Proposal",
      "closed": false
    }
  ],
  "tasks": [
    {
      "id": "{task_id}",
      "subject": "Send proposal",
      "dueAt": "2026-07-25 15:00:00"
    }
  ],
  "emailsLogged": 3
}

Log an email from Gmail

POST/api/v1/crm/extension/log-email

Saves an email in the timeline of the contacts who take part in it. Sending the same messageId again does not duplicate it (200 with duplicate: true). 404 no_contact if no participant is a contact.

Scope crm:write

NameTypeRequiredDescription
messageIdstringYesGmail message id (data-legacy-message-id)
fromstringYesSender, like "Ana <ana@acme.com>"
tostringNoRecipients, separated by commas
subjectstringNoEmail subject
bodystringNoPlain text body
curl -X POST "https://zerosoft.ai/api/v1/crm/extension/log-email" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "messageId": "18c2f0a1b2c3d4e5",
  "from": "Ana <ana@acme.com>",
  "to": "you@yourco.com",
  "subject": "Pricing",
  "body": "Hi…"
}'

Request

{
  "messageId": "18c2f0a1b2c3d4e5",
  "from": "Ana <ana@acme.com>",
  "to": "you@yourco.com",
  "subject": "Pricing",
  "body": "Hi…"
}

Response · 201

{
  "ok": true,
  "emailId": "{email_id}",
  "contactIds": [
    "{contact_id}"
  ],
  "duplicate": false
}

Log and track an email before sending

POST/api/v1/crm/extension/track

Saves the outgoing email and returns the open tracking pixel to add to its body. If no recipient is a contact, the first one is created as a contact.

Scope crm:write

NameTypeRequiredDescription
tostringYesRecipients, separated by commas
subjectstringNoEmail subject
bodystringNoPlain text body
curl -X POST "https://zerosoft.ai/api/v1/crm/extension/track" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "to": "ana@acme.com",
  "subject": "Proposal",
  "body": "Hi Ana…"
}'

Request

{
  "to": "ana@acme.com",
  "subject": "Proposal",
  "body": "Hi Ana…"
}

Response · 201

{
  "ok": true,
  "emailId": "{email_id}",
  "pixelUrl": "https://zerosoft.ai/api/crm/t/o/{token}.gif",
  "contactIds": [
    "{contact_id}"
  ],
  "createdContact": false
}

Cal

Event types and bookings. Bookings created through the API follow the same rules as the public page (availability, buffers, Google Calendar busy times) and send the same emails.

List event types

GET/api/v1/calendar/event-types

Your event types with their public booking URL.

Scope cal:read

curl -X GET "https://zerosoft.ai/api/v1/calendar/event-types" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "eventTypes": [
    {
      "id": "et_42",
      "slug": "intro",
      "title": "Intro call",
      "durationMin": 30,
      "active": true,
      "url": "https://zerosoft.ai/en/book/ana/intro"
    }
  ]
}

List bookings

GET/api/v1/calendar/bookings

Bookings of your event types, newest first. Filter by status and date range.

Scope cal:read

NameTypeRequiredDescription
statusconfirmed | cancelled | no_show | pendingNoOnly bookings with this status.
qstringNoSearches the guest's name or email.
fromISO 8601NoStart time from (inclusive).
toISO 8601NoStart time up to (inclusive).
curl -X GET "https://zerosoft.ai/api/v1/calendar/bookings" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "bookings": [
    {
      "id": "8f1c2a8e-5b1e-4a7e-9a0e-2f6a1d0c9b11",
      "status": "confirmed",
      "startsAt": "2026-11-03T13:00:00.000Z",
      "endsAt": "2026-11-03T13:30:00.000Z",
      "timezone": "America/Argentina/Buenos_Aires",
      "invitee": {
        "name": "Ana",
        "email": "ana@example.com"
      },
      "answers": {},
      "hostUserId": "u_123",
      "meetingUrl": "https://meet.google.com/abc-defg-hij",
      "rescheduledFrom": null,
      "cancelReason": null,
      "eventType": {
        "id": "et_42",
        "slug": "intro",
        "title": "Intro call"
      }
    }
  ]
}

Create a booking

POST/api/v1/calendar/bookings

Books a slot for a guest. Returns 409 slot_unavailable if the time isn't offered anymore.

Scope cal:write

NameTypeRequiredDescription
eventTypeIdstringYesEvent type id (from List event types).
startISO 8601YesSlot start, must match an offered slot.
namestringYesGuest name.
emailstringYesGuest email: receives the confirmation and calendar invite.
timezoneIANANoGuest timezone for the emails. Defaults to UTC.
curl -X POST "https://zerosoft.ai/api/v1/calendar/bookings" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "eventTypeId": "et_42",
  "start": "2026-11-03T13:00:00.000Z",
  "name": "Ana",
  "email": "ana@example.com",
  "timezone": "America/Argentina/Buenos_Aires"
}'

Request

{
  "eventTypeId": "et_42",
  "start": "2026-11-03T13:00:00.000Z",
  "name": "Ana",
  "email": "ana@example.com",
  "timezone": "America/Argentina/Buenos_Aires"
}

Response · 201

{
  "id": "8f1c2a8e-5b1e-4a7e-9a0e-2f6a1d0c9b11",
  "status": "confirmed",
  "startsAt": "2026-11-03T13:00:00.000Z",
  "endsAt": "2026-11-03T13:30:00.000Z",
  "timezone": "America/Argentina/Buenos_Aires",
  "invitee": {
    "name": "Ana",
    "email": "ana@example.com"
  },
  "answers": {},
  "hostUserId": "u_123",
  "meetingUrl": "https://meet.google.com/abc-defg-hij",
  "rescheduledFrom": null,
  "cancelReason": null,
  "eventType": {
    "id": "et_42",
    "slug": "intro",
    "title": "Intro call"
  }
}

Get a booking

GET/api/v1/calendar/bookings/:id

One booking by id (event type owner or assigned host).

Scope cal:read

curl -X GET "https://zerosoft.ai/api/v1/calendar/bookings/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "8f1c2a8e-5b1e-4a7e-9a0e-2f6a1d0c9b11",
  "status": "confirmed",
  "startsAt": "2026-11-03T13:00:00.000Z",
  "endsAt": "2026-11-03T13:30:00.000Z",
  "timezone": "America/Argentina/Buenos_Aires",
  "invitee": {
    "name": "Ana",
    "email": "ana@example.com"
  },
  "answers": {},
  "hostUserId": "u_123",
  "meetingUrl": "https://meet.google.com/abc-defg-hij",
  "rescheduledFrom": null,
  "cancelReason": null,
  "eventType": {
    "id": "et_42",
    "slug": "intro",
    "title": "Intro call"
  }
}

Cancel a booking

POST/api/v1/calendar/bookings/:id/cancel

Cancels a confirmed booking, emails the guest a cancellation with .ics, removes the Google Calendar event and emits booking.cancelled.

Scope cal:write

NameTypeRequiredDescription
reasonstringNoShown to the guest in the cancellation email.
curl -X POST "https://zerosoft.ai/api/v1/calendar/bookings/:id/cancel" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Customer asked to move it to next month"
}'

Request

{
  "reason": "Customer asked to move it to next month"
}

Response · 200

{
  "id": "8f1c2a8e-5b1e-4a7e-9a0e-2f6a1d0c9b11",
  "status": "cancelled",
  "startsAt": "2026-11-03T13:00:00.000Z",
  "endsAt": "2026-11-03T13:30:00.000Z",
  "timezone": "America/Argentina/Buenos_Aires",
  "invitee": {
    "name": "Ana",
    "email": "ana@example.com"
  },
  "answers": {},
  "hostUserId": "u_123",
  "meetingUrl": "https://meet.google.com/abc-defg-hij",
  "rescheduledFrom": null,
  "cancelReason": "Customer asked to move it to next month",
  "eventType": {
    "id": "et_42",
    "slug": "intro",
    "title": "Intro call"
  }
}

Reschedule a booking

POST/api/v1/calendar/bookings/:id/reschedule

Moves a confirmed booking to another offered time, emails the guest the updated .ics and emits booking.rescheduled. Returns 409 slot_unavailable if that time is not offered.

Scope cal:write

NameTypeRequiredDescription
startISO 8601YesSlot start, must match an offered slot.
timezoneIANANoGuest timezone for the emails. Defaults to UTC.
curl -X POST "https://zerosoft.ai/api/v1/calendar/bookings/:id/reschedule" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "start": "2026-11-04T14:00:00.000Z"
}'

Request

{
  "start": "2026-11-04T14:00:00.000Z"
}

Response · 200

{
  "id": "8f1c2a8e-5b1e-4a7e-9a0e-2f6a1d0c9b11",
  "status": "confirmed",
  "startsAt": "2026-11-04T14:00:00.000Z",
  "endsAt": "2026-11-04T14:30:00.000Z",
  "timezone": "America/Argentina/Buenos_Aires",
  "invitee": {
    "name": "Ana",
    "email": "ana@example.com"
  },
  "answers": {},
  "hostUserId": "u_123",
  "meetingUrl": "https://meet.google.com/abc-defg-hij",
  "rescheduledFrom": null,
  "cancelReason": null,
  "eventType": {
    "id": "et_42",
    "slug": "intro",
    "title": "Intro call"
  }
}

Mark as no-show

POST/api/v1/calendar/bookings/:id/no-show

Marks that the guest did not show up. Confirmed bookings only.

Scope cal:write

curl -X POST "https://zerosoft.ai/api/v1/calendar/bookings/:id/no-show" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "8f1c2a8e-5b1e-4a7e-9a0e-2f6a1d0c9b11",
  "status": "no_show",
  "startsAt": "2026-11-03T13:00:00.000Z",
  "endsAt": "2026-11-03T13:30:00.000Z",
  "timezone": "America/Argentina/Buenos_Aires",
  "invitee": {
    "name": "Ana",
    "email": "ana@example.com"
  },
  "answers": {},
  "hostUserId": "u_123",
  "meetingUrl": "https://meet.google.com/abc-defg-hij",
  "rescheduledFrom": null,
  "cancelReason": null,
  "eventType": {
    "id": "et_42",
    "slug": "intro",
    "title": "Intro call"
  }
}

Agents

Talk to your AI agents from your own app. The agent uses the same instructions, knowledge and tools as in Chat and on its public page; every reply counts toward the workspace AI quota.

Send a message to an agent

POST/api/v1/agents/:id/messages

Returns the agent's reply and the tools it used. Send the returned conversationId to continue the same conversation. Errors: 404 not_found, 403 agent_disabled, 429 rate_limited, 503 ai_disabled.

Scope agents:run

NameTypeRequiredDescription
messagestringYesWhat the user says (up to 4000 characters).
conversationIdstringNoContinue an existing API conversation. Omit it to start a new one.
curl -X POST "https://zerosoft.ai/api/v1/agents/:id/messages" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "message": "Do you ship to Brazil?"
}'

Request

{
  "message": "Do you ship to Brazil?"
}

Response · 200

{
  "conversationId": "6b0f8f7e-2a43-4d0c-9a51-3f3c1f1b8e21",
  "message": {
    "id": "b7e1…",
    "role": "assistant",
    "content": "Yes! We ship to Brazil in 5–7 business days.",
    "createdAt": "2026-11-01T18:00:00.000Z"
  },
  "status": "replied",
  "handoff": false,
  "toolCalls": [
    {
      "tool": "search_knowledge",
      "input": {
        "query": "shipping Brazil"
      },
      "output": {
        "results": []
      },
      "error": null
    }
  ]
}

Chat

Read and answer the conversations of your Chat inbox from your own app or helpdesk. Needs the chat:read scope to read and chat:write to reply, assign and resolve. Replies are sent as the person who created the key.

List conversations

GET/api/v1/chat/conversations

Conversations of the workspace's widgets, most recently updated first.

Scope chat:read

NameTypeRequiredDescription
statusopen | pending | snoozed | resolvedNoOnly conversations with this status.
assignedTostringNoOnly conversations assigned to this user id, or unassigned.
widgetIdstringNoOnly conversations of this widget.
limitintegerNoHow many to return (1 to 200, default 50).
offsetintegerNoHow many to skip, for paging.
curl -X GET "https://zerosoft.ai/api/v1/chat/conversations" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "conversations": [
    {
      "id": "{conversation_id}",
      "widgetId": "{widget_id}",
      "status": "open",
      "priority": "medium",
      "subject": null,
      "assignedTo": "{user_id}",
      "visitor": {
        "id": "{visitor_id}",
        "name": "Ana",
        "email": "ana@example.com"
      },
      "firstResponseAt": "2026-11-01T18:02:00.000Z",
      "resolvedAt": null,
      "createdAt": "2026-11-01T18:00:00.000Z",
      "updatedAt": "2026-11-01T18:02:00.000Z"
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

Get a conversation

GET/api/v1/chat/conversations/{id}

The conversation and all its messages, oldest first. Internal notes come with isNote: true.

Scope chat:read

NameTypeRequiredDescription
idstringYesRecord id.
curl -X GET "https://zerosoft.ai/api/v1/chat/conversations/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "conversation": {
    "id": "{conversation_id}",
    "widgetId": "{widget_id}",
    "status": "open",
    "priority": "medium",
    "subject": null,
    "assignedTo": "{user_id}",
    "visitor": {
      "id": "{visitor_id}",
      "name": "Ana",
      "email": "ana@example.com"
    },
    "firstResponseAt": "2026-11-01T18:02:00.000Z",
    "resolvedAt": null,
    "createdAt": "2026-11-01T18:00:00.000Z",
    "updatedAt": "2026-11-01T18:02:00.000Z"
  },
  "messages": [
    {
      "id": "{message_id}",
      "conversationId": "{conversation_id}",
      "senderType": "user",
      "userId": "{user_id}",
      "body": "Hi Ana, the order ships tomorrow.",
      "isNote": false,
      "attachments": [],
      "createdAt": "2026-11-01T18:02:00.000Z"
    }
  ]
}

Reply

POST/api/v1/chat/conversations/{id}/messages

Sends a message to the visitor (or an internal note with note: true). Like a reply from the inbox, it counts as the first response for the SLA and reopens the conversation if it was resolved. Fires chat.message.created.

Scope chat:write

NameTypeRequiredDescription
bodystringYesMessage text (up to 5000 characters).
notebooleanNotrue to leave an internal note the visitor doesn't see.
curl -X POST "https://zerosoft.ai/api/v1/chat/conversations/{id}/messages" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "body": "Hi Ana, the order ships tomorrow."
}'

Request

{
  "body": "Hi Ana, the order ships tomorrow."
}

Response · 201

{
  "id": "{message_id}",
  "conversationId": "{conversation_id}",
  "senderType": "user",
  "userId": "{user_id}",
  "body": "Hi Ana, the order ships tomorrow.",
  "isNote": false,
  "attachments": [],
  "createdAt": "2026-11-01T18:02:00.000Z"
}

Assign

POST/api/v1/chat/conversations/{id}/assign

Assigns the conversation to an agent of its widget, or unassigns it with null. Fires chat.conversation.assigned. Errors: 400 invalid_assignee.

Scope chat:write

NameTypeRequiredDescription
assignedTostringYesUser id of the agent, or null to unassign.
curl -X POST "https://zerosoft.ai/api/v1/chat/conversations/{id}/assign" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "assignedTo": "{user_id}"
}'

Request

{
  "assignedTo": "{user_id}"
}

Response · 200

{
  "id": "{conversation_id}",
  "widgetId": "{widget_id}",
  "status": "open",
  "priority": "medium",
  "subject": null,
  "assignedTo": "{user_id}",
  "visitor": {
    "id": "{visitor_id}",
    "name": "Ana",
    "email": "ana@example.com"
  },
  "firstResponseAt": "2026-11-01T18:02:00.000Z",
  "resolvedAt": null,
  "createdAt": "2026-11-01T18:00:00.000Z",
  "updatedAt": "2026-11-01T18:02:00.000Z"
}

Resolve

POST/api/v1/chat/conversations/{id}/resolve

Marks the conversation as resolved. If the widget has required attributes still empty, it answers 400 missing_attributes. Fires chat.conversation.resolved.

Scope chat:write

curl -X POST "https://zerosoft.ai/api/v1/chat/conversations/{id}/resolve" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "{conversation_id}",
  "widgetId": "{widget_id}",
  "status": "resolved",
  "priority": "medium",
  "subject": null,
  "assignedTo": "{user_id}",
  "visitor": {
    "id": "{visitor_id}",
    "name": "Ana",
    "email": "ana@example.com"
  },
  "firstResponseAt": "2026-11-01T18:02:00.000Z",
  "resolvedAt": "2026-11-01T18:10:00.000Z",
  "createdAt": "2026-11-01T18:00:00.000Z",
  "updatedAt": "2026-11-01T18:02:00.000Z"
}

Reopen

POST/api/v1/chat/conversations/{id}/reopen

Opens a resolved or snoozed conversation again.

Scope chat:write

curl -X POST "https://zerosoft.ai/api/v1/chat/conversations/{id}/reopen" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "{conversation_id}",
  "widgetId": "{widget_id}",
  "status": "open",
  "priority": "medium",
  "subject": null,
  "assignedTo": "{user_id}",
  "visitor": {
    "id": "{visitor_id}",
    "name": "Ana",
    "email": "ana@example.com"
  },
  "firstResponseAt": "2026-11-01T18:02:00.000Z",
  "resolvedAt": null,
  "createdAt": "2026-11-01T18:00:00.000Z",
  "updatedAt": "2026-11-01T18:02:00.000Z"
}

Robots

Run your browser robots from your own app, one at a time or over many inputs. Runs go through the same queue as in the app (one at a time per workspace) and count toward the monthly robot minutes. Running needs a key created by a workspace admin.

List robots

GET/api/v1/robots

Returns the workspace robots with their inputs, so you know what to send when running them.

Scope robots:run

curl -X GET "https://zerosoft.ai/api/v1/robots" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "robots": [
    {
      "id": "c1f2a9d4-7b1e-4c2a-9f0e-1a2b3c4d5e6f",
      "name": "Price check",
      "description": "",
      "enabled": true,
      "inputs": [
        {
          "name": "url",
          "label": "Product URL",
          "kind": "text",
          "default": "",
          "required": true
        }
      ],
      "updatedAt": "2026-11-01T18:00:00.000Z"
    }
  ]
}

Run a robot

POST/api/v1/robots/:id/runs

Queues a run and returns 202 with the run; poll GET /api/v1/robots/runs/:id until status is success or failed. With "wait": true the response waits for the result (200) when no other run is ahead. The robot needs automatic runs turned on. Errors: 404 not_found, 400 missing_input or disabled, 409 busy, 429 rate_limited or quota_exceeded, 503 runner_unavailable.

Scope robots:run

NameTypeRequiredDescription
inputsobjectNoRobot inputs by name. List inputs take an array of strings.
waitbooleanNoWait for the result in the same response (up to the robot timeout). Default false.
curl -X POST "https://zerosoft.ai/api/v1/robots/:id/runs" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html"
  }
}'

Request

{
  "inputs": {
    "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html"
  }
}

Response · 202

{
  "run": {
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "robotId": "c1f2a9d4-7b1e-4c2a-9f0e-1a2b3c4d5e6f",
    "status": "queued",
    "trigger": "api",
    "input": {
      "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html"
    },
    "output": {},
    "error": null,
    "warnings": 0,
    "changed": null,
    "batchId": null,
    "createdAt": "2026-11-01T18:00:00.000Z",
    "startedAt": null,
    "finishedAt": null,
    "durationMs": null
  }
}

Get a run

GET/api/v1/robots/runs/:id

Status, inputs and extracted data of a run. changed tells whether the data differs from the previous successful run with the same inputs (null when there was nothing to compare).

Scope robots:run

curl -X GET "https://zerosoft.ai/api/v1/robots/runs/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "run": {
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "robotId": "c1f2a9d4-7b1e-4c2a-9f0e-1a2b3c4d5e6f",
    "status": "success",
    "trigger": "api",
    "input": {
      "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html"
    },
    "output": {
      "title": "A Light in the Attic",
      "price": "£51.77"
    },
    "error": null,
    "warnings": 0,
    "changed": false,
    "batchId": null,
    "createdAt": "2026-11-01T18:00:00.000Z",
    "startedAt": "2026-11-01T18:00:01.000Z",
    "finishedAt": "2026-11-01T18:00:06.000Z",
    "durationMs": 5000
  }
}

Run a robot over many inputs

POST/api/v1/robots/:id/bulk

Queues one run per item of inputs (up to 1,000 per request) under a batch id. For up to 50,000, send parts with the same batchId, the offset of each part's first row and total: no run starts until all rows arrive, and sending a part again does not duplicate it. Runs follow the workspace's runs-at-once setting; every input in the request is validated before anything is queued. Errors: 400 missing_input (with the item index), 409 busy, 429 rate_limited.

Scope robots:run

NameTypeRequiredDescription
inputsobject[]YesOne inputs object per run, 1 to 1,000 per request.
curl -X POST "https://zerosoft.ai/api/v1/robots/:id/bulk" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "inputs": [
    {
      "url": "https://example.com/a"
    },
    {
      "url": "https://example.com/b"
    }
  ]
}'

Request

{
  "inputs": [
    {
      "url": "https://example.com/a"
    },
    {
      "url": "https://example.com/b"
    }
  ]
}

Response · 202

{
  "batchId": "3e2d1c0b-9a8f-4e7d-8c6b-5a4f3e2d1c0b",
  "total": 2,
  "runs": [
    {
      "id": "1f2e3d4c-…",
      "status": "queued",
      "input": {
        "url": "https://example.com/a"
      }
    },
    {
      "id": "5b6a7c8d-…",
      "status": "queued",
      "input": {
        "url": "https://example.com/b"
      }
    }
  ]
}

Get a batch

GET/api/v1/robots/batches/:id

Counts by status, done when every run finished, and a page of runs in the order you sent them: ?limit= (up to 1,000, the default) and ?offset=. nextOffset is the offset of the next page, or null on the last one.

Scope robots:run

curl -X GET "https://zerosoft.ai/api/v1/robots/batches/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "batchId": "3e2d1c0b-9a8f-4e7d-8c6b-5a4f3e2d1c0b",
  "robotId": "c1f2a9d4-7b1e-4c2a-9f0e-1a2b3c4d5e6f",
  "total": 2,
  "counts": {
    "queued": 0,
    "running": 1,
    "success": 1,
    "failed": 0
  },
  "done": false,
  "nextOffset": null,
  "runs": [
    {
      "id": "1f2e3d4c-…",
      "status": "success",
      "input": {
        "url": "https://example.com/a"
      },
      "output": {
        "title": "A"
      },
      "error": null
    },
    {
      "id": "5b6a7c8d-…",
      "status": "running",
      "input": {
        "url": "https://example.com/b"
      },
      "output": {},
      "error": null
    }
  ]
}

Lines (WhatsApp)

Read WhatsApp chats and groups, send messages and create tickets from your own systems. Messages go out from the number the chat belongs to.

List chats and groups

GET/api/v1/groups/chats

Open chats and groups, most recent first, with labels, assignee and whether they wait for a reply.

Scope groups:read

NameTypeRequiredDescription
filterstringNoall, unread, unanswered, flagged, mine, unassigned or closed
qstringNoSearch query.
kindstringNogroup or dm
curl -X GET "https://zerosoft.ai/api/v1/groups/chats" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "gc_1",
      "kind": "group",
      "name": "Acme · Support",
      "memberCount": 12,
      "assignedTo": null,
      "labels": [
        {
          "id": "gl_1",
          "name": "Enterprise",
          "color": "blue"
        }
      ],
      "unread": 2,
      "lastMessageAt": "2026-11-01T18:00:00.000Z",
      "awaitingSince": "2026-11-01T18:00:00.000Z",
      "flagged": false
    }
  ],
  "total": 1
}

List messages

GET/api/v1/groups/chats/:id/messages

Messages and internal notes of a chat, oldest first.

Scope groups:read

NameTypeRequiredDescription
afterstringNoOnly messages after this ISO date
curl -X GET "https://zerosoft.ai/api/v1/groups/chats/:id/messages" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "gm_1",
      "direction": "in",
      "senderName": "Ana",
      "senderPhone": "5491155550000",
      "body": "The October invoice did not arrive",
      "status": "received",
      "createdAt": "2026-11-01T18:00:00.000Z"
    }
  ]
}

Send a message

POST/api/v1/groups/chats/:id/messages

Sends a WhatsApp message to the chat or group, or saves an internal note with note: true.

Scope groups:write

NameTypeRequiredDescription
bodystringYesMessage text (up to 4096 characters)
notebooleanNoSave as an internal note instead of sending
pollobjectNoObject with question, options (2 to 12) and multi, instead of body. WAHA and Evolution only
mediaobjectNoObject with url (public https), mimetype and filename
curl -X POST "https://zerosoft.ai/api/v1/groups/chats/:id/messages" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "body": "Hi Ana, resending it now."
}'

Request

{
  "body": "Hi Ana, resending it now."
}

Response · 201

{
  "data": {
    "id": "gm_2",
    "direction": "out",
    "body": "Hi Ana, resending it now.",
    "status": "sent",
    "createdAt": "2026-11-01T18:01:00.000Z"
  }
}

List tickets

GET/api/v1/groups/tickets

Tickets created from WhatsApp messages, with SLA status.

Scope groups:read

NameTypeRequiredDescription
statusstringNoactive (default), all, open, in_progress, resolved or closed
curl -X GET "https://zerosoft.ai/api/v1/groups/tickets" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "gt_1",
      "number": 12,
      "title": "Invoice did not arrive",
      "status": "open",
      "priority": "high",
      "source": "reaction",
      "dueAt": "2026-11-02T18:00:00.000Z",
      "breached": false
    }
  ]
}

Create a ticket

POST/api/v1/groups/tickets

Creates a ticket on a chat. With messageId, a message has at most one ticket: repeating returns the existing one.

Scope groups:write

NameTypeRequiredDescription
chatIdstringYesChat or group id
titlestringNoTicket title (default: the first line of the message)
prioritystringNolow, medium, high or urgent
curl -X POST "https://zerosoft.ai/api/v1/groups/tickets" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "gc_1",
  "title": "Invoice did not arrive",
  "priority": "high"
}'

Request

{
  "chatId": "gc_1",
  "title": "Invoice did not arrive",
  "priority": "high"
}

Response · 201

{
  "data": {
    "id": "gt_1",
    "number": 12,
    "title": "Invoice did not arrive",
    "status": "open",
    "priority": "high",
    "source": "api"
  }
}

Get a chat

GET/api/v1/groups/chats/:id

A chat or group with its labels, assignee and members.

Scope groups:read

curl -X GET "https://zerosoft.ai/api/v1/groups/chats/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": {
    "id": "gc_1",
    "kind": "group",
    "name": "Acme · Support",
    "memberCount": 12,
    "status": "open",
    "labels": [],
    "members": [
      {
        "phone": "5491155550000",
        "name": "Ana",
        "role": "admin"
      }
    ]
  }
}

Update a chat

PATCH/api/v1/groups/chats/:id

Assign, close or reopen, replace labels, rename (also in WhatsApp for groups) or set properties. Changes go to the audit log.

Scope groups:write

NameTypeRequiredDescription
assignedTostringNoUser id of a workspace person, or null to unassign
statusopen | closedNoopen or closed
labelIdsstring[]NoLabel ids (replaces the current ones)
namestringNoName
curl -X PATCH "https://zerosoft.ai/api/v1/groups/chats/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "assignedTo": "u_1",
  "labelIds": [
    "gl_1"
  ]
}'

Request

{
  "assignedTo": "u_1",
  "labelIds": [
    "gl_1"
  ]
}

Response · 200

{
  "data": {
    "id": "gc_1",
    "assignedTo": "u_1",
    "status": "open",
    "labels": [
      {
        "id": "gl_1",
        "name": "Enterprise",
        "color": "blue"
      }
    ]
  }
}

List group members

GET/api/v1/groups/chats/:id/members

Members of a group with their role (member, admin or superadmin).

Scope groups:read

curl -X GET "https://zerosoft.ai/api/v1/groups/chats/:id/members" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "phone": "5491155550000",
      "name": "Ana",
      "role": "admin"
    }
  ]
}

Add, remove or promote members

POST/api/v1/groups/chats/:id/members

Changes members in WhatsApp (WAHA or Evolution numbers). With action invite it returns the invite link; revoke: true makes a new one.

Scope groups:write

NameTypeRequiredDescription
actionadd | remove | promote | demote | inviteYesWhat to do with the phones
phonesstring[]NoPhones in international format
curl -X POST "https://zerosoft.ai/api/v1/groups/chats/:id/members" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "action": "add",
  "phones": [
    "+5491155550001"
  ]
}'

Request

{
  "action": "add",
  "phones": [
    "+5491155550001"
  ]
}

Response · 200

{
  "data": {
    "results": [
      {
        "phone": "5491155550001",
        "ok": true
      }
    ],
    "members": []
  }
}

Create groups

POST/api/v1/groups/groups

Creates one WhatsApp group, or up to 50 with groups: [...]. Phones that WhatsApp could not add come back in notAdded.

Scope groups:write

NameTypeRequiredDescription
numberIdstringYesNumber that creates the group (WAHA or Evolution)
namestringYesName
phonesstring[]NoPhones in international format
curl -X POST "https://zerosoft.ai/api/v1/groups/groups" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "numberId": "gn_1",
  "name": "Acme · Onboarding",
  "phones": [
    "+5491155550001"
  ]
}'

Request

{
  "numberId": "gn_1",
  "name": "Acme · Onboarding",
  "phones": [
    "+5491155550001"
  ]
}

Response · 201

{
  "data": [
    {
      "name": "Acme · Onboarding",
      "ok": true,
      "chatId": "gc_2",
      "notAdded": []
    }
  ]
}

List numbers

GET/api/v1/groups/numbers

Connected WhatsApp numbers with provider, status and capabilities. Credentials are never returned.

Scope groups:read

curl -X GET "https://zerosoft.ai/api/v1/groups/numbers" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "gn_1",
      "name": "Support line",
      "provider": "waha",
      "phone": "5491155550000",
      "status": "connected"
    }
  ]
}

List labels

GET/api/v1/groups/labels

Labels of the workspace with how many chats have each one.

Scope groups:read

curl -X GET "https://zerosoft.ai/api/v1/groups/labels" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "gl_1",
      "name": "Enterprise",
      "color": "blue",
      "count": 4
    }
  ]
}

Create a label

POST/api/v1/groups/labels

Colors: gray, red, orange, yellow, green, teal, blue, purple or pink.

Scope groups:write

NameTypeRequiredDescription
namestringYesName
curl -X POST "https://zerosoft.ai/api/v1/groups/labels" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "name": "Enterprise",
  "color": "blue"
}'

Request

{
  "name": "Enterprise",
  "color": "blue"
}

Response · 201

{
  "data": {
    "id": "gl_1",
    "name": "Enterprise",
    "color": "blue"
  }
}

Get a ticket

GET/api/v1/groups/tickets/:id

The ticket with its linked Freshdesk or Zoho Desk tickets, if any.

Scope groups:read

curl -X GET "https://zerosoft.ai/api/v1/groups/tickets/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": {
    "id": "gt_1",
    "number": 12,
    "title": "Invoice did not arrive",
    "status": "open",
    "links": [
      {
        "kind": "freshdesk",
        "remoteId": "1042",
        "remoteUrl": "https://acme.freshdesk.com/a/tickets/1042"
      }
    ]
  }
}

Update a ticket

PATCH/api/v1/groups/tickets/:id

Status, priority, assignee or title. The new status is sent to linked Freshdesk or Zoho Desk tickets.

Scope groups:write

NameTypeRequiredDescription
statusstringNoactive (default), all, open, in_progress, resolved or closed
prioritystringNolow, medium, high or urgent
assigneeIdstringNoUser id of a workspace person, or null to unassign
curl -X PATCH "https://zerosoft.ai/api/v1/groups/tickets/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "status": "resolved"
}'

Request

{
  "status": "resolved"
}

Response · 200

{
  "data": {
    "id": "gt_1",
    "number": 12,
    "status": "resolved"
  }
}

Send a broadcast

POST/api/v1/groups/broadcasts

Sends a message or a poll to many chats and groups from one number, at the pace you set (perMinute). With scheduledAt it goes out later.

Scope groups:write

NameTypeRequiredDescription
chatIdsstring[]YesChat and group ids
bodystringNoMessage text (up to 4096 characters)
pollobjectNoObject with question, options (2 to 12) and multi, instead of body. WAHA and Evolution only
scheduledAtstringNoISO date to send later
curl -X POST "https://zerosoft.ai/api/v1/groups/broadcasts" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "chatIds": [
    "gc_1",
    "gc_2"
  ],
  "body": "Hi {{first_name}}, the new release is live.",
  "perMinute": 20
}'

Request

{
  "chatIds": [
    "gc_1",
    "gc_2"
  ],
  "body": "Hi {{first_name}}, the new release is live.",
  "perMinute": 20
}

Response · 201

{
  "data": {
    "id": "gb_1",
    "status": "scheduled",
    "total": 2
  }
}

Create a recurring message

POST/api/v1/groups/recurring

Repeats a message or poll daily, weekly, monthly or with a cron expression. GET the same path lists them with their next run.

Scope groups:write

NameTypeRequiredDescription
chatIdsstring[]YesChat and group ids
ruleobjectYesObject with freq (daily, weekly, monthly or cron), time (HH:MM), days (0 to 6), dayOfMonth or cron
timezonestringNoIANA time zone (default UTC)
endsAtstringNoOptional ISO end date
curl -X POST "https://zerosoft.ai/api/v1/groups/recurring" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "chatIds": [
    "gc_1"
  ],
  "body": "Weekly check-in: anything blocking you?",
  "rule": {
    "freq": "weekly",
    "days": [
      1
    ],
    "time": "09:00"
  },
  "timezone": "America/Argentina/Buenos_Aires"
}'

Request

{
  "chatIds": [
    "gc_1"
  ],
  "body": "Weekly check-in: anything blocking you?",
  "rule": {
    "freq": "weekly",
    "days": [
      1
    ],
    "time": "09:00"
  },
  "timezone": "America/Argentina/Buenos_Aires"
}

Response · 201

{
  "data": {
    "id": "gr_1",
    "status": "active",
    "nextRunAt": "2026-11-02T12:00:00.000Z"
  }
}

MCP server

POST/api/v1/groups/mcp

Model Context Protocol over streamable HTTP (JSON-RPC). Methods: initialize, tools/list, tools/call. Tools: list_chats, get_messages, send_message, send_poll, update_chat, list_labels, create_ticket, list_tickets, update_ticket. Write tools need groups:write.

Scope groups:read

curl -X POST "https://zerosoft.ai/api/v1/groups/mcp" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_chats",
    "arguments": {
      "filter": "unanswered"
    }
  }
}'

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_chats",
    "arguments": {
      "filter": "unanswered"
    }
  }
}

Response · 200

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"total\":1,\"chats\":[...]}"
      }
    ],
    "isError": false
  }
}

Voice

Dictation and meeting transcripts. The desktop app uses these endpoints with a key that has voice:read and voice:write. Audio is transcribed and discarded.

Dictate

POST/api/v1/voice/dictate

Multipart upload of an audio clip. Returns the transcript cleaned up with the person's dictionary and style, and saves it in their dictation history.

Scope voice:write

curl -X POST "https://zerosoft.ai/api/v1/voice/dictate" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "audio": "(multipart file, webm/ogg/wav/m4a/mp3, up to 4 MB)",
  "context": "email",
  "sourceApp": "Mail",
  "durationMs": 5200
}'

Request

{
  "audio": "(multipart file, webm/ogg/wav/m4a/mp3, up to 4 MB)",
  "context": "email",
  "sourceApp": "Mail",
  "durationMs": 5200
}

Response · 201

{
  "data": {
    "id": "vs_1",
    "text": "The launch is on Tuesday.",
    "raw": "um the launch is on monday, no, I mean tuesday",
    "ai": true
  }
}

List sessions

GET/api/v1/voice/sessions

Dictations and meetings of the person who created the key, newest first.

Scope voice:read

NameTypeRequiredDescription
kindstringNomeeting or dictation.
qstringNoSearch query.
curl -X GET "https://zerosoft.ai/api/v1/voice/sessions" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "vs_2",
      "kind": "meeting",
      "title": "Acme pricing call",
      "status": "done",
      "durationMs": 1820000,
      "startedAt": "2026-11-02T15:00:00.000Z"
    }
  ]
}

Create a meeting

POST/api/v1/voice/sessions

Starts a meeting to upload audio chunks to.

Scope voice:write

curl -X POST "https://zerosoft.ai/api/v1/voice/sessions" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "title": "Acme pricing call"
}'

Request

{
  "title": "Acme pricing call"
}

Response · 201

{
  "data": {
    "id": "vs_2",
    "title": "Acme pricing call",
    "status": "recording",
    "startedAt": "2026-11-02T15:00:00.000Z"
  }
}

Upload an audio chunk

POST/api/v1/voice/sessions/:id/chunks

Transcribes one chunk of a meeting. source is me (microphone), them (system audio) or mixed. Idempotent by source and seq.

Scope voice:write

curl -X POST "https://zerosoft.ai/api/v1/voice/sessions/:id/chunks" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "audio": "(multipart file, up to 4 MB)",
  "source": "them",
  "seq": 200,
  "offsetMs": 20000,
  "durationMs": 20000
}'

Request

{
  "audio": "(multipart file, up to 4 MB)",
  "source": "them",
  "seq": 200,
  "offsetMs": 20000,
  "durationMs": 20000
}

Response · 201

{
  "data": {
    "duplicate": false,
    "segments": [
      {
        "id": "sg_1",
        "source": "them",
        "speaker": "0",
        "startMs": 20400,
        "endMs": 24100,
        "text": "Twenty dollars works for us."
      }
    ]
  }
}

Get a session

GET/api/v1/voice/sessions/:id

The session with its transcript, notes and AI notes.

Scope voice:read

curl -X GET "https://zerosoft.ai/api/v1/voice/sessions/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": {
    "id": "vs_2",
    "title": "Acme pricing call",
    "segments": [],
    "myNotes": "",
    "enhanced": null
  }
}

Update a session

PATCH/api/v1/voice/sessions/:id

Rename it, or set status to done when the recording ends.

Scope voice:write

curl -X PATCH "https://zerosoft.ai/api/v1/voice/sessions/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "status": "done"
}'

Request

{
  "status": "done"
}

Response · 200

{
  "data": {
    "id": "vs_2",
    "title": "Acme pricing call",
    "status": "done",
    "durationMs": 1820000
  }
}

Dictionary and settings

GET/api/v1/voice/dictionary

Words, replacements, snippets and dictation settings of the person, to sync the desktop app.

Scope voice:read

curl -X GET "https://zerosoft.ai/api/v1/voice/dictionary" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": {
    "entries": [
      {
        "id": "vd_1",
        "kind": "replace",
        "phrase": "zero soft",
        "replacement": "zerosoft"
      }
    ],
    "settings": {
      "language": "auto",
      "shortcut": "Alt+Space"
    }
  }
}

Track

Issues, comments, teams, cycles, statuses, labels and people of Track. Use a key with track:read or track:write. Issues created by API go to triage when the team has it on, and every change leaves activity, notifications, webhooks and an audit entry like the app. Teams were called projects before: /api/v1/track/projects and projectId still work.

List issues

GET/api/v1/track/issues

Issues the key can see, most recently updated first, with filters.

Scope track:read

NameTypeRequiredDescription
teamIdstringNoTeam id or key (WEB). projectId also works.
statusCategorybacklog | todo | in_progress | done | cancelledNoStatus category.
assigneeIdstringNoAssignee user id.
priorityurgent | high | medium | lowNoPriority.
qstringNoSearch query.
updatedSincestringNoOnly issues updated since this ISO date.
pageintegerNoPage number.
pageSizeintegerNoItems per page (max 100).
curl -X GET "https://zerosoft.ai/api/v1/track/issues" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "{issue_id}",
      "identifier": "WEB-12",
      "title": "Checkout button does nothing on Safari",
      "description": "Steps: open /pricing, press Buy.",
      "url": "https://zerosoft.ai/app/track/issues/{issue_id}",
      "projectId": "{team_id}",
      "teamId": "{team_id}",
      "planId": null,
      "status": {
        "id": "{status_id}",
        "name": "In Progress",
        "category": "in_progress",
        "color": "#000000"
      },
      "priority": "high",
      "assignee": {
        "id": "{user_id}",
        "name": "Ana",
        "email": "ana@example.com"
      },
      "creatorId": "{user_id}",
      "cycle": {
        "id": "{cycle_id}",
        "name": "Cycle 4"
      },
      "milestoneId": null,
      "parentId": null,
      "estimate": 3,
      "labels": [
        {
          "id": "{label_id}",
          "name": "bug",
          "color": "#d14343"
        }
      ],
      "startDate": null,
      "dueDate": "2026-11-04",
      "triage": false,
      "source": "api",
      "createdAt": "2026-10-25T14:02:11.000Z",
      "updatedAt": "2026-10-25T15:10:00.000Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1,
  "hasMore": false
}

Create an issue

POST/api/v1/track/issues

teamId accepts the id or the key (WEB); projectId is the older name. status accepts a status name or a category. Links to Sentry, Zendesk, Intercom or Figma stay linked to the issue.

Scope track:write

NameTypeRequiredDescription
teamIdstringYesTeam id or key (WEB). projectId also works.
titlestringYesIssue title.
descriptionstringNoDescription in markdown.
statusstringNoStatus name ("In Progress") or category (in_progress).
priorityurgent | high | medium | lowNoPriority.
assigneeEmailstringNoEmail of a team member.
labelsstring[]NoLabel names; missing ones are created.
dueDatestringNoDue date, YYYY-MM-DD.
linksstring[]NoSentry, Zendesk, Intercom or Figma URLs to link.
curl -X POST "https://zerosoft.ai/api/v1/track/issues" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "teamId": "WEB",
  "title": "Checkout button does nothing on Safari",
  "description": "Steps: open /pricing, press Buy.",
  "priority": "high",
  "labels": [
    "bug"
  ],
  "links": [
    "https://acme.zendesk.com/agent/tickets/4812"
  ]
}'

Request

{
  "teamId": "WEB",
  "title": "Checkout button does nothing on Safari",
  "description": "Steps: open /pricing, press Buy.",
  "priority": "high",
  "labels": [
    "bug"
  ],
  "links": [
    "https://acme.zendesk.com/agent/tickets/4812"
  ]
}

Response · 201

{
  "id": "{issue_id}",
  "identifier": "WEB-12",
  "title": "Checkout button does nothing on Safari",
  "description": "Steps: open /pricing, press Buy.",
  "url": "https://zerosoft.ai/app/track/issues/{issue_id}",
  "projectId": "{team_id}",
  "teamId": "{team_id}",
  "planId": null,
  "status": {
    "id": "{status_id}",
    "name": "In Progress",
    "category": "in_progress",
    "color": "#000000"
  },
  "priority": "high",
  "assignee": {
    "id": "{user_id}",
    "name": "Ana",
    "email": "ana@example.com"
  },
  "creatorId": "{user_id}",
  "cycle": {
    "id": "{cycle_id}",
    "name": "Cycle 4"
  },
  "milestoneId": null,
  "parentId": null,
  "estimate": 3,
  "labels": [
    {
      "id": "{label_id}",
      "name": "bug",
      "color": "#d14343"
    }
  ],
  "startDate": null,
  "dueDate": "2026-11-04",
  "triage": false,
  "source": "api",
  "createdAt": "2026-10-25T14:02:11.000Z",
  "updatedAt": "2026-10-25T15:10:00.000Z"
}

Get an issue

GET/api/v1/track/issues/{id}

By id or identifier (WEB-12).

Scope track:read

NameTypeRequiredDescription
idstringYesIssue id or identifier (WEB-12).
curl -X GET "https://zerosoft.ai/api/v1/track/issues/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "{issue_id}",
  "identifier": "WEB-12",
  "title": "Checkout button does nothing on Safari",
  "description": "Steps: open /pricing, press Buy.",
  "url": "https://zerosoft.ai/app/track/issues/{issue_id}",
  "projectId": "{team_id}",
  "teamId": "{team_id}",
  "planId": null,
  "status": {
    "id": "{status_id}",
    "name": "In Progress",
    "category": "in_progress",
    "color": "#000000"
  },
  "priority": "high",
  "assignee": {
    "id": "{user_id}",
    "name": "Ana",
    "email": "ana@example.com"
  },
  "creatorId": "{user_id}",
  "cycle": {
    "id": "{cycle_id}",
    "name": "Cycle 4"
  },
  "milestoneId": null,
  "parentId": null,
  "estimate": 3,
  "labels": [
    {
      "id": "{label_id}",
      "name": "bug",
      "color": "#d14343"
    }
  ],
  "startDate": null,
  "dueDate": "2026-11-04",
  "triage": false,
  "source": "api",
  "createdAt": "2026-10-25T14:02:11.000Z",
  "updatedAt": "2026-10-25T15:10:00.000Z"
}

Update an issue

PATCH/api/v1/track/issues/{id}

Send only what changes. Changing status or assignee accepts an issue waiting in triage.

Scope track:write

NameTypeRequiredDescription
idstringYesIssue id or identifier (WEB-12).
statusstringNoStatus name ("In Progress") or category (in_progress).
assigneeEmailstringNoEmail of a team member.
priorityurgent | high | medium | lowNoPriority.
curl -X PATCH "https://zerosoft.ai/api/v1/track/issues/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "status": "Done"
}'

Request

{
  "status": "Done"
}

Response · 200

{
  "id": "{issue_id}",
  "identifier": "WEB-12",
  "title": "Checkout button does nothing on Safari",
  "description": "Steps: open /pricing, press Buy.",
  "url": "https://zerosoft.ai/app/track/issues/{issue_id}",
  "projectId": "{team_id}",
  "teamId": "{team_id}",
  "planId": null,
  "status": {
    "id": "{status_id}",
    "name": "Done",
    "category": "done",
    "color": "#000000"
  },
  "priority": "high",
  "assignee": {
    "id": "{user_id}",
    "name": "Ana",
    "email": "ana@example.com"
  },
  "creatorId": "{user_id}",
  "cycle": {
    "id": "{cycle_id}",
    "name": "Cycle 4"
  },
  "milestoneId": null,
  "parentId": null,
  "estimate": 3,
  "labels": [
    {
      "id": "{label_id}",
      "name": "bug",
      "color": "#d14343"
    }
  ],
  "startDate": null,
  "dueDate": "2026-11-04",
  "triage": false,
  "source": "api",
  "createdAt": "2026-10-25T14:02:11.000Z",
  "updatedAt": "2026-10-25T15:10:00.000Z"
}

Delete an issue

DELETE/api/v1/track/issues/{id}

Deletes the issue and its sub-issues.

Scope track:write

NameTypeRequiredDescription
idstringYesIssue id or identifier (WEB-12).
curl -X DELETE "https://zerosoft.ai/api/v1/track/issues/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "{issue_id}",
  "deleted": true
}

List comments

GET/api/v1/track/issues/{id}/comments

Comments of an issue, oldest first.

Scope track:read

NameTypeRequiredDescription
idstringYesIssue id or identifier (WEB-12).
curl -X GET "https://zerosoft.ai/api/v1/track/issues/{id}/comments" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "{comment_id}",
      "issueId": "{issue_id}",
      "body": "Reproduced on Safari 18.",
      "author": {
        "id": "{user_id}",
        "name": "Ana",
        "email": "ana@example.com"
      },
      "createdAt": "2026-10-25T15:00:00.000Z",
      "updatedAt": "2026-10-25T15:00:00.000Z"
    }
  ]
}

Add a comment

POST/api/v1/track/issues/{id}/comments

Comments as the key owner in markdown and notifies subscribers and mentions.

Scope track:write

NameTypeRequiredDescription
idstringYesIssue id or identifier (WEB-12).
bodystringYesComment in markdown.
curl -X POST "https://zerosoft.ai/api/v1/track/issues/{id}/comments" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "body": "Deployed the fix to staging."
}'

Request

{
  "body": "Deployed the fix to staging."
}

Response · 201

{
  "id": "{comment_id}",
  "issueId": "{issue_id}",
  "body": "Deployed the fix to staging.",
  "author": {
    "id": "{user_id}",
    "name": "Ana",
    "email": "ana@example.com"
  },
  "createdAt": "2026-10-25T16:00:00.000Z",
  "updatedAt": "2026-10-25T16:00:00.000Z"
}

List teams

GET/api/v1/track/teams

Active teams the key can see. includeArchived=true adds archived ones.

Scope track:read

curl -X GET "https://zerosoft.ai/api/v1/track/teams" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "{team_id}",
      "name": "Web",
      "key": "WEB",
      "description": "",
      "icon": null,
      "color": "#000000",
      "status": "active",
      "visibility": "workspace",
      "triageEnabled": true,
      "url": "https://zerosoft.ai/app/track/team/WEB",
      "createdAt": "2026-09-01T10:00:00.000Z",
      "updatedAt": "2026-10-20T10:00:00.000Z"
    }
  ]
}

Create a team

POST/api/v1/track/teams

Admins only. Creates the default statuses. key is the identifier prefix.

Scope track:write

NameTypeRequiredDescription
namestringYesName
keystringNoIdentifier prefix, letters and digits (WEB).
descriptionstringNoDescription
curl -X POST "https://zerosoft.ai/api/v1/track/teams" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "name": "Web",
  "key": "WEB"
}'

Request

{
  "name": "Web",
  "key": "WEB"
}

Response · 201

{
  "id": "{team_id}",
  "name": "Web",
  "key": "WEB",
  "description": "",
  "icon": null,
  "color": "#000000",
  "status": "active",
  "visibility": "workspace",
  "triageEnabled": true,
  "url": "https://zerosoft.ai/app/track/team/WEB",
  "createdAt": "2026-09-01T10:00:00.000Z",
  "updatedAt": "2026-10-20T10:00:00.000Z"
}

Get a team

GET/api/v1/track/teams/{id}

By id or key, with its statuses.

Scope track:read

NameTypeRequiredDescription
idstringYesTeam id or key (WEB). projectId also works.
curl -X GET "https://zerosoft.ai/api/v1/track/teams/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "id": "{team_id}",
  "name": "Web",
  "key": "WEB",
  "description": "",
  "icon": null,
  "color": "#000000",
  "status": "active",
  "visibility": "workspace",
  "triageEnabled": true,
  "url": "https://zerosoft.ai/app/track/team/WEB",
  "createdAt": "2026-09-01T10:00:00.000Z",
  "updatedAt": "2026-10-20T10:00:00.000Z",
  "statuses": [
    {
      "id": "{status_id}",
      "projectId": "{project_id}",
      "name": "Todo",
      "category": "todo",
      "color": "#000000",
      "position": 1
    }
  ]
}

Update a team

PATCH/api/v1/track/teams/{id}

Name, description, color and icon. Archiving and triage need an admin key.

Scope track:write

NameTypeRequiredDescription
idstringYesTeam id or key (WEB). projectId also works.
statusactive | archivedNoactive or archived.
curl -X PATCH "https://zerosoft.ai/api/v1/track/teams/{id}" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "description": "Marketing site and checkout"
}'

Request

{
  "description": "Marketing site and checkout"
}

Response · 200

{
  "id": "{team_id}",
  "name": "Web",
  "key": "WEB",
  "description": "",
  "icon": null,
  "color": "#000000",
  "status": "active",
  "visibility": "workspace",
  "triageEnabled": true,
  "url": "https://zerosoft.ai/app/track/team/WEB",
  "createdAt": "2026-09-01T10:00:00.000Z",
  "updatedAt": "2026-10-20T10:00:00.000Z"
}

List cycles

GET/api/v1/track/teams/{id}/cycles

Cycles of a team.

Scope track:read

NameTypeRequiredDescription
idstringYesTeam id or key (WEB). projectId also works.
curl -X GET "https://zerosoft.ai/api/v1/track/teams/{id}/cycles" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "{cycle_id}",
      "projectId": "{project_id}",
      "name": "Cycle 4",
      "startAt": "2026-10-20",
      "endAt": "2026-11-02",
      "completedAt": null
    }
  ]
}

Create a cycle

POST/api/v1/track/teams/{id}/cycles

Dates in YYYY-MM-DD.

Scope track:write

NameTypeRequiredDescription
namestringYesName
startAtstringYesDate, YYYY-MM-DD.
endAtstringYesDate, YYYY-MM-DD.
curl -X POST "https://zerosoft.ai/api/v1/track/teams/{id}/cycles" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "name": "Cycle 5",
  "startAt": "2026-11-03",
  "endAt": "2026-11-16"
}'

Request

{
  "name": "Cycle 5",
  "startAt": "2026-11-03",
  "endAt": "2026-11-16"
}

Response · 201

{
  "id": "{cycle_id}",
  "projectId": "{project_id}",
  "name": "Cycle 5",
  "startAt": "2026-11-03",
  "endAt": "2026-11-16",
  "completedAt": null
}

List statuses

GET/api/v1/track/teams/{id}/statuses

Workflow statuses of a team in order, with their category.

Scope track:read

NameTypeRequiredDescription
idstringYesTeam id or key (WEB). projectId also works.
curl -X GET "https://zerosoft.ai/api/v1/track/teams/{id}/statuses" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "{status_id}",
      "projectId": "{project_id}",
      "name": "In Progress",
      "category": "in_progress",
      "color": "#000000",
      "position": 2
    }
  ]
}

List labels

GET/api/v1/track/labels

Workspace labels. POST with name and teamId creates one.

Scope track:read

curl -X GET "https://zerosoft.ai/api/v1/track/labels" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "{label_id}",
      "name": "bug",
      "color": "#d14343",
      "workspaceId": "{workspace_id}"
    }
  ]
}

List people

GET/api/v1/track/users

People who can be assigned, of one team or all.

Scope track:read

NameTypeRequiredDescription
teamIdstringNoTeam id or key (WEB). projectId also works.
curl -X GET "https://zerosoft.ai/api/v1/track/users" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "{user_id}",
      "name": "Ana",
      "email": "ana@example.com",
      "role": "member"
    }
  ]
}

Track MCP server

Model Context Protocol over Streamable HTTP at /api/mcp/track (read-only at /api/mcp/track/readonly). Authenticate with an API key as Bearer. Tools: search_issues, get_issue, create_issue, update_issue, add_comment, list_teams, get_team, list_cycles, list_labels, list_users.

Call a tool

POST/api/mcp/track

JSON-RPC 2.0: initialize, tools/list and tools/call. Write tools need track:write.

Scope track:read

curl -X POST "https://zerosoft.ai/api/mcp/track" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_issues",
    "arguments": {
      "query": "checkout",
      "statusCategory": "in_progress"
    }
  }
}'

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_issues",
    "arguments": {
      "query": "checkout",
      "statusCategory": "in_progress"
    }
  }
}

Response · 200

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{ \"total\": 1, \"issues\": [ … ] }"
      }
    ],
    "isError": false
  }
}

Docs

Read and write Docs pages, blocks, databases, rows and comments. Content goes in and out as Markdown (or Docs blocks). A key acts as the person who created it: it only sees and edits the pages that person can open. Synced databases are read-only.

List pages

GET/api/v1/docs/pages

Pages the key can read, newest first. With q it searches titles and content.

Scope docs:read

NameTypeRequiredDescription
qstringNoSearch query.
parentstringNoOnly pages inside this page id (root for top-level pages).
limitnumberNoHow many to return (1 to 100, default 50).
offsetnumberNoHow many to skip, to page through results.
curl -X GET "https://zerosoft.ai/api/v1/docs/pages" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "pg_1",
      "title": "Launch plan",
      "icon": null,
      "parentId": null,
      "url": "/app/docs/pg_1",
      "createdAt": "2026-11-01T12:00:00.000Z",
      "updatedAt": "2026-11-02T09:30:00.000Z",
      "archived": false
    }
  ],
  "hasMore": false
}

Create a page

POST/api/v1/docs/pages

Creates a page from Markdown or blocks, inside another page (parentId) or from a template (a workspace template id or builtin:<key>). Template {{variables}} are filled from vars.

Scope docs:write

NameTypeRequiredDescription
titlestringNoPage title.
markdownstringNoContent in Markdown (headings, lists, to-dos, quotes, code, tables).
parentIdstringNoCreate it as a subpage of this page.
templateIdstringNoWorkspace template id or builtin:<key>.
curl -X POST "https://zerosoft.ai/api/v1/docs/pages" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "title": "Launch plan",
  "parentId": "pg_root",
  "markdown": "## Goals\n\n- [ ] Ship the beta"
}'

Request

{
  "title": "Launch plan",
  "parentId": "pg_root",
  "markdown": "## Goals\n\n- [ ] Ship the beta"
}

Response · 201

{
  "data": {
    "id": "pg_1",
    "title": "Launch plan",
    "icon": null,
    "parentId": null,
    "url": "/app/docs/pg_1",
    "createdAt": "2026-11-01T12:00:00.000Z",
    "updatedAt": "2026-11-02T09:30:00.000Z",
    "archived": false,
    "access": "owner",
    "markdown": "## Goals\n\n- [ ] Ship the beta",
    "databases": []
  }
}

Get a page

GET/api/v1/docs/pages/:id

The page with its content as Markdown and its databases. format=blocks also returns the blocks.

Scope docs:read

NameTypeRequiredDescription
formatstringNoblocks to also get the raw blocks.
curl -X GET "https://zerosoft.ai/api/v1/docs/pages/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": {
    "id": "pg_1",
    "title": "Launch plan",
    "icon": null,
    "parentId": null,
    "url": "/app/docs/pg_1",
    "createdAt": "2026-11-01T12:00:00.000Z",
    "updatedAt": "2026-11-02T09:30:00.000Z",
    "archived": false,
    "access": "edit",
    "markdown": "## Goals\n\n- [ ] Ship the beta",
    "databases": [
      {
        "blockId": "b_1",
        "title": "Tasks",
        "rows": 12,
        "synced": false
      }
    ]
  }
}

Update a page

PATCH/api/v1/docs/pages/:id

Changes the title or icon, replaces the content (databases on the page are kept) or moves it to the trash and back (archived).

Scope docs:write

NameTypeRequiredDescription
titlestringNoPage title.
markdownstringNoReplaces the whole content (databases are kept).
archivedbooleanNotrue moves it to the trash, false restores it.
curl -X PATCH "https://zerosoft.ai/api/v1/docs/pages/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "title": "Launch plan (Q4)"
}'

Request

{
  "title": "Launch plan (Q4)"
}

Response · 200

{
  "data": {
    "id": "pg_1",
    "title": "Launch plan (Q4)",
    "icon": null,
    "parentId": null,
    "url": "/app/docs/pg_1",
    "createdAt": "2026-11-01T12:00:00.000Z",
    "updatedAt": "2026-11-02T09:30:00.000Z",
    "archived": false,
    "access": "owner",
    "markdown": "",
    "databases": []
  }
}

Move a page to the trash

DELETE/api/v1/docs/pages/:id

Moves the page and its subpages to the trash. Restore it with PATCH archived: false.

Scope docs:write

curl -X DELETE "https://zerosoft.ai/api/v1/docs/pages/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

List blocks

GET/api/v1/docs/pages/:id/blocks

The blocks of a page in Docs format (type, content as HTML-lite, nesting with indent).

Scope docs:read

curl -X GET "https://zerosoft.ai/api/v1/docs/pages/:id/blocks" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "b_1",
      "type": "heading",
      "level": 2,
      "content": "Goals"
    },
    {
      "id": "b_2",
      "type": "todo",
      "content": "Ship the beta",
      "checked": false
    }
  ]
}

Append blocks

POST/api/v1/docs/pages/:id/blocks

Adds Markdown or blocks at the end of the page, or below the block in after. People with the page open see it merged into their editor.

Scope docs:write

NameTypeRequiredDescription
markdownstringNoContent in Markdown (headings, lists, to-dos, quotes, code, tables).
blocksobject[]NoBlocks in Docs format (instead of Markdown).
afterstringNoInsert below this block id.
curl -X POST "https://zerosoft.ai/api/v1/docs/pages/:id/blocks" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "markdown": "- [ ] Write the release notes"
}'

Request

{
  "markdown": "- [ ] Write the release notes"
}

Response · 201

{
  "data": {
    "id": "pg_1",
    "title": "Launch plan",
    "icon": null,
    "parentId": null,
    "url": "/app/docs/pg_1",
    "createdAt": "2026-11-01T12:00:00.000Z",
    "updatedAt": "2026-11-02T09:30:00.000Z",
    "archived": false,
    "access": "owner",
    "markdown": "- [ ] Write the release notes",
    "databases": []
  }
}

List comments

GET/api/v1/docs/pages/:id/comments

Comments and threads of a page.

Scope docs:read

curl -X GET "https://zerosoft.ai/api/v1/docs/pages/:id/comments" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "cm_1",
      "pageId": "pg_1",
      "blockId": null,
      "parentId": null,
      "text": "Can we ship this in May?",
      "resolved": false,
      "author": {
        "id": "u_1",
        "name": "Ada",
        "email": "ada@example.com"
      },
      "createdAt": "2026-11-02T10:00:00.000Z"
    }
  ]
}

Add a comment

POST/api/v1/docs/pages/:id/comments

Comments on the page or a block, or replies to a thread, as the person who created the key.

Scope docs:write

NameTypeRequiredDescription
textstringYesComment text.
blockIdstringNoComment on this block.
parentIdstringNoReply in the thread of this comment.
curl -X POST "https://zerosoft.ai/api/v1/docs/pages/:id/comments" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "text": "Done, the beta is live."
}'

Request

{
  "text": "Done, the beta is live."
}

Response · 201

{
  "data": {
    "id": "cm_2",
    "pageId": "pg_1",
    "blockId": null,
    "parentId": null,
    "text": "Done, the beta is live.",
    "resolved": false,
    "author": {
      "id": "u_1",
      "name": "Ada",
      "email": "ada@example.com"
    },
    "createdAt": "2026-11-02T11:00:00.000Z"
  }
}

List databases

GET/api/v1/docs/databases

Databases on the pages the key can read, with their properties and options.

Scope docs:read

NameTypeRequiredDescription
qstringNoSearch query.
curl -X GET "https://zerosoft.ai/api/v1/docs/databases" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "pageId": "pg_1",
      "blockId": "b_1",
      "title": "Tasks",
      "page": {
        "id": "pg_1",
        "title": "Launch plan"
      },
      "synced": null,
      "properties": [
        {
          "id": "title",
          "name": "Name",
          "type": "title"
        },
        {
          "id": "status",
          "name": "Status",
          "type": "status",
          "options": [
            "Not started",
            "In progress",
            "Done"
          ]
        }
      ],
      "rowCount": 12
    }
  ]
}

Get a database

GET/api/v1/docs/databases/:pageId/:blockId

Properties of a database and, for synced databases, where they come from.

Scope docs:read

curl -X GET "https://zerosoft.ai/api/v1/docs/databases/:pageId/:blockId" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": {
    "pageId": "pg_1",
    "blockId": "b_1",
    "title": "Issues",
    "page": {
      "id": "pg_1",
      "title": "Engineering"
    },
    "synced": {
      "provider": "github",
      "label": "acme/web · Issues",
      "syncedAt": "2026-11-02T10:15:00.000Z"
    },
    "properties": [
      {
        "id": "title",
        "name": "Title",
        "type": "title"
      }
    ],
    "rowCount": 40
  }
}

Query rows

GET/api/v1/docs/databases/:pageId/:blockId/rows

Rows of a database with their properties as text (properties) and raw values (values). filter[Property]=text keeps the rows whose value contains it.

Scope docs:read

NameTypeRequiredDescription
qstringNoSearch query.
filter[Property]stringNoKeep rows whose Property contains the text.
limitnumberNoHow many to return (1 to 100, default 50).
offsetnumberNoHow many to skip, to page through results.
curl -X GET "https://zerosoft.ai/api/v1/docs/databases/:pageId/:blockId/rows" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "r_1",
      "title": "Website refresh",
      "url": "/app/docs/pg_1?row=r_1",
      "properties": {
        "Status": "In progress",
        "Owner": "Ada"
      },
      "values": {
        "Status": "opt_2",
        "Owner": [
          "u_1"
        ]
      },
      "createdAt": "2026-11-01T12:00:00.000Z",
      "updatedAt": "2026-11-02T09:00:00.000Z"
    }
  ],
  "total": 1,
  "hasMore": false
}

Add a row

POST/api/v1/docs/databases/:pageId/:blockId/rows

Adds a row. properties maps property names (or ids) to values: select options are created if missing, people go by email, dates as YYYY-MM-DD. Database automations run as usual.

Scope docs:write

NameTypeRequiredDescription
titlestringNoRow title.
propertiesobjectNoProperty name or id → value.
markdownstringNoRow content in Markdown.
templatestringNoRow template of the database (id or name).
curl -X POST "https://zerosoft.ai/api/v1/docs/databases/:pageId/:blockId/rows" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "title": "Website refresh",
  "properties": {
    "Status": "In progress",
    "Owner": "ada@example.com",
    "Tags": [
      "web",
      "q4"
    ]
  }
}'

Request

{
  "title": "Website refresh",
  "properties": {
    "Status": "In progress",
    "Owner": "ada@example.com",
    "Tags": [
      "web",
      "q4"
    ]
  }
}

Response · 201

{
  "data": {
    "id": "r_2",
    "title": "Website refresh",
    "url": "/app/docs/pg_1?row=r_2",
    "properties": {
      "Status": "In progress",
      "Owner": "Ada",
      "Tags": "web, q4"
    },
    "values": {},
    "createdAt": "2026-11-02T12:00:00.000Z",
    "updatedAt": "2026-11-02T12:00:00.000Z"
  }
}

Get a row

GET/api/v1/docs/databases/:pageId/:blockId/rows/:rowId

One row with its properties and its content as Markdown.

Scope docs:read

curl -X GET "https://zerosoft.ai/api/v1/docs/databases/:pageId/:blockId/rows/:rowId" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": {
    "id": "r_1",
    "title": "Website refresh",
    "url": "/app/docs/pg_1?row=r_1",
    "properties": {
      "Status": "In progress"
    },
    "values": {},
    "markdown": "Brief and links.",
    "createdAt": "2026-11-01T12:00:00.000Z",
    "updatedAt": "2026-11-02T09:00:00.000Z"
  }
}

Update a row

PATCH/api/v1/docs/databases/:pageId/:blockId/rows/:rowId

Changes properties, the title or the content of a row.

Scope docs:write

NameTypeRequiredDescription
propertiesobjectNoProperty name or id → value.
titlestringNoRow title.
appendMarkdownstringNoMarkdown to add at the end of the row content.
curl -X PATCH "https://zerosoft.ai/api/v1/docs/databases/:pageId/:blockId/rows/:rowId" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "properties": {
    "Status": "Done"
  }
}'

Request

{
  "properties": {
    "Status": "Done"
  }
}

Response · 200

{
  "data": {
    "id": "r_1",
    "title": "Website refresh",
    "url": "/app/docs/pg_1?row=r_1",
    "properties": {
      "Status": "Done"
    },
    "values": {},
    "createdAt": "2026-11-01T12:00:00.000Z",
    "updatedAt": "2026-11-02T13:00:00.000Z"
  }
}

Delete a row

DELETE/api/v1/docs/databases/:pageId/:blockId/rows/:rowId

Deletes the row. It stays in the page history.

Scope docs:write

curl -X DELETE "https://zerosoft.ai/api/v1/docs/databases/:pageId/:blockId/rows/:rowId" \
  -H "Authorization: Bearer zs_live_9f3k..."

MCP server

POST/api/v1/docs/mcp

Model Context Protocol over streamable HTTP (JSON-RPC). Methods: initialize, tools/list, tools/call. Tools: search, fetch_page, create_page, update_page, list_databases, get_database, query_database, get_row, create_row, update_row, list_comments, add_comment. Write tools need docs:write.

Scope docs:read

curl -X POST "https://zerosoft.ai/api/v1/docs/mcp" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search",
    "arguments": {
      "query": "launch plan"
    }
  }
}'

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search",
    "arguments": {
      "query": "launch plan"
    }
  }
}

Response · 200

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"results\":[...]}"
      }
    ],
    "isError": false
  }
}

Notes

Read and write your notes. A key acts as the person who created it and only sees that person's notes. Locked notes return no content.

List notes

GET/api/v1/notes

Your notes, most recent first. q accepts the same operators as the app (tag:, notebook:, intitle:, todo:).

Scope notes:read

curl -X GET "https://zerosoft.ai/api/v1/notes" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "note_1",
      "title": "Weekly review",
      "snippet": "Send the report",
      "notebookId": null,
      "tags": [
        "work"
      ],
      "pinned": false,
      "trashed": false,
      "locked": false,
      "sourceUrl": null,
      "createdAt": "2026-11-01T12:00:00.000Z",
      "updatedAt": "2026-11-02T09:30:00.000Z"
    }
  ],
  "hasMore": false
}

Create a note

POST/api/v1/notes

Creates a note from Markdown or blocks.

Scope notes:write

curl -X POST "https://zerosoft.ai/api/v1/notes" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "title": "Weekly review",
  "markdown": "- [ ] Send the report",
  "tags": [
    "work"
  ]
}'

Request

{
  "title": "Weekly review",
  "markdown": "- [ ] Send the report",
  "tags": [
    "work"
  ]
}

Response · 201

{
  "data": {
    "id": "note_1",
    "title": "Weekly review",
    "snippet": "Send the report",
    "notebookId": null,
    "tags": [
      "work"
    ],
    "pinned": false,
    "trashed": false,
    "locked": false,
    "sourceUrl": null,
    "createdAt": "2026-11-01T12:00:00.000Z",
    "updatedAt": "2026-11-02T09:30:00.000Z",
    "markdown": "- [ ] Send the report"
  }
}

Get a note

GET/api/v1/notes/:id

A note with its content as Markdown and blocks.

Scope notes:read

curl -X GET "https://zerosoft.ai/api/v1/notes/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": {
    "id": "note_1",
    "title": "Weekly review",
    "snippet": "Send the report",
    "notebookId": null,
    "tags": [
      "work"
    ],
    "pinned": false,
    "trashed": false,
    "locked": false,
    "sourceUrl": null,
    "createdAt": "2026-11-01T12:00:00.000Z",
    "updatedAt": "2026-11-02T09:30:00.000Z",
    "markdown": "- [ ] Send the report"
  }
}

Update a note

PATCH/api/v1/notes/:id

Changes the title, tags, notebook, pin or content.

Scope notes:write

curl -X PATCH "https://zerosoft.ai/api/v1/notes/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "title": "Weekly review (done)",
  "pinned": true
}'

Request

{
  "title": "Weekly review (done)",
  "pinned": true
}

Response · 200

{
  "data": {
    "id": "note_1",
    "title": "Weekly review",
    "snippet": "Send the report",
    "notebookId": null,
    "tags": [
      "work"
    ],
    "pinned": true,
    "trashed": false,
    "locked": false,
    "sourceUrl": null,
    "createdAt": "2026-11-01T12:00:00.000Z",
    "updatedAt": "2026-11-02T09:30:00.000Z"
  }
}

Trash a note

DELETE/api/v1/notes/:id

Moves the note to the trash.

Scope notes:write

curl -X DELETE "https://zerosoft.ai/api/v1/notes/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": {
    "id": "note_1",
    "trashed": true
  }
}

List notebooks

GET/api/v1/notes/notebooks

Your notebooks with their note counts.

Scope notes:read

curl -X GET "https://zerosoft.ai/api/v1/notes/notebooks" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "nb_1",
      "name": "Work",
      "count": 12,
      "stack": null
    }
  ]
}

MCP server

POST/api/v1/notes/mcp

Model Context Protocol endpoint. Tools: search_notes, read_note, list_notebooks, list_tasks, create_note and update_note.

Scope notes:read

curl -X POST "https://zerosoft.ai/api/v1/notes/mcp" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_notes",
    "arguments": {
      "query": "tag:work"
    }
  }
}'

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_notes",
    "arguments": {
      "query": "tag:work"
    }
  }
}

Response · 200

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"notes\":[...]}"
      }
    ],
    "isError": false
  }
}

Talk

Team messaging. The key acts as the person who created it: it sees the channels that person sees and posts where that person is a member (joining public channels on the first post). Direct messages are not available through the API. Scopes talk:read and talk:write.

List channels

GET/api/v1/talk/channels

Channels the key person is in, or with scope=all the public channels and the private ones they are in.

Scope talk:read

NameTypeRequiredDescription
scopestringNomember (default) or all
qstringNoSearch query.
curl -X GET "https://zerosoft.ai/api/v1/talk/channels" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "tc_1",
      "name": "general",
      "kind": "public",
      "topic": "Company news",
      "description": "",
      "archived": false,
      "member_count": 8,
      "is_member": true,
      "created_at": "2026-10-25T12:00:00.000Z"
    }
  ]
}

Create a channel

POST/api/v1/talk/channels

Creates a public or private channel. The name is stored like Slack: lowercase, with hyphens instead of spaces.

Scope talk:write

NameTypeRequiredDescription
namestringYesChannel name
kindstringNopublic (default) or private
topicstringNoChannel topic
curl -X POST "https://zerosoft.ai/api/v1/talk/channels" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "name": "launch-q4",
  "kind": "public",
  "topic": "Q4 launch"
}'

Request

{
  "name": "launch-q4",
  "kind": "public",
  "topic": "Q4 launch"
}

Response · 201

{
  "data": {
    "id": "tc_2",
    "name": "launch-q4",
    "kind": "public",
    "topic": "Q4 launch",
    "description": "",
    "archived": false,
    "member_count": 1,
    "is_member": true,
    "created_at": "2026-10-25T12:00:00.000Z"
  }
}

List messages

GET/api/v1/talk/messages

Channel level messages, newest last. Mentions come as tokens with the user id, plus channel and here tokens.

Scope talk:read

NameTypeRequiredDescription
channelstringYesChannel id or name (general or #general)
beforestringNoISO date: messages before it (for paging)
limitnumberNoMaximum number of results.
curl -X GET "https://zerosoft.ai/api/v1/talk/messages" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "tm_1",
      "channel_id": "tc_1",
      "thread_id": null,
      "user_id": "u_1",
      "bot_name": null,
      "text": "Deploy done <@u_2>",
      "files": [],
      "reactions": [
        {
          "emoji": "🎉",
          "count": 2,
          "users": [
            "u_2",
            "u_3"
          ]
        }
      ],
      "reply_count": 1,
      "edited_at": null,
      "pinned": false,
      "created_at": "2026-10-25T12:05:00.000Z"
    }
  ],
  "has_more": false
}

Send a message

POST/api/v1/talk/messages

Posts in a channel or replies in a thread. Mentions, notifications, link previews, Flow and webhooks run as if it were sent from the app.

Scope talk:write

NameTypeRequiredDescription
channelstringYesChannel id or name (general or #general)
textstringYesMessage text, with the same formatting as the app (*bold*, _italic_, `code`, links, :emoji:)
thread_idstringNoId of the root message to reply in its thread
also_in_channelbooleanNoWith thread_id, also show the reply in the channel
curl -X POST "https://zerosoft.ai/api/v1/talk/messages" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "channel": "general",
  "text": "Release *2.4* is live :tada:"
}'

Request

{
  "channel": "general",
  "text": "Release *2.4* is live :tada:"
}

Response · 201

{
  "data": {
    "id": "tm_2",
    "channel_id": "tc_1",
    "thread_id": null,
    "user_id": "u_1",
    "bot_name": null,
    "text": "Release *2.4* is live :tada:",
    "files": [],
    "reactions": [],
    "reply_count": 0,
    "edited_at": null,
    "pinned": false,
    "created_at": "2026-10-25T12:06:00.000Z"
  }
}

Incoming webhook

POST/api/talk/hooks/:token

Without an API key: create the URL in a channel (Details, Integrations) and POST JSON with text. It posts as a bot with the webhook name. 60 requests per minute per webhook.

NameTypeRequiredDescription
textstringYesMessage text, with the same formatting as the app (*bold*, _italic_, `code`, links, :emoji:)
usernamestringNoBot name shown on the message (by default, the webhook name)
thread_idstringNoId of the root message to reply in its thread
curl -X POST "https://zerosoft.ai/api/talk/hooks/:token" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "text": "Build *green* on main",
  "username": "CI"
}'

Request

{
  "text": "Build *green* on main",
  "username": "CI"
}

Response · 200

{
  "ok": true,
  "id": "tm_3"
}

Board

Whiteboards: list and search them (also by the text inside), read an outline, create them from a template, add stickies, shapes and arrows, rename, move to a folder or send to the trash. The key acts as the person who created it: it sees and edits the boards that person can open. People with the board open see the changes live. Scopes boards:read and boards:write.

List boards

GET/api/v1/boards

Boards the key person can open, most recently edited first. With q it also searches stickies, labels and frame names, and returns the matching line in match.

Scope boards:read

NameTypeRequiredDescription
qstringNoSearch the name and the text inside the board.
folderstringNoFolder id.
limitnumberNoMaximum number of results.
curl -X GET "https://zerosoft.ai/api/v1/boards" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "b_1",
      "name": "Q4 retro",
      "folderId": null,
      "access": "workspace",
      "version": 12,
      "updatedAt": "2026-10-28T12:00:00.000Z",
      "createdAt": "2026-10-20T09:00:00.000Z",
      "updatedBy": "Ana"
    }
  ]
}

Create a board

POST/api/v1/boards

Empty or from a template: retro, brainstorm, userFlow, kanban, roadmap, swot, mindMap, priorityMatrix, journey or leanCanvas.

Scope boards:write

NameTypeRequiredDescription
namestringNoBoard name.
templatestringNoTemplate key.
folderIdstringNoFolder id.
curl -X POST "https://zerosoft.ai/api/v1/boards" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "name": "Q4 retro",
  "template": "retro",
  "locale": "en"
}'

Request

{
  "name": "Q4 retro",
  "template": "retro",
  "locale": "en"
}

Response · 201

{
  "data": {
    "id": "b_1",
    "name": "Q4 retro",
    "folderId": null,
    "access": "workspace",
    "version": 12,
    "updatedAt": "2026-10-28T12:00:00.000Z",
    "createdAt": "2026-10-20T09:00:00.000Z",
    "updatedBy": "Ana"
  }
}

Get a board

GET/api/v1/boards/:id

The board with an outline: frames in reading order, stickies with text and tags, loose texts. With scene=1, also the Excalidraw scene.

Scope boards:read

NameTypeRequiredDescription
scenestringNoUse 1 to include the Excalidraw scene.
curl -X GET "https://zerosoft.ai/api/v1/boards/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": {
    "id": "b_1",
    "name": "Q4 retro",
    "folderId": null,
    "access": "workspace",
    "version": 12,
    "updatedAt": "2026-10-28T12:00:00.000Z",
    "createdAt": "2026-10-20T09:00:00.000Z",
    "updatedBy": "Ana",
    "myAccess": "edit",
    "outline": {
      "frames": [
        {
          "id": "f_1",
          "name": "Agenda"
        }
      ],
      "stickies": [
        {
          "id": "s_1",
          "text": "Ship the beta",
          "tags": [
            "launch"
          ],
          "frameId": null
        }
      ],
      "texts": [],
      "elementCount": 14
    }
  }
}

Update a board

PATCH/api/v1/boards/:id

Renames the board or moves it to a folder (folderId null takes it out).

Scope boards:write

NameTypeRequiredDescription
namestringNoBoard name.
folderIdstringNoFolder id.
curl -X PATCH "https://zerosoft.ai/api/v1/boards/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "name": "Q4 retro (final)"
}'

Request

{
  "name": "Q4 retro (final)"
}

Response · 200

{
  "data": {
    "id": "b_1",
    "name": "Q4 retro (final)",
    "folderId": null,
    "access": "workspace",
    "version": 12,
    "updatedAt": "2026-10-28T12:00:00.000Z",
    "createdAt": "2026-10-20T09:00:00.000Z",
    "updatedBy": "Ana"
  }
}

Delete a board

DELETE/api/v1/boards/:id

Moves the board to the trash. It can be restored from the app for 30 days.

Scope boards:write

curl -X DELETE "https://zerosoft.ai/api/v1/boards/:id" \
  -H "Authorization: Bearer zs_live_9f3k..."

Add stickies and shapes

POST/api/v1/boards/:id/elements

Adds stickies, texts and shapes, and arrows between them by index. Without x and y they are laid out next to the existing content. Nothing already on the board is changed.

Scope boards:write

NameTypeRequiredDescription
stickiesarrayNoSticky notes: { text, color?, tags? }. Colors: yellow, green, blue, pink, violet, orange.
elementsarrayNoShapes and texts: { kind, text?, x?, y?, width?, height?, fill? } with kind sticky, text, rectangle, ellipse or diamond.
connectarrayNoArrows between elements by index: { from, to }.
curl -X POST "https://zerosoft.ai/api/v1/boards/:id/elements" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "elements": [
    {
      "kind": "ellipse",
      "text": "Start"
    },
    {
      "kind": "rectangle",
      "text": "Sign up"
    }
  ],
  "connect": [
    {
      "from": 0,
      "to": 1
    }
  ]
}'

Request

{
  "elements": [
    {
      "kind": "ellipse",
      "text": "Start"
    },
    {
      "kind": "rectangle",
      "text": "Sign up"
    }
  ],
  "connect": [
    {
      "from": 0,
      "to": 1
    }
  ]
}

Response · 201

{
  "data": {
    "version": 13,
    "added": [
      {
        "id": "e_1",
        "type": "ellipse"
      },
      {
        "id": "e_2",
        "type": "rectangle"
      },
      {
        "id": "e_3",
        "type": "arrow"
      }
    ]
  }
}

MCP server

POST/api/v1/boards/mcp

Model Context Protocol (streamable HTTP, JSON responses) for AI agents. Tools: list_boards, get_board, create_board, add_stickies, add_diagram, update_board and trash_board.

Scope boards:read

curl -X POST "https://zerosoft.ai/api/v1/boards/mcp" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_stickies",
    "arguments": {
      "board_id": "b_1",
      "stickies": [
        {
          "text": "Ship the beta",
          "color": "green"
        }
      ]
    }
  }
}'

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_stickies",
    "arguments": {
      "board_id": "b_1",
      "stickies": [
        {
          "text": "Ship the beta",
          "color": "green"
        }
      ]
    }
  }
}

Response · 200

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"version\":13,\"added\":[...]}"
      }
    ],
    "isError": false
  }
}

Design

Read the designs the key’s person can see: names, sizes, pages and, with id, the full JSON of the pages.

List or read designs

GET/api/v1/design

Without id, the designs the person can see (most recent first). With id, that design with its pages in JSON.

Scope design:read

NameTypeRequiredDescription
qstringNoSearch query.
viewstringNorecent (default), mine, shared, starred or templates
idstringNoA design id: returns that design with its pages
curl -X GET "https://zerosoft.ai/api/v1/design" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "d_1",
      "name": "Summer sale",
      "width": 1080,
      "height": 1080,
      "pages": 1,
      "owner": "Ana",
      "access": "owner",
      "starred": false,
      "template": false,
      "updated_at": "2026-10-29T12:00:00.000Z",
      "url": "https://zerosoft.ai/en/app/design/d_1"
    }
  ]
}

Shop

Your store’s catalog and orders. Scopes shop:read and shop:write. Customer data is only available to keys of people with the Shop app.

List products

GET/api/v1/shop/products

Products with status, price range, variant count and stock. POST to the same path creates a product with the same body the app uses.

NameTypeRequiredDescription
qstringNoSearch query.
limitnumberNoMaximum number of results.
curl -X GET "https://zerosoft.ai/api/v1/shop/products" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "prod_1",
      "handle": "blue-mug",
      "title": "Blue mug",
      "status": "active",
      "variants": 2,
      "stock": 14,
      "tracked": true,
      "minPriceCents": 1900,
      "maxPriceCents": 2100
    }
  ],
  "total": 1
}

List orders

GET/api/v1/shop/orders

Orders newest first, with status (pending, paid, fulfilled, cancelled, refunded) and total in cents.

NameTypeRequiredDescription
qstringNoSearch query.
limitnumberNoMaximum number of results.
curl -X GET "https://zerosoft.ai/api/v1/shop/orders" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "ord_1",
      "number": 1001,
      "status": "paid",
      "email": "ana@example.com",
      "name": "Ana Pérez",
      "totalCents": 4100,
      "currency": "USD",
      "paymentMethod": "stripe",
      "items": 2,
      "createdAt": "2026-10-29 15:00:00"
    }
  ],
  "total": 1
}

Pulse

Product analytics. The ingest endpoints (/api/ingest/*) take the project key, not an API key: the public key (zsp_…) in the body from a browser, or the project secret key as Bearer zss_… from a server. Query endpoints accept a signed-in session or an API key with analytics:read.

Capture events

POST/api/ingest/e

One event or a batch of up to 200, 512 KB per request. With the secret key as Bearer there is no origin check. Events with a repeated uuid are ignored. Rate limited per project.

NameTypeRequiredDescription
api_keystringNoProject public key (zsp_…). Also accepted as token.
batcharrayYesEvents: event, distinct_id, properties, timestamp and an optional uuid. A single event can go at the top level instead.
sent_atstringNoWhen the client sent the batch; used to correct its clock.
curl -X POST "https://zerosoft.ai/api/ingest/e" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "api_key": "zsp_…",
  "batch": [
    {
      "event": "signed_up",
      "distinct_id": "user_42",
      "properties": {
        "plan": "team"
      },
      "timestamp": "2026-10-29T12:00:00.000Z"
    }
  ]
}'

Request

{
  "api_key": "zsp_…",
  "batch": [
    {
      "event": "signed_up",
      "distinct_id": "user_42",
      "properties": {
        "plan": "team"
      },
      "timestamp": "2026-10-29T12:00:00.000Z"
    }
  ]
}

Response · 200

{
  "status": 1,
  "stored": 1,
  "dropped": 0
}

Feature flags for a person

POST/api/ingest/decide

Values of the active flags for a distinct_id (true, false or the variant key) and the snippet settings. person_properties is added to what the person already has.

NameTypeRequiredDescription
api_keystringYesProject public key (zsp_…). Also accepted as token.
distinct_idstringYesThe id of the person in your product.
person_propertiesobjectNoExtra person properties for this evaluation.
curl -X POST "https://zerosoft.ai/api/ingest/decide" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "api_key": "zsp_…",
  "distinct_id": "user_42"
}'

Request

{
  "api_key": "zsp_…",
  "distinct_id": "user_42"
}

Response · 200

{
  "featureFlags": {
    "new-checkout": true,
    "pricing-test": "variant-b"
  },
  "config": {
    "autocapture": true,
    "respectDnt": true
  }
}

Delete a person

POST/api/ingest/delete

Deletes the person behind a distinct_id with all their events and sessions. Needs the project secret key as Bearer zss_….

NameTypeRequiredDescription
distinct_idstringYesThe id of the person in your product.
curl -X POST "https://zerosoft.ai/api/ingest/delete" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "distinct_id": "user_42"
}'

Request

{
  "distinct_id": "user_42"
}

Response · 200

{
  "deleted": true,
  "events": 128
}

Run a query

POST/api/analytics/query

kind is trends, funnel, retention, paths, sql or web. SQL is read-only over the project tables events, persons, person_distinct_ids and sessions, up to 1,000 rows.

Scope analytics:read

NameTypeRequiredDescription
projectIdstringYesProject id (ap_…).
queryobjectYesThe query definition, the same one the app saves for an insight.
curl -X POST "https://zerosoft.ai/api/analytics/query" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "projectId": "ap_…",
  "query": {
    "kind": "trends",
    "series": [
      {
        "event": "$pageview",
        "math": "unique"
      }
    ],
    "interval": "day",
    "dateRange": {
      "from": "-7d"
    }
  }
}'

Request

{
  "projectId": "ap_…",
  "query": {
    "kind": "trends",
    "series": [
      {
        "event": "$pageview",
        "math": "unique"
      }
    ],
    "interval": "day",
    "dateRange": {
      "from": "-7d"
    }
  }
}

Response · 200

{
  "result": {
    "kind": "trends",
    "buckets": [
      "2026-10-23",
      "2026-10-24"
    ],
    "series": [
      {
        "label": "$pageview (unique users)",
        "breakdownValue": null,
        "data": [
          120,
          134
        ],
        "total": 231
      }
    ],
    "usedRollup": true
  }
}

List events

GET/api/analytics/events

Latest events of a project, newest first. Pass after with the last id you saw to get only new ones.

Scope analytics:read

NameTypeRequiredDescription
projectstringYesProject id (ap_…).
eventstringNoOnly this event name.
afternumberNoOnly events with a larger id.
limitnumberNoMaximum number of results.
curl -X GET "https://zerosoft.ai/api/analytics/events" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "events": [
    {
      "id": 981,
      "event": "$pageview",
      "distinctId": "user_42",
      "ts": 1761739200000,
      "url": "https://example.com/pricing",
      "pathname": "/pricing",
      "browser": "Chrome",
      "os": "macOS",
      "device": "desktop",
      "country": "AR",
      "properties": {}
    }
  ]
}

List persons

GET/api/analytics/persons

Persons of a project with their properties and distinct ids, most recently seen first.

Scope analytics:read

NameTypeRequiredDescription
projectstringYesProject id (ap_…).
qstringNoSearch query.
cohortstringNoOnly persons in this cohort id.
curl -X GET "https://zerosoft.ai/api/analytics/persons" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "persons": [
    {
      "id": "p_3f…",
      "distinctIds": [
        "user_42"
      ],
      "properties": {
        "email": "ana@example.com"
      },
      "isIdentified": true,
      "createdAt": 1761000000000,
      "lastSeen": 1761739200000
    }
  ],
  "hasMore": false
}

Social

Social media posts. The key acts as the person who created it: it sees and posts to that person's accounts, and people who need approval send posts for approval. Scopes social:read and social:write.

List posts

GET/api/v1/social/posts

Posts the key can see, newest first, with each account's status and the link to the published post.

NameTypeRequiredDescription
statusstringNodraft, pending_approval, scheduled, published, partial or failed.
fromstringNoFrom this date (ISO 8601).
tostringNoUntil this date (ISO 8601).
curl -X GET "https://zerosoft.ai/api/v1/social/posts" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "sp_1",
      "text": "Launch day #launch",
      "status": "published",
      "scheduled_at": "2026-11-03T13:00:00.000Z",
      "published_at": "2026-11-03T13:00:12.000Z",
      "targets": [
        {
          "account_id": "sa_1",
          "network": "linkedin",
          "status": "published",
          "url": "https://www.linkedin.com/feed/update/urn:li:share:1",
          "error": null
        }
      ],
      "created_at": "2026-11-01T10:00:00.000Z"
    }
  ]
}

Create a post

POST/api/v1/social/posts

Saves a draft, schedules it, adds it to the queue or publishes it now. Each network checks length and media first; errors come back per account.

NameTypeRequiredDescription
textstringYesText of the post.
accountIdsstring[]YesIds of the connected accounts to post to.
overridesobjectNoOwn text per account: { accountId: text }.
actionstringNodraft, schedule, queue or now. Default draft.
scheduledAtstringNoDate and time to publish (ISO 8601), with action schedule.
curl -X POST "https://zerosoft.ai/api/v1/social/posts" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "text": "Launch day #launch",
  "accountIds": [
    "sa_1"
  ],
  "action": "schedule",
  "scheduledAt": "2026-11-03T13:00:00.000Z"
}'

Request

{
  "text": "Launch day #launch",
  "accountIds": [
    "sa_1"
  ],
  "action": "schedule",
  "scheduledAt": "2026-11-03T13:00:00.000Z"
}

Response · 201

{
  "data": {
    "id": "sp_2",
    "text": "Launch day #launch",
    "status": "scheduled",
    "scheduled_at": "2026-11-03T13:00:00.000Z",
    "published_at": null,
    "targets": [
      {
        "account_id": "sa_1",
        "network": "linkedin",
        "status": "pending",
        "url": null,
        "error": null
      }
    ],
    "created_at": "2026-11-01T10:00:00.000Z"
  }
}

Books

Invoices from Books. The key acts as the person who created it, with that person’s Books role. Amounts are integers in the currency’s minor unit (cents). Scopes books:read and books:write.

List invoices

GET/api/v1/books/invoices

Invoices, newest first, with status, number, customer, total and amount due.

NameTypeRequiredDescription
statusstringNodraft, sent, partial, paid, overdue, void, or open (anything still due).
qstringNoSearch query.
limitnumberNoMaximum number of results.
curl -X GET "https://zerosoft.ai/api/v1/books/invoices" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "inv_1",
      "docType": "invoice",
      "status": "sent",
      "numberLabel": "B 00001-00000012",
      "reference": "PO 778",
      "contactId": "con_1",
      "contactName": "Acme SA",
      "issueDate": "2026-11-01",
      "dueDate": "2026-12-01",
      "currency": "ARS",
      "total": 12100000,
      "amountDue": 12100000,
      "sentAt": "2026-11-01 12:00:00",
      "updatedAt": "2026-11-01 12:00:00"
    }
  ],
  "total": 1
}

Create a draft invoice

POST/api/v1/books/invoices

Saves a draft with the same body the app uses. Someone approves it in the app, which assigns the number and posts the journal.

NameTypeRequiredDescription
contactIdstringNoBooks contact id of the customer.
linesobject[]YesLines: description, quantity, unitPrice (integer minor units, or a decimal string with a dot as the decimal separator, e.g. "1500.50", whatever the currency), discountBps, taxRateId, itemId.
currencystringNoISO currency code; the base currency if omitted.
fxRatestringNoManual exchange rate (base currency per 1 unit) when the currency is not the base one.
referencestringNoYour reference (purchase order, project).
curl -X POST "https://zerosoft.ai/api/v1/books/invoices" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "contactId": "con_1",
  "reference": "PO 778",
  "lines": [
    {
      "description": "Consulting",
      "quantity": 10,
      "unitPrice": "1000.00",
      "taxRateId": "tax_iva21"
    }
  ]
}'

Request

{
  "contactId": "con_1",
  "reference": "PO 778",
  "lines": [
    {
      "description": "Consulting",
      "quantity": 10,
      "unitPrice": "1000.00",
      "taxRateId": "tax_iva21"
    }
  ]
}

Response · 201

{
  "data": {
    "id": "inv_2",
    "docType": "invoice",
    "status": "draft",
    "numberLabel": "",
    "total": 1210000,
    "currency": "ARS",
    "lines": [
      {
        "description": "Consulting",
        "quantity": 10,
        "unitPrice": 100000,
        "taxBps": 2100,
        "net": 1000000,
        "tax": 210000,
        "total": 1210000
      }
    ]
  }
}

Forms

Forms and their responses. The key acts as the person who created it and only sees the forms that person can open. Scope forms:read.

List forms

GET/api/v1/forms/forms

Forms newest first, with status, response and partial counts, last response and who can open them.

Scope forms:read

NameTypeRequiredDescription
qstringNoSearch query.
statusstringNoFilter forms by status, for example published.
curl -X GET "https://zerosoft.ai/api/v1/forms/forms" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "fm_1",
      "name": "NPS survey",
      "slug": "nps-survey-a1b2c3",
      "status": "published",
      "responseCount": 42,
      "partialCount": 3,
      "lastResponseAt": "2026-11-03T13:00:00.000Z",
      "updatedAt": "2026-11-03T13:00:00.000Z",
      "sharing": "workspace",
      "open": true
    }
  ]
}

List responses

GET/api/v1/forms/responses

Responses of one form, newest first. Answers are keyed by question id. File answers return a reference, not the file.

Scope forms:read

NameTypeRequiredDescription
formstringYesId of the form.
statusstringNocompleted (default) or partial.
fromstringNoOnly responses submitted on or after this date (YYYY-MM-DD).
tostringNoOnly responses submitted on or before this date (YYYY-MM-DD).
pageintegerNoPage number.
limitnumberNoMaximum number of results.
curl -X GET "https://zerosoft.ai/api/v1/forms/responses" \
  -H "Authorization: Bearer zs_live_9f3k..."

Response · 200

{
  "data": [
    {
      "id": "rs_1",
      "status": "completed",
      "answers": {
        "q_1": 9,
        "q_2": "Fast and clear"
      },
      "hidden": {
        "source": "newsletter"
      },
      "vars": {
        "score": 0
      },
      "endingId": "end_1",
      "lang": "en",
      "contactId": "con_1",
      "consent": true,
      "createdAt": "2026-11-03T12:58:00.000Z",
      "submittedAt": "2026-11-03T13:00:00.000Z"
    }
  ],
  "total": 42
}

Webhooks

Add endpoints in Dashboard → Settings → Webhooks. Events: booking.created, booking.rescheduled, booking.cancelled, booking.no_show, booking.requested, link.created, link.clicked, link.updated, link.deleted, contact.created, contact.updated, deal.created, deal.updated, deal.stage_changed, deal.won, deal.lost, robot.run.finished, robot.run.failed, robot.output.changed, chat.message.created, chat.conversation.created, chat.conversation.assigned, chat.conversation.tagged, chat.conversation.resolved, chat.csat.submitted. Link events can be limited to some links, tags or domains. link.updated carries the link and the list of changed fields; link.deleted, the link as it was. Each request carries Zerosoft-Signature: t=TIMESTAMP,v1=HEX, where v1 = HMAC-SHA256(secret, "TIMESTAMP.RAW_BODY"). Reject old timestamps. Failed deliveries are retried with backoff for ~15 hours.

Event payload

POSThttps://your-app.example/webhooks/zerosoft

What your endpoint receives. Respond 2xx within 8 seconds.

curl -X POST "https://your-app.example/webhooks/zerosoft" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "id": "evt_1",
  "type": "booking.created",
  "createdAt": "2026-11-01T18:00:00.000Z",
  "data": {
    "id": "8f1c2a8e-5b1e-4a7e-9a0e-2f6a1d0c9b11",
    "status": "confirmed",
    "startsAt": "2026-11-03T13:00:00.000Z",
    "endsAt": "2026-11-03T13:30:00.000Z",
    "timezone": "America/Argentina/Buenos_Aires",
    "invitee": {
      "name": "Ana",
      "email": "ana@example.com"
    },
    "answers": {},
    "hostUserId": "u_123",
    "meetingUrl": "https://meet.google.com/abc-defg-hij",
    "rescheduledFrom": null,
    "cancelReason": null,
    "eventType": {
      "id": "et_42",
      "slug": "intro",
      "title": "Intro call"
    }
  }
}'

Request

{
  "id": "evt_1",
  "type": "booking.created",
  "createdAt": "2026-11-01T18:00:00.000Z",
  "data": {
    "id": "8f1c2a8e-5b1e-4a7e-9a0e-2f6a1d0c9b11",
    "status": "confirmed",
    "startsAt": "2026-11-03T13:00:00.000Z",
    "endsAt": "2026-11-03T13:30:00.000Z",
    "timezone": "America/Argentina/Buenos_Aires",
    "invitee": {
      "name": "Ana",
      "email": "ana@example.com"
    },
    "answers": {},
    "hostUserId": "u_123",
    "meetingUrl": "https://meet.google.com/abc-defg-hij",
    "rescheduledFrom": null,
    "cancelReason": null,
    "eventType": {
      "id": "et_42",
      "slug": "intro",
      "title": "Intro call"
    }
  }
}

Chat event payload

POSThttps://your-app.example/webhooks/zerosoft

Chat events carry the conversation. chat.message.created adds the message (visitor, teammate or bot; internal notes are not sent) and chat.conversation.assigned adds previousAssignedTo.

curl -X POST "https://your-app.example/webhooks/zerosoft" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "id": "evt_2",
  "type": "chat.message.created",
  "createdAt": "2026-11-01T18:02:00.000Z",
  "data": {
    "conversation": {
      "id": "{conversation_id}",
      "widgetId": "{widget_id}",
      "status": "open",
      "priority": "medium",
      "subject": null,
      "assignedTo": "{user_id}",
      "visitor": {
        "id": "{visitor_id}",
        "name": "Ana",
        "email": "ana@example.com"
      },
      "firstResponseAt": "2026-11-01T18:02:00.000Z",
      "resolvedAt": null,
      "createdAt": "2026-11-01T18:00:00.000Z",
      "updatedAt": "2026-11-01T18:02:00.000Z"
    },
    "message": {
      "id": "{message_id}",
      "conversationId": "{conversation_id}",
      "senderType": "user",
      "userId": "{user_id}",
      "body": "Hi Ana, the order ships tomorrow.",
      "isNote": false,
      "attachments": [],
      "createdAt": "2026-11-01T18:02:00.000Z"
    }
  }
}'

Request

{
  "id": "evt_2",
  "type": "chat.message.created",
  "createdAt": "2026-11-01T18:02:00.000Z",
  "data": {
    "conversation": {
      "id": "{conversation_id}",
      "widgetId": "{widget_id}",
      "status": "open",
      "priority": "medium",
      "subject": null,
      "assignedTo": "{user_id}",
      "visitor": {
        "id": "{visitor_id}",
        "name": "Ana",
        "email": "ana@example.com"
      },
      "firstResponseAt": "2026-11-01T18:02:00.000Z",
      "resolvedAt": null,
      "createdAt": "2026-11-01T18:00:00.000Z",
      "updatedAt": "2026-11-01T18:02:00.000Z"
    },
    "message": {
      "id": "{message_id}",
      "conversationId": "{conversation_id}",
      "senderType": "user",
      "userId": "{user_id}",
      "body": "Hi Ana, the order ships tomorrow.",
      "isNote": false,
      "attachments": [],
      "createdAt": "2026-11-01T18:02:00.000Z"
    }
  }
}

Track event payload

POSThttps://your-app.example/webhooks/zerosoft

issue.* events carry the issue and its team (project in the payload); issue.status_changed adds from and to, comment.created the comment and project.* the team.

curl -X POST "https://your-app.example/webhooks/zerosoft" \
  -H "Authorization: Bearer zs_live_9f3k..."
  -H "Content-Type: application/json" \
  -d '{
  "id": "evt_3",
  "type": "issue.status_changed",
  "createdAt": "2026-10-25T15:10:00.000Z",
  "data": {
    "issue": {
      "id": "{issue_id}",
      "identifier": "WEB-12",
      "title": "Checkout button does nothing on Safari",
      "priority": "high",
      "status": "Done",
      "assigneeId": "{user_id}"
    },
    "project": {
      "id": "{project_id}",
      "name": "Web"
    },
    "changes": [
      "statusId"
    ],
    "from": "In Progress",
    "to": "Done"
  }
}'

Request

{
  "id": "evt_3",
  "type": "issue.status_changed",
  "createdAt": "2026-10-25T15:10:00.000Z",
  "data": {
    "issue": {
      "id": "{issue_id}",
      "identifier": "WEB-12",
      "title": "Checkout button does nothing on Safari",
      "priority": "high",
      "status": "Done",
      "assigneeId": "{user_id}"
    },
    "project": {
      "id": "{project_id}",
      "name": "Web"
    },
    "changes": [
      "statusId"
    ],
    "from": "In Progress",
    "to": "Done"
  }
}