Explore the OnePageCRM API data model

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

Try our interactive ERD Or, browse below

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

Action

Documentation: https://developer.onepagecrm.com/api/#/Actions

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
CreatedAt datetime - -
ModifiedAt datetime - -
AssigneeID string User → ID -
ContactID string Contact → ID -
Text string - -
Status string - -
Done boolean - -
Date datetime - -
DoneAt datetime - -

Call

Documentation: https://developer.onepagecrm.com/api/#/Calls

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
CreatedAt datetime - -
ModifiedAt datetime - -
Author string - -
Text string - -
CallResult string - -
CallTimeInt long - -
ContactID string Contact → ID -
Via string - -
PhoneNumber string - -

Company

Documentation: https://developer.onepagecrm.com/api/#/Companies

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
CreatedAt datetime - -
ModifiedAt datetime - -
Phone string - -
Url string - -
Address string - -
City string - -
State string - -
ZipCode string - -
CountryCode string - -
WonDealsCount int - -
TotalWonAmount decimal - -

CompanyCustomField

Documentation: https://developer.onepagecrm.com/api/#/Company_Fields

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

Contact

Documentation: https://developer.onepagecrm.com/api/#/Contacts

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
CreatedAt datetime - -
ModifiedAt datetime - -
FirstName string - -
LastName string - -
JobTitle string - -
CompanyID string Company → ID -
OwnerID string User → ID -
StatusID string Status → ID -
Starred boolean - -
Background string - -
LeadSourceID string LeadSource → ID -
TotalPendings decimal - -
TotalDealsCount int - -
Enhanceable boolean - -
EmailSyncAvailable boolean - -
EmailSyncEnabled boolean - -
NextActionID string Action → ID -
MostUrgentActionID string Action → ID -

ContactCustomField

Documentation: https://developer.onepagecrm.com/api/#/CustomFields

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

Deal

Documentation: https://developer.onepagecrm.com/api/#/Deals

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
CreatedAt datetime - -
ModifiedAt datetime - -
ContactID string Contact → ID -
OwnerID string User → ID -
ContactOwnerID string User → ID -
PipelineID string Pipeline → ID -
Text string - -
Date datetime - -
Amount decimal - -
Months int - -
TotalAmount decimal - -
Cost decimal - -
TotalCost decimal - -
Margin decimal - -
Commission decimal - -
CommissionPercentage decimal - -
CommissionType string - -
CommissionBase string - -
Status string - -
HasRelatedNotes boolean - -
Stage int - -
ExpectedCloseDate datetime - -

DealCustomField

Documentation: https://developer.onepagecrm.com/api/#/Deal_Fields

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

Filter

Documentation: https://developer.onepagecrm.com/api/#/Filters

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

Item

Documentation: https://developer.onepagecrm.com/api/#/Predefined_Items

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
Cost decimal - -
Price decimal - -
Type string - -

ItemGroup

Documentation: https://developer.onepagecrm.com/api/#/Predefined_Item_Groups

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
Type string - -
Subcount int - -
Cost decimal - -
Price decimal - -

LeadSource

Documentation: https://developer.onepagecrm.com/api/#/Lead_Sources

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Text string - -
Counts int - -
TotalCount int - -
ActionStreamCount int - -

Meeting

Documentation: https://developer.onepagecrm.com/api/#/Meetings

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
CreatedAt datetime - -
ModifiedAt datetime - -
Author string - -
Text string - -
MeetingTimeInt long - -
Place string - -
ContactID string Contact → ID -

Note

Documentation: https://developer.onepagecrm.com/api/#/Notes

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
CreatedAt datetime - -
ModifiedAt datetime - -
Author string - -
Text string - -
Date datetime - -
ContactID string Contact → ID -
LinkedDealID string Deal → ID -

Pipeline

Documentation: https://developer.onepagecrm.com/api/#/Pipelines

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

Status

Documentation: https://developer.onepagecrm.com/api/#/Statuses

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
Text string - -
Color string - -
Counts int - -
TotalCount int - -
ActionStreamCount int - -

Tag

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Counts int - -
TotalCount int - -
ActionStreamCount int - -

User

Documentation: https://developer.onepagecrm.com/api/#/Users

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
FirstName string - -
LastName string - -
Email string - -
CompanyName string - -
CountryCode string - -
AccountRole string - -
BccEmail string - -
VirtualGroupID string -
  • 19 Aug 2024 Foreign Key - Refers to `UserGroup` or 'VirtualGroup' (not implemented). This doesn't appear to have it's own endpoint but it might be retrievable via the Bootstrap endpoint

CallAttachment

Column Type Relates to Notes
RemoteID string - -
CallRemoteID string Call → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string -
  • 19 Aug 2024 There's potential for this to be an FK and while there is an Attachments endpoint, the only get method is to retrieve an 's3 upload form' for uploading a file on the client side
CallID string Call → ID -

CompanyCustomFieldValue

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

CompanyContact

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

CompanyPendingDeal

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

CompanyCustomFieldChoice

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

ContactTag

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

ContactCustomFieldValue

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

ContactAddress

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID string Contact → ID -
LineNumber int - -
Address string - -
City string - -
State string - -
ZipCode string - -
CountryCode string - -
Type string - -

ContactUrl

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

ContactPhone

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

ContactEmail

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

ContactAction

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

ContactCustomFieldChoice

Column Type Relates to Notes
RemoteID string - -
ContactCustomFieldRemoteID string ContactCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactCustomFieldID string ContactCustomField → ID -
Value string - -

DealItem

Column Type Relates to Notes
RemoteID string - -
DealRemoteID string Deal → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Description string - -
DealID string Deal → ID -
CreatedAt datetime - -
ModifiedAt datetime - -
Cost decimal - -
Price decimal - -
Amount decimal - -
Qty decimal - -
Position int - -
PredefinedItemID string Item → ID -

DealAttachment

Column Type Relates to Notes
RemoteID string - -
DealRemoteID string Deal → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string -
  • 19 Aug 2024 There's potential for this to be an FK and while there is an Attachments endpoint, the only get method is to retrieve an 's3 upload form' for uploading a file on the client side
DealID string Deal → ID -

DealCustomFieldValue

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

DealCustomFieldChoice

Column Type Relates to Notes
RemoteID string - -
DealCustomFieldRemoteID string DealCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DealCustomFieldID string DealCustomField → ID -
Value string - -

FilterCondition

Column Type Relates to Notes
RemoteID string - -
FilterRemoteID string Filter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
FilterID string Filter → ID -
LineNumber int - -
Condition string - -

ItemGroupItem

Column Type Relates to Notes
RemoteID string - -
ItemGroupRemoteID string ItemGroup → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string Item → ID -
ItemGroupID string ItemGroup → ID -

LeadSourceUserCount

Column Type Relates to Notes
RemoteID string - -
LeadSourceRemoteID string LeadSource → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
LeadSourceID string LeadSource → ID -
UserID string User → ID -
Counts int - -

MeetingAttachment

Column Type Relates to Notes
RemoteID string - -
MeetingRemoteID string Meeting → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string -
  • 19 Aug 2024 There's potential for this to be an FK and while there is an Attachments endpoint, the only get method is to retrieve an 's3 upload form' for uploading a file on the client side
MeetingID string Meeting → ID -

NoteAttachment

Column Type Relates to Notes
RemoteID string - -
NoteRemoteID string Note → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string -
  • 19 Aug 2024 There's potential for this to be an FK and while there is an Attachments endpoint, the only get method is to retrieve an 's3 upload form' for uploading a file on the client side
NoteID string Note → ID -

PipelineStage

Column Type Relates to Notes
RemoteID string - -
PipelineRemoteID string Pipeline → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PipelineID string Pipeline → ID -
Stage int - -
Label string - -

StatusUserCount

Column Type Relates to Notes
RemoteID string - -
StatusRemoteID string Status → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
StatusID string Status → ID -
UserID string User → ID -
Counts int - -

UserAccountRight

Column Type Relates to Notes
RemoteID string - -
UserRemoteID string User → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
UserID string User → ID -
Value string - -

Need more?

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

Connect your own OnePageCRM data Querying OnePageCRM using regular SQL