Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.zeeg.me/llms.txt

Use this file to discover all available pages before exploring further.

The Zeeg CRM API lets you programmatically manage all data inside the Zeeg CRM — contacts (people), companies, and any custom objects your workspace has created. It is designed for data migrations, bi-directional syncs, and integrations with external systems.

Scopes

ScopeWhat it allows
crm:readRead all CRM objects and records
crm:writeCreate, update, and delete CRM records; also grants read access
All read endpoints accept either scope. All write endpoints require crm:write.

Standard objects

Zeeg CRM ships with two built-in objects. They are always present in every workspace and cannot be deleted.

People (people)

Represents a contact — an individual person your team interacts with.
AttributeAPI keyTypeNotes
IDidtextUUID, read-only
First Namefirst_nametext
Last Namelast_nametext
EmailsemailstextUnique. Accepts email validation.
Phone Numberphone_numberphone_number
Job Titlejob_titletext
Descriptiondescriptiontext
Companycrm_customer_company_idrelation → companiesLinks person to a company
Contact Ownercontact_owner_member_iduserWorkspace member responsible for the contact
LinkedInlinkedintextURL
X (Twitter)twittertextURL
FacebookfacebooktextURL
InstagraminstagramtextURL
Created Atcreated_atdatetimeRead-only
Last Modifiedupdated_atdatetimeRead-only
Last Interactionlast_interactiondatetimeAuto-updated from calendar/email activity
Next Interactionnext_interactiondatetimeAuto-updated from scheduled meetings

Companies (companies)

Represents an organisation your team works with.
AttributeAPI fieldTypeNotes
IDidtextUUID, read-only
NamenametextRequired
DomaindomaintextUnique within workspace. Used as matching attribute for assert (upsert).
Descriptiondescriptiontext
Website URLwebsiteUrltextURL
Primary LocationprimaryLocationtext
IndustriesindustriesmultiselectArray of industry IDs
Account Owneraccount_owner_member_iduserWorkspace member responsible for the account
LinkedInsocials.linkedintextURL
X (Twitter)socials.twittertextURL
Facebooksocials.facebooktextURL
Instagramsocials.instagramtextURL
Created AtcreatedAtdatetimeRead-only
Last ModifiedupdatedAtdatetimeRead-only
Last Interactionlast_interactiondatetimeAuto-updated
Next Interactionnext_interactiondatetimeAuto-updated

Custom objects

In addition to the two standard objects, workspaces on eligible plans can create custom objects (e.g. deals, products, tickets). Each custom object has its own set of custom attributes. Use GET /crm/objects to list all objects — standard and custom — along with their full attribute schemas.

Getting started

The recommended workflow for importing or syncing data:
1. GET /v2/crm/objects
   → Discover all objects and their attribute keys

2. PUT /v2/crm/companies?matchingAttribute=domain   (for each company)
   → Create or update companies by domain

3. POST /v2/crm/people   (for each person)
   → Create people records, linking them to companies via crm_customer_company_id
All timestamps in responses are in ISO 8601 format with UTC offset (e.g. 2025-06-01T10:00:00+00:00).
Last modified on May 7, 2026