Deals

Manage deals within workspaces

List deals

get

Returns deals from workspaces the user has access to.

Authorizations

bearerAuth

AuthorizationstringRequired

All API requests require a Bearer token in the Authorization header. Contact the Zero team to obtain your API token.

Query parameters

workspaceIdstring · uuidOptional

Filter by workspace ID

fieldsstringOptional

Comma-separated list of fields to return. Defaults to all fields.

Example: id,name,domain

wherestringOptional

JSON string with filter conditions

Example: {"workspaceId":"workspace-uuid"}

limitintegerOptional

Maximum number of records to return

Default: 100

offsetintegerOptional

Pagination offset

Default: 0

orderBystringOptional

JSON string for sort order

Example: {"name":"asc"}

Responses

200

Successful response

application/json

401

Authentication failed or token is invalid/expired

application/json

get

/api/deals

HTTPcURLJavaScriptPython

GET /api/deals HTTP/1.1
Host: api.zero.inc
Authorization: Bearer YOUR_API_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "contactIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "name": "text",
      "stage": "text",
      "value": 1,
      "confidence": 1,
      "closeDate": "2026-02-05",
      "startDate": "2026-02-05",
      "endDate": "2026-02-05",
      "listIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "ownerIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "custom": {},
      "externalId": "text",
      "source": "text",
      "createdAt": "2026-02-05T03:51:19.874Z",
      "updatedAt": "2026-02-05T03:51:19.874Z",
      "archived": true,
      "createdById": "123e4567-e89b-12d3-a456-426614174000",
      "company": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "domain": "text",
        "logo": "https://example.com",
        "description": "text",
        "linkedin": "text",
        "listIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "ownerIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "location": "text",
        "custom": {},
        "externalId": "text",
        "source": "text",
        "createdAt": "2026-02-05T03:51:19.874Z",
        "updatedAt": "2026-02-05T03:51:19.874Z",
        "archived": true,
        "createdById": "123e4567-e89b-12d3-a456-426614174000"
      },
      "contacts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
          "companyId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "email": "[email protected]",
          "title": "text",
          "phone": "text",
          "linkedin": "text",
          "avatar": "https://example.com",
          "location": "text",
          "type": "text",
          "custom": {},
          "listIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "ownerIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "externalId": "text",
          "source": "text",
          "createdAt": "2026-02-05T03:51:19.874Z",
          "updatedAt": "2026-02-05T03:51:19.874Z",
          "archived": true,
          "createdById": "123e4567-e89b-12d3-a456-426614174000",
          "company": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "domain": "text",
            "logo": "https://example.com",
            "description": "text",
            "linkedin": "text",
            "listIds": [
              "123e4567-e89b-12d3-a456-426614174000"
            ],
            "ownerIds": [
              "123e4567-e89b-12d3-a456-426614174000"
            ],
            "location": "text",
            "custom": {},
            "externalId": "text",
            "source": "text",
            "createdAt": "2026-02-05T03:51:19.874Z",
            "updatedAt": "2026-02-05T03:51:19.874Z",
            "archived": true,
            "createdById": "123e4567-e89b-12d3-a456-426614174000"
          }
        }
      ]
    }
  ],
  "total": 1
}

Create a deal

post

Create a new deal in a workspace.

Note: If stage is not provided, it will default to the workspace's defaultDealStage setting.

Authorizations

bearerAuth

AuthorizationstringRequired

All API requests require a Bearer token in the Authorization header. Contact the Zero team to obtain your API token.

Body

application/json

workspaceIdstring · uuidRequired

companyIdstring · uuidOptional

contactIdsstring · uuid[]Optional

namestringOptional

stagestringOptional

If not provided, defaults to the workspace defaultDealStage setting.

valuenumberOptional

confidencenumber · max: 100Optional

closeDatestring · dateOptional

startDatestring · dateOptional

endDatestring · dateOptional

listIdsstring · uuid[]Optional

ownerIdsstring · uuid[]Optional

customobjectOptional

externalIdstringOptional

sourcestringOptional

Responses

200

Deal created successfully

application/json

401

Authentication failed or token is invalid/expired

application/json

post

/api/deals

HTTPcURLJavaScriptPython

POST /api/deals HTTP/1.1
Host: api.zero.inc
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "workspaceId": "workspace-uuid",
  "name": "Enterprise Deal",
  "companyId": "company-uuid",
  "contactIds": [
    "contact-uuid-1",
    "contact-uuid-2"
  ],
  "value": 50000,
  "closeDate": "2024-06-30"
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "contactIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "name": "text",
    "stage": "text",
    "value": 1,
    "confidence": 1,
    "closeDate": "2026-02-05",
    "startDate": "2026-02-05",
    "endDate": "2026-02-05",
    "listIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ownerIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "custom": {},
    "externalId": "text",
    "source": "text",
    "createdAt": "2026-02-05T03:51:19.874Z",
    "updatedAt": "2026-02-05T03:51:19.874Z",
    "archived": true,
    "createdById": "123e4567-e89b-12d3-a456-426614174000",
    "company": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "domain": "text",
      "logo": "https://example.com",
      "description": "text",
      "linkedin": "text",
      "listIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "ownerIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "location": "text",
      "custom": {},
      "externalId": "text",
      "source": "text",
      "createdAt": "2026-02-05T03:51:19.874Z",
      "updatedAt": "2026-02-05T03:51:19.874Z",
      "archived": true,
      "createdById": "123e4567-e89b-12d3-a456-426614174000"
    },
    "contacts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "[email protected]",
        "title": "text",
        "phone": "text",
        "linkedin": "text",
        "avatar": "https://example.com",
        "location": "text",
        "type": "text",
        "custom": {},
        "listIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "ownerIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "externalId": "text",
        "source": "text",
        "createdAt": "2026-02-05T03:51:19.874Z",
        "updatedAt": "2026-02-05T03:51:19.874Z",
        "archived": true,
        "createdById": "123e4567-e89b-12d3-a456-426614174000",
        "company": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "domain": "text",
          "logo": "https://example.com",
          "description": "text",
          "linkedin": "text",
          "listIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "ownerIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "location": "text",
          "custom": {},
          "externalId": "text",
          "source": "text",
          "createdAt": "2026-02-05T03:51:19.874Z",
          "updatedAt": "2026-02-05T03:51:19.874Z",
          "archived": true,
          "createdById": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    ]
  }
}

Delete a deal

delete

Delete a deal. Use archive=true for soft delete.

Authorizations

bearerAuth

AuthorizationstringRequired

All API requests require a Bearer token in the Authorization header. Contact the Zero team to obtain your API token.

Path parameters

dealIdstring · uuidRequired

Query parameters

archivebooleanOptional

If true, soft deletes (archives) the deal instead of permanently deleting it.

Default: false

Responses

200

Deal deleted successfully

No content

401

Authentication failed or token is invalid/expired

application/json

404

The requested resource was not found

application/json

delete

/api/deals/{dealId}

HTTPcURLJavaScriptPython

DELETE /api/deals/{dealId} HTTP/1.1
Host: api.zero.inc
Authorization: Bearer YOUR_API_TOKEN
Accept: */*

No content

Update a deal

patch

Update an existing deal.

Authorizations

bearerAuth

AuthorizationstringRequired

All API requests require a Bearer token in the Authorization header. Contact the Zero team to obtain your API token.

Path parameters

dealIdstring · uuidRequired

Body

application/json

companyIdstring · uuidOptional

contactIdsstring · uuid[]Optional

namestringOptional

stagestringOptional

valuenumberOptional

confidencenumber · max: 100Optional

closeDatestring · dateOptional

startDatestring · dateOptional

endDatestring · dateOptional

listIdsstring · uuid[]Optional

ownerIdsstring · uuid[]Optional

customobjectOptional

externalIdstringOptional

sourcestringOptional

Responses

200

Deal updated successfully

application/json

401

Authentication failed or token is invalid/expired

application/json

404

The requested resource was not found

application/json

patch

/api/deals/{dealId}

HTTPcURLJavaScriptPython

PATCH /api/deals/{dealId} HTTP/1.1
Host: api.zero.inc
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 384

{
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "contactIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "name": "text",
  "stage": "text",
  "value": 1,
  "confidence": 1,
  "closeDate": "2026-02-05",
  "startDate": "2026-02-05",
  "endDate": "2026-02-05",
  "listIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ownerIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "custom": {},
  "externalId": "text",
  "source": "text"
}

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "contactIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "name": "text",
    "stage": "text",
    "value": 1,
    "confidence": 1,
    "closeDate": "2026-02-05",
    "startDate": "2026-02-05",
    "endDate": "2026-02-05",
    "listIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ownerIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "custom": {},
    "externalId": "text",
    "source": "text",
    "createdAt": "2026-02-05T03:51:19.874Z",
    "updatedAt": "2026-02-05T03:51:19.874Z",
    "archived": true,
    "createdById": "123e4567-e89b-12d3-a456-426614174000",
    "company": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "domain": "text",
      "logo": "https://example.com",
      "description": "text",
      "linkedin": "text",
      "listIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "ownerIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "location": "text",
      "custom": {},
      "externalId": "text",
      "source": "text",
      "createdAt": "2026-02-05T03:51:19.874Z",
      "updatedAt": "2026-02-05T03:51:19.874Z",
      "archived": true,
      "createdById": "123e4567-e89b-12d3-a456-426614174000"
    },
    "contacts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "[email protected]",
        "title": "text",
        "phone": "text",
        "linkedin": "text",
        "avatar": "https://example.com",
        "location": "text",
        "type": "text",
        "custom": {},
        "listIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "ownerIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "externalId": "text",
        "source": "text",
        "createdAt": "2026-02-05T03:51:19.874Z",
        "updatedAt": "2026-02-05T03:51:19.874Z",
        "archived": true,
        "createdById": "123e4567-e89b-12d3-a456-426614174000",
        "company": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "domain": "text",
          "logo": "https://example.com",
          "description": "text",
          "linkedin": "text",
          "listIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "ownerIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "location": "text",
          "custom": {},
          "externalId": "text",
          "source": "text",
          "createdAt": "2026-02-05T03:51:19.874Z",
          "updatedAt": "2026-02-05T03:51:19.874Z",
          "archived": true,
          "createdById": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    ]
  }
}