Contacts

Manage contacts within workspaces

List contacts

get

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

HTTPcURLJavaScriptPython

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

Create a contact

post

Create a new contact in a workspace.

Note: If companyId is not provided but email or linkedin is, the system will automatically find or create the associated company.

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

If not provided but email or linkedin is given, the system will automatically find or create the associated company.

namestringOptional

emailstring · emailOptional

titlestringOptional

phonestringOptional

linkedinstringOptional

avatarstring · uriOptional

locationstringOptional

typestringOptional

customobjectOptional

listIdsstring · uuid[]Optional

ownerIdsstring · uuid[]Optional

externalIdstringOptional

sourcestringOptional

Responses

200

Contact created successfully

application/json

401

Authentication failed or token is invalid/expired

application/json

post

/api/contacts

HTTPcURLJavaScriptPython

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

{
  "workspaceId": "workspace-uuid",
  "name": "John Doe",
  "email": "[email protected]",
  "title": "CEO",
  "companyId": "company-uuid",
  "linkedin": "johndoe"
}

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

Delete a contact

delete

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

contactIdstring · uuidRequired

Query parameters

archivebooleanOptional

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

Default: false

Responses

200

Contact 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/contacts/{contactId}

HTTPcURLJavaScriptPython

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

No content

Update a contact

patch

Update an existing contact.

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

contactIdstring · uuidRequired

Body

application/json

companyIdstring · uuidOptional

namestringOptional

emailstring · emailOptional

titlestringOptional

phonestringOptional

linkedinstringOptional

avatarstring · uriOptional

locationstringOptional

typestringOptional

customobjectOptional

listIdsstring · uuid[]Optional

ownerIdsstring · uuid[]Optional

externalIdstringOptional

sourcestringOptional

Responses

200

Contact 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/contacts/{contactId}

HTTPcURLJavaScriptPython

PATCH /api/contacts/{contactId} HTTP/1.1
Host: api.zero.inc
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "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"
}

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