Introduction

The Zero API allows you to programmatically access and manage your workspaces, companies, contacts, and deals. The Zero API is currently operating in beta.

Base URL

All API requests should be made to:

https://api.zero.inc

Authentication

All API requests require a Bearer token in the Authorization header:

Authorization: Bearer <your-api-token>

You can generate an API key in your account settings.

Quick Start

A typical workflow to get started with the API:

1

Get your workspace ID

Retrieve your workspaces to find the workspace ID you'll use in subsequent requests:

curl -X GET "https://api.zero.inc/api/workspaces?fields=id,name" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

2

Use the workspace ID in requests

Once you have your workspace ID, use it to fetch or create data:

curl -X GET "https://api.zero.inc/api/companies?workspaceId=WORKSPACE_UUID&limit=10" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Query Parameters

All GET endpoints support the following query parameters for filtering and pagination:

Parameter	Type	Default	Description
fields	string	* (all)	Comma-separated list of fields to return
where	JSON string	—	Filter conditions
limit	number	100	Maximum records to return
offset	number	0	Pagination offset
orderBy	JSON string	—	Sort order, e.g. {"name":"asc"}

Selecting Fields

Request only the fields you need to optimize response size:

curl "https://api.zero.inc/api/contacts?fields=id,name,email,title"

Including Related Data

You can include related objects using dot notation in the fields parameter:

# Get contacts with their company information
curl "https://api.zero.inc/api/contacts?fields=id,name,email,company.name,company.domain"

# Get deals with company and contacts
curl "https://api.zero.inc/api/deals?fields=id,name,value,company.name,contacts.name"

Filtering with where

Use the where parameter with a JSON string to filter results:

curl 'https://api.zero.inc/api/companies?where={"workspaceId":"your-workspace-uuid"}'

Sorting with orderBy

Sort results using the orderBy parameter:

curl 'https://api.zero.inc/api/deals?orderBy={"value":"desc"}'

Response Format

All endpoints return responses in a consistent format:

{
  "data": [...],
  "total": 42
}

For single-record operations (create, update), the response contains the record directly:

{
  "data": {
    "id": "uuid"
  }
}

Deleting Records

All delete operations support both soft delete (archive) and hard delete:

# Soft delete (archive) - record can be recovered
curl -X DELETE "https://api.zero.inc/api/companies/COMPANY_UUID?archive=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

# Hard delete - permanent removal
curl -X DELETE "https://api.zero.inc/api/companies/COMPANY_UUID" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Need Help?

If you have questions or need assistance, contact our support team.