Companies

Manage companies within workspaces

List companies

get

Returns companies 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/companies

HTTPcURLJavaScriptPython

GET /api/companies 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",
      "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.962Z",
      "updatedAt": "2026-02-05T03:51:19.962Z",
      "archived": true,
      "createdById": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "total": 1
}

Create a company

post

Create a new company in a workspace.

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

namestringOptional

domainstringOptional

logostring · uriOptional

descriptionstringOptional

linkedinstringOptional

listIdsstring · uuid[]Optional

ownerIdsstring · uuid[]Optional

locationstringOptional

customobjectOptional

externalIdstringOptional

sourcestringOptional

Responses

200

Company created successfully

application/json

401

Authentication failed or token is invalid/expired

application/json

post

/api/companies

HTTPcURLJavaScriptPython

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

{
  "workspaceId": "workspace-uuid",
  "name": "Acme Inc",
  "domain": "acme.com",
  "linkedin": "acme-inc"
}

{
  "data": {
    "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.962Z",
    "updatedAt": "2026-02-05T03:51:19.962Z",
    "archived": true,
    "createdById": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Delete a company

delete

Delete a company. 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

companyIdstring · uuidRequired

Query parameters

archivebooleanOptional

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

Default: false

Responses

200

Company 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/companies/{companyId}

HTTPcURLJavaScriptPython

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

No content

Update a company

patch

Update an existing company.

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

companyIdstring · uuidRequired

Body

application/json

namestringOptional

domainstringOptional

logostring · uriOptional

descriptionstringOptional

linkedinstringOptional

listIdsstring · uuid[]Optional

ownerIdsstring · uuid[]Optional

locationstringOptional

customobjectOptional

externalIdstringOptional

sourcestringOptional

Responses

200

Company 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/companies/{companyId}

HTTPcURLJavaScriptPython

PATCH /api/companies/{companyId} HTTP/1.1
Host: api.zero.inc
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "name": "Acme Corporation"
}

{
  "data": {
    "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.962Z",
    "updatedAt": "2026-02-05T03:51:19.962Z",
    "archived": true,
    "createdById": "123e4567-e89b-12d3-a456-426614174000"
  }
}