Explore the Zoho CRM API data model

See how the various Zoho CRM endpoints relate to each other, using our handy Entity Relationship Diagram

Try our interactive ERD Or, browse below

Pulling data from the Zoho CRM API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Zoho CRM API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Account

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-records.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Description string - -
ModifiedTime datetime - -
CreatedTime datetime - -
AccountType string - -
LastActivityTime datetime - -
Industry string - -
BillingStreet string - -
BillingCode string - -
ShippingCity string - -
ShippingCountry string - -
ShippingCode string - -
BillingState string - -
BillingCity string - -
AnnualRevenue decimal - -
Ownership string - -
Website string - -
Employees decimal - -
AccountName string - -
CurrencySymbol string - -
ApprovalSettingDelegate boolean - -
ApprovalSettingApproval boolean - -
ApprovalSettingReject boolean - -
ApprovalSettingResubmit boolean - -
ApprovalState string - -
ReviewProcessApprove boolean - -
ReviewProcessReject boolean - -
ReviewProcessResubmit boolean - -
OwnerID string User → ID -
CreatedByID string User → ID -
ModifiedByID string User → ID -

Campaign

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-records.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Description string - -
ModifiedTime datetime - -
CreatedTime datetime - -
CampaignName string - -
Status string - -
Type string - -
StartDate datetime - -
EndDate datetime - -
ExpectedRevenue decimal - -
NumSent decimal - -
ExpectedResponse string - -
BudgetedCost decimal - -
ActualCost decimal - -
CurrencySymbol string - -
ApprovalSettingDelegate boolean - -
ApprovalSettingApproval boolean - -
ApprovalSettingReject boolean - -
ApprovalSettingResubmit boolean - -
ApprovalState string - -
OwnerID string User → ID -
CreatedByID string User → ID -
ModifiedByID string User → ID -
ParentCampaignID string Campaign → ID -

Contact

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-records.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Description string - -
ModifiedTime datetime - -
CreatedTime datetime - -
Salutation string - -
FirstName string - -
LastName string - -
DateOfBirth string - -
Email string - -
Phone string - -
Mobile string - -
MailingStreet string - -
MailingState string - -
MailingCity string - -
MailingCountry string - -
LastActivityTime datetime - -
Title string - -
Department string - -
HomePhone string - -
SecondaryEmail string - -
SkypeID string - -
LeadSource string - -
OwnerID string User → ID -
CreatedByID string User → ID -
ModifiedByID string User → ID -
ReportingToID string Contact → ID -
AccountID string Account → ID -
VendorID string Vendor → ID -

LinkingModuleItem

Documentation: https://www.zoho.com/crm/developer/docs/api/v7/linking-modules.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
ModifiedTime datetime - -
CreatedTime datetime - -
Link1ID string - -
Link2ID string - -
Link1FieldName string - -
Link1ModuleType string - -
Link2FieldName string - -
Link2ModuleType string - -
LinkingModuleName string - -

Deal

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-records.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Description string - -
ModifiedTime datetime - -
CreatedTime datetime - -
ClosingDate datetime - -
DealName string - -
Stage string - -
CurrencySymbol string - -
ReviewProcessApprove boolean - -
ReviewProcessReject boolean - -
ReviewProcessResubmit boolean - -
ReasonForLoss string - -
ExpectedRevenue decimal - -
Amount decimal - -
Probability decimal - -
OverallSalesDuration decimal - -
SalesCycleDuration decimal - -
Type string - -
ApprovalSettingDelegate boolean - -
ApprovalSettingApproval boolean - -
ApprovalSettingReject boolean - -
ApprovalSettingResubmit boolean - -
ApprovalState string - -
OwnerID string User → ID -
CreatedByID string User → ID -
ModifiedByID string User → ID -
CampaignSourceID string Campaign → ID -
AccountID string Account → ID -
ContactID string Contact → ID -

Lead

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-records.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Description string - -
ModifiedTime datetime - -
CreatedTime datetime - -
Company string - -
Email string - -
Industry string - -
Street string - -
City string - -
ZipCode string - -
State string - -
Country string - -
Website string - -
AnnualRevenue decimal - -
FirstName string - -
LastName string - -
Phone string - -
Mobile string - -
Designation string - -
LeadSource string - -
CurrencySymbol string - -
SharingPermission string - -
ProcessFlow boolean - -
ApprovalSettingDelegate boolean - -
ApprovalSettingApproval boolean - -
ApprovalSettingReject boolean - -
ApprovalSettingResubmit boolean - -
ApprovalState string - -
OwnerID string User → ID -
CreatedByID string User → ID -
ModifiedByID string User → ID -

Note

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-notes.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
ModifiedTime datetime - -
CreatedTime datetime - -
NoteTitle string - -
NoteContent string - -
CreatedByID string User → ID -
ModifiedByID string User → ID -
DealID string Deal → ID -
ContactID string Contact → ID -
AccountID string Account → ID -
LeadID string Lead → ID -
CampaignID string Campaign → ID -
ProductID string Product → ID -
VendorID string Vendor → ID -
TaskID string Task → ID -

Product

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-records.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Description string - -
ModifiedTime datetime - -
CreatedTime datetime - -
ProductCategory string - -
QtyInDemand decimal - -
SalesStartDate datetime - -
SalesEndDate datetime - -
SupportStartDate datetime - -
SupportExpiryDate datetime - -
ProductCode string - -
Manufacturer string - -
CommissionRate decimal - -
ProductName string - -
UsageUnit string - -
QtyOrdered decimal - -
QtyInStock decimal - -
ReorderLevel decimal - -
UnitPrice decimal - -
Taxable boolean - -
OwnerID string User → ID -
CreatedByID string User → ID -
ModifiedByID string User → ID -
HandlerID string User → ID -
VendorID string - -

Role

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-roles.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
ReportingToID string Role → ID -

Tag

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-tag-list.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
TagType string - -
CreatedTime datetime - -
ModifiedTime datetime - -
ColorCode string - -
ModifiedByID string User → ID -
CreatedByID string User → ID -

Task

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-records.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Description string - -
ModifiedTime datetime - -
CreatedTime datetime - -
SendNotificationEmail boolean - -
Status string - -
DueDate datetime - -
Priority string - -
Subject string - -
OwnerID string User → ID -
CreatedByID string User → ID -
ModifiedByID string User → ID -
ContactID string Contact → ID -
AccountID string - -

User

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-users.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
CreatedTime datetime - -
ModifiedTime datetime - -
Status string - -
Country string - -
City string - -
Street string - -
State string - -
Zip string - -
Locale string - -
Currency string - -
Alias string - -
Fax string - -
Email string - -
Mobile string - -
Phone string - -
FirstName string - -
Website string - -
LastName string - -
Zuid string - -
Confirm boolean - -
FullName string - -
Dob string - -
DateFormat string - -
TimeFormat string - -
Signature string - -
NameFormat string - -
Language string - -
Microsoft boolean - -
PersonalAccount boolean - -
Isonline boolean - -
NumberSeparator string - -
DecimalSeparator string - -
RoleID string Role → ID -
CreatedByID string User → ID -
ModifiedByID string User → ID -
ProfileID string - -

Vendor

Documentation: https://www.zoho.com/crm/developer/docs/api/v6/get-records.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Description string - -
ModifiedTime datetime - -
CreatedTime datetime - -
Email string - -
Category string - -
VendorName string - -
Website string - -
Phone string - -
Street string - -
ZipCode string - -
City string - -
State string - -
Country string - -
OwnerID string User → ID -
CreatedByID string User → ID -
ModifiedByID string User → ID -

AccountTag

Column Type Relates to Notes
RemoteID string - -
AccountRemoteID string Account → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string Tag → ID -
AccountID string Account → ID -

CampaignTag

Column Type Relates to Notes
RemoteID string - -
CampaignRemoteID string Campaign → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string Tag → ID -
CampaignID string Campaign → ID -

ContactTag

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string Tag → ID -
ContactID string Contact → ID -

DealTag

Column Type Relates to Notes
RemoteID string - -
DealRemoteID string Deal → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string Tag → ID -
DealID string Deal → ID -

LeadTag

Column Type Relates to Notes
RemoteID string - -
LeadRemoteID string Lead → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string Tag → ID -
LeadID string Lead → ID -

ProductTag

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string Tag → ID -
ProductID string Product → ID -

TaskTag

Column Type Relates to Notes
RemoteID string - -
TaskRemoteID string Task → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string Tag → ID -
TaskID string Task → ID -

VendorTag

Column Type Relates to Notes
RemoteID string - -
VendorRemoteID string Vendor → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string Tag → ID -
VendorID string Vendor → ID -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.

Connect your own Zoho CRM data Querying Zoho CRM using regular SQL