Explore the HubSpot API data model

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

Try our interactive ERD Or, read the docs below

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

Property

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Description string - -
Label string - -
Type string -
  • 16 Sep 2021 The object type - string, number, enumeration etc
FieldType string -
  • 16 Sep 2021 How the object is presented - select, text etc
GroupName string - -
CreatedUserID long - -
UpdatedUserID long - -
DisplayOrder decimal - -
Calculated boolean - -
ExternalOptions boolean - -
Archived boolean - -
HasUniqueValue boolean - -
Hidden boolean - -
ShowCurrencySymbol boolean - -
FormField boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

PropertyOption

Column Type Relates to Notes
RemoteID string - -
PropertyRemoteID string Property → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Label string - -
Value string - -
DisplayOrder decimal - -
Hidden boolean - -

Contact

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Firstname string - -
Lastname string - -
Email string - -
CreatedAt datetime - -
UpdatedAt datetime - -
ArchivedAt datetime - -
CreatedByUserID long User → ID -
UpdatedByUserID long User → ID -

ContactPropertyValue

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

ContactCompany

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

ContactDeal

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

Deal

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
PipelineStageRemoteID string PipelineStage → RemoteID -
PipelineRemoteID string Pipeline → RemoteID -
Dealname string - -
Dealtype string - -
Currency string - -
Amount decimal - -
CloseDate datetime - -
CreatedAt datetime - -
UpdatedAt datetime - -
ArchivedAt datetime - -
CreatedByUserID long User → ID -
UpdatedByUserID long User → ID -

DealPropertyValue

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

DealLineItem

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

LineItem

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Description string - -
ProductID long Product → ID -
Currency string - -
Amount decimal - -
CostOfGoodsSold decimal - -
Discount decimal - -
CreatedAt datetime - -
UpdatedAt datetime - -
ArchivedAt datetime - -
CreatedByUserID long User → ID -
UpdatedByUserID long User → ID -

Product

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
Price decimal - -
CreatedAt datetime - -
UpdatedAt datetime - -
ArchivedAt datetime - -
CreatedByUserID long User → ID -
UpdatedByUserID long User → ID -

Ticket

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Subject string - -
Priority string - -
SourceType string - -
PipelineStageRemoteID string PipelineStage → RemoteID -
PipelineRemoteID string Pipeline → RemoteID -
CreatedAt datetime - -
UpdatedAt datetime - -
ArchivedAt datetime - -
CreatedByUserID long User → ID -
UpdatedByUserID long User → ID -

TicketPropertyValue

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TicketID long Ticket → ID -
PropertyRemoteID string Property → RemoteID -
Value string - -

TicketCompany

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TicketID long Ticket → ID -
ID long Company → ID -

TicketDeal

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TicketID long Ticket → ID -
ID long Deal → ID -

TicketContact

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TicketID long Ticket → ID -
ID long Contact → ID -

Company

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Domain string - -
CreatedAt datetime - -
UpdatedAt datetime - -
ArchivedAt datetime - -
CreatedByUserID long User → ID -
UpdatedByUserID long User → ID -

CompanyPropertyValue

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 -
PropertyRemoteID string Property → RemoteID -
Value string - -

Pipeline

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string -
  • 16 Sep 2021 The id field can be either a Int64, or a string such as 'appointmentscheduled'. We've also noticed this coming down as zero.
Archived boolean - -
DisplayOrder decimal - -
Label string - -
CreatedAt datetime - -
UpdatedAt datetime - -

PipelineStage

Column Type Relates to Notes
RemoteID string - -
PipelineRemoteID string Pipeline → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string -
  • 16 Sep 2021 The id field can be either a Int64, or a string such as 'appointmentscheduled'
DisplayOrder decimal - -
Label string - -
Archived boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

ProductPropertyValue

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

DealCompany

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

User

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Email string - -
PrimaryTeamID long Team → ID -
CreatedAt datetime - -
UpdatedAt datetime - -
ArchivedAt datetime - -
CreatedByUserID long User → ID -
UpdatedByUserID long User → ID -

LineItemPropertyValue

Column Type Relates to Notes
RemoteID string - -
LineItemRemoteID string LineItem → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
LineItemID long LineItem → ID -
PropertyRemoteID string Property → RemoteID -
Value string - -

Engagement

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
CreatedAt long - -
LastUpdated long - -
Active boolean - -
Source string - -
Type string - -
ActivityType string - -
Timestamp long - -
CreatedBy long User → ID -
ModifiedBy long User → ID -
Status string -
  • 8 Nov 2021 Available on task and call
TaskType string -
  • 8 Nov 2021 Available on task
Priority string -
  • 8 Nov 2021 Available on task
Subject string -
  • 8 Nov 2021 Available on task
Title string -
  • 8 Nov 2021 Available on call
Body string -
  • 8 Nov 2021 Available on task, call, meeting and note
StartTime long -
  • 8 Nov 2021 Available on meeting
FromEmail string -
  • 8 Nov 2021 Available on email
ToEmails string -
  • 8 Nov 2021 Available on email
CcEmails string -
  • 8 Nov 2021 Available on email
CallDispositionID guid CallDisposition → ID
  • 2 Oct 2022 Available on calls, indicating the outcome of the call
BccEmails string -
  • 8 Nov 2021 Available on email
WhenStarted datetime - -
WhenTimestamp datetime - -
EndTime long -
  • 8 Nov 2021 Available on meeting
WhenEnd datetime - -

EngagementDeal

Column Type Relates to Notes
RemoteID string - -
EngagementRemoteID string Engagement → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DealID long Deal → ID -
EngagementID long EngagementDetails → ID -

EngagementCompany

Column Type Relates to Notes
RemoteID string - -
EngagementRemoteID string Engagement → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyID long Company → ID -
EngagementID long EngagementDetails → ID -

EngagementContact

Column Type Relates to Notes
RemoteID string - -
EngagementRemoteID string Engagement → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID long Contact → ID -
EngagementID long EngagementDetails → ID -

EngagementOwner

Column Type Relates to Notes
RemoteID string - -
EngagementRemoteID string Engagement → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
UserID long User → ID -
EngagementID long EngagementDetails → ID -

Owner

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
CreatedAt datetime - -
UpdatedAt datetime - -
Email string - -
FirstName string - -
LastName string - -
UserID long User → ID -
Archived boolean - -

CallDisposition

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

OwnerTeam

Column Type Relates to Notes
RemoteID string - -
OwnerRemoteID string Owner → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OwnerID long Owner → ID -
TeamID long Team → ID -
Primary boolean - -

Team

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

TeamUser

Column Type Relates to Notes
RemoteID string - -
TeamRemoteID string Team → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TeamID long Team → ID -
UserID long User → ID -
Type string - -

Goal

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
GoalName string - -
TargetAmount string - -
StartDateTime datetime - -
EndDateTime datetime - -
CreatedAt datetime - -
UpdatedAt datetime - -
ArchivedAt datetime - -
CreatedByUserID long User → ID -
UpdatedByUserID long User → ID -

GoalPropertyValue

Column Type Relates to Notes
RemoteID string - -
GoalRemoteID string Goal → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
GoalID long Goal → ID -
PropertyRemoteID string Property → RemoteID -
Value string - -

Need more?

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

Connect your own HubSpot data Interactive ERD Querying HubSpot using regular SQL