Explore the Capsule CRM API data model

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

Try our interactive ERD Or, browse below

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

Board

Documentation: https://developer.capsulecrm.com/v2/operations/boards

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

PartyCustomFieldDefinition

Documentation: https://developer.capsulecrm.com/v2/operations/CustomField

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
Type string - -
CaptureRule string - -
Important boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

OpportunityCustomFieldDefinition

Documentation: https://developer.capsulecrm.com/v2/operations/CustomField

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
Type string - -
CaptureRule string - -
Important boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

ProjectCustomFieldDefinition

Documentation: https://developer.capsulecrm.com/v2/operations/CustomField

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
Type string - -
CaptureRule string - -
Important boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

LostReason

Documentation: https://developer.capsulecrm.com/v2/operations/LostReason

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

Milestone

Documentation: https://developer.capsulecrm.com/v2/operations/Milestone

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
PipelineID long Pipeline → ID -
Complete boolean - -
Probability decimal - -
DaysUntilStale int - -
CreatedAt datetime - -
UpdatedAt datetime - -

Opportunity

Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
ExpectedCloseOn datetime - -
ClosedOn datetime - -
Probability decimal - -
DurationBasis string - -
Duration long - -
LastContactedAt datetime - -
LastStageChangedAt datetime - -
MissingImportantFields boolean - -
ValueAmount decimal - -
ValueCurrency string - -
PartyID long Party → ID -
TeamID long - -
OwnerID long User → ID -
CurrentMilestoneID long Milestone → ID -
LastOpenMilestoneID long Milestone → ID -
LostReasonID long LostReason → ID -
CreatedAt datetime - -
UpdatedAt datetime - -

Party

Documentation: https://developer.capsulecrm.com/v2/operations/Party

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Type string - -
About string - -
LastContactedAt datetime - -
OwnerID long User → ID -
FirstName string - -
LastName string - -
Title string - -
JobTitle string - -
OrganisationID long Party → ID -
CreatedAt datetime - -
UpdatedAt datetime - -

Pipeline

Documentation: https://developer.capsulecrm.com/v2/operations/Pipeline

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

Project

Documentation: https://developer.capsulecrm.com/v2/operations/Case

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
ExpectedCloseOn datetime - -
ClosedOn datetime - -
Probability decimal - -
Status string - -
Duration long - -
LastContactedAt datetime - -
MissingImportantFields boolean - -
PartyID long Party → ID -
OwnerID long User → ID -
OpportunityID long Opportunity → ID -
CreatedAt datetime - -
UpdatedAt datetime - -

Tag

Documentation: https://developer.capsulecrm.com/v2/operations/Tag

Column Type Relates to Notes
RemoteID string - -
OpportunityRemoteID string Opportunity → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
DataTag boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

User

Documentation: https://developer.capsulecrm.com/v2/operations/User

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Locale string - -
EmailPreference string - -
ClickToCallPreference string - -
Currency string - -
PreferredEmailFromAddress string - -
Username string - -
Timezone string - -
TaskReminder boolean - -
Status string - -
PartyID long Party → ID -
CreatedAt datetime - -
UpdatedAt datetime - -

OpportunityTag

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

OpportunityCustomFieldValue

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

PartyTag

Column Type Relates to Notes
RemoteID string - -
PartyRemoteID string Party → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long Tag → ID -
PartyID long Party → ID -

PartyCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
PartyRemoteID string Party → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
PartyID long Party → ID -
CustomFieldDefinitionID long PartyCustomFieldDefinition → ID -
Value string - -

PartyAddress

Documentation: https://developer.capsulecrm.com/v2/models/address

Column Type Relates to Notes
RemoteID string - -
PartyRemoteID string Party → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
PartyID long Party → ID -
Type string - -
Street string - -
PrimaryTimezone string - -
City string - -
State string - -
Country string - -
Zip string - -

ProjectTag

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

ProjectCustomFieldValue

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

Need more?

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

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