Explore the Copper API data model

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

Try our interactive ERD Or, browse below

Pulling data from the Copper 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 Copper 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

Activity

Documentation: https://developer.copper.com/activities/overview.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Details string - -
UserID long Person → ID -
ActivityDate long - -
ActivityTypeID long ActivityType → ID -
ParentID long - -
ParentType string - -
AssigneeID long ContactType → ID -
DateCreated long - -
DateModified long - -

ActivityType

Documentation: https://developer.copper.com/activities/list-activity-types.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long -
  • 15 Jul 2024 We have observed activityTypeID=0 which appears to be the first user-created record
Name string - -
Category string - -
IsDisabled boolean - -
CountAsInteraction boolean - -

Company

Documentation: https://developer.copper.com/companies/overview.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
ContactTypeID long ContactType → ID -
Details string - -
EmailDomain string - -
InteractionCount long - -
Street string - -
City string - -
State string - -
PostalCode string - -
Country string - -
AssigneeID long ContactType → ID -
DateCreated long - -
DateModified long - -

ContactType

Documentation: https://developer.copper.com/people/list-contact-types.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -

CustomField

Documentation: https://developer.copper.com/custom-fields/general/list-custom-field-definitions.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
DataType string - -
IsFilterable boolean - -

Lead

Documentation: https://developer.copper.com/leads/overview.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Prefix string - -
FirstName string - -
LastName string - -
MiddleName string - -
Suffix string - -
CompanyName string - -
CustomerSourceID long - -
Street string - -
City string - -
State string - -
PostalCode string - -
Country string - -
Email string - -
EmailCategory string - -
Details string - -
InteractionCount long - -
Status string - -
StatusID long - -
Title string - -
DateLastContacted long - -
ConvertedAt long - -
ConvertedOpportunityID long Opportunity → ID -
ConvertedContactID long Person → ID -
AssigneeID long ContactType → ID -
DateCreated long - -
DateModified long - -

Opportunity

Documentation: https://developer.copper.com/opportunities/overview.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
CloseDate string - -
CompanyID long Company → ID -
CustomerSourceID long - -
CompanyName string - -
Details string - -
LossReasonID long - -
MonetaryValue decimal - -
PipelineID long Pipeline → ID -
PrimaryContactID long Person → ID -
Priority string - -
Status string - -
PipelineStageID long PipelineStage → ID -
InteractionCount long - -
WinProbability decimal - -
AssigneeID long ContactType → ID -
DateCreated long - -
DateModified long - -

Person

Documentation: https://developer.copper.com/people/overview.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
CompanyID long Company → ID -
CompanyName string - -
ContactTypeID long ContactType → ID -
Details string - -
Title string - -
DateLastContacted long - -
DateLeadCreated long - -
InteractionCount long - -
Street string - -
City string - -
State string - -
PostalCode string - -
Country string - -
AssigneeID long ContactType → ID -
DateCreated long - -
DateModified long - -

Pipeline

Documentation: https://developer.copper.com/opportunities/list-pipelines.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Category string - -

Project

Documentation: https://developer.copper.com/projects/overview.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Status string - -
Details string - -
RelatedResourceID long - -
RelatedResourceType string - -
AssigneeID long ContactType → ID -
DateCreated long - -
DateModified long - -

Task

Documentation: https://developer.copper.com/tasks/overview.html

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Status string - -
Priority string - -
Details string - -
DueDate long - -
ReminderDate long - -
CompletedDate long - -
RelatedResourceID long - -
RelatedResourceType string - -
AssigneeID long ContactType → ID -
DateCreated long - -
DateModified long - -

CompanyEmail

Column Type Relates to Notes
RemoteID string - -
CompanyRemoteID string Company → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyID long Company → ID -
Email string - -
Category string - -
Iterator int - -

CompanyTag

Column Type Relates to Notes
RemoteID string - -
CompanyRemoteID string Company → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyID long Company → ID -
Tag string - -
Iterator int - -

CompanyWebsite

Column Type Relates to Notes
RemoteID string - -
CompanyRemoteID string Company → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyID long Company → ID -
Url string - -
Category string - -
Iterator int - -

CompanyPhoneNumber

Column Type Relates to Notes
RemoteID string - -
CompanyRemoteID string Company → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyID long Company → ID -
PhoneNumbers string - -
Category string - -
Iterator int - -

CompanySocial

Column Type Relates to Notes
RemoteID string - -
CompanyRemoteID string Company → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyID long Company → ID -
Url string - -
Category string - -
Iterator int - -

CompanyCustomField

Column Type Relates to Notes
RemoteID string - -
CompanyRemoteID string Company → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyID long Company → ID -
CustomFieldID long - -
SingleValue string - -

CustomFieldOption

Column Type Relates to Notes
RemoteID string - -
CustomFieldRemoteID string CustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
CustomFieldID long CustomField → ID -
Rank int - -

LeadEmail

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

LeadTag

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

LeadWebsite

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

LeadPhoneNumber

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

LeadSocial

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

LeadCustomField

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

OpportunityTag

Column Type Relates to Notes
RemoteID string - -
OpportunityRemoteID string Opportunity → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OpportunityID long Opportunity → ID -
Tag string - -
Iterator int - -

OpportunityCustomField

Column Type Relates to Notes
RemoteID string - -
OpportunityRemoteID string Opportunity → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OpportunityID long Opportunity → ID -
CustomFieldID long - -
SingleValue string - -

PersonTag

Column Type Relates to Notes
RemoteID string - -
PersonRemoteID string Person → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PersonID long Person → ID -
Tag string - -
Iterator int - -

PersonEmail

Column Type Relates to Notes
RemoteID string - -
PersonRemoteID string Person → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PersonID long Person → ID -
Email string - -
Category string - -
Iterator int - -

PersonWebsite

Column Type Relates to Notes
RemoteID string - -
PersonRemoteID string Person → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PersonID long Person → ID -
Url string - -
Category string - -
Iterator int - -

PersonPhoneNumber

Column Type Relates to Notes
RemoteID string - -
PersonRemoteID string Person → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PersonID long Person → ID -
PhoneNumbers string - -
Category string - -
Iterator int - -

PersonSocial

Column Type Relates to Notes
RemoteID string - -
PersonRemoteID string Person → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PersonID long Person → ID -
Url string - -
Category string - -
Iterator int - -

PersonCustomField

Column Type Relates to Notes
RemoteID string - -
PersonRemoteID string Person → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PersonID long Person → ID -
CustomFieldID long - -
SingleValue string - -

PipelineStage

Column Type Relates to Notes
RemoteID string - -
PipelineRemoteID string Pipeline → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
PipelineID long Pipeline → ID -
WinProbability decimal - -

ProjectTag

Column Type Relates to Notes
RemoteID string - -
ProjectRemoteID string Project → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProjectID long Project → ID -
Tag string - -
Iterator int - -

ProjectCustomField

Column Type Relates to Notes
RemoteID string - -
ProjectRemoteID string Project → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProjectID long Project → ID -
CustomFieldID long - -
SingleValue string - -

TaskTag

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

TaskCustomField

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

CompanyCustomFieldOption

Column Type Relates to Notes
RemoteID string - -
CompanyCustomFieldRemoteID string CompanyCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyCustomFieldID long CompanyCustomField → CustomFieldDefinitionID -
OptionID long CustomFieldOption → ID -

LeadCustomFieldOption

Column Type Relates to Notes
RemoteID string - -
LeadCustomFieldRemoteID string LeadCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
LeadCustomFieldID long LeadCustomField → CustomFieldDefinitionID -
OptionID long CustomFieldOption → ID -

OpportunityCustomFieldOption

Column Type Relates to Notes
RemoteID string - -
OpportunityCustomFieldRemoteID string OpportunityCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OpportunityCustomFieldID long OpportunityCustomField → CustomFieldDefinitionID -
OptionID long CustomFieldOption → ID -

PersonCustomFieldOption

Column Type Relates to Notes
RemoteID string - -
PersonCustomFieldRemoteID string PersonCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PersonCustomFieldID long PersonCustomField → CustomFieldDefinitionID -
OptionID long CustomFieldOption → ID -

ProjectCustomFieldOption

Column Type Relates to Notes
RemoteID string - -
ProjectCustomFieldRemoteID string ProjectCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProjectCustomFieldID long ProjectCustomField → CustomFieldDefinitionID -
OptionID long CustomFieldOption → ID -

TaskCustomFieldOption

Column Type Relates to Notes
RemoteID string - -
TaskCustomFieldRemoteID string TaskCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TaskCustomFieldID long TaskCustomField → CustomFieldDefinitionID -
OptionID long CustomFieldOption → ID -

Need more?

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

Connect your own Copper data Querying Copper using regular SQL