Pipedrive Connector Objects (V1 Schema)

NameDescription
ActivitiesGet all Activities assigned to a particular User.
ActivitiesAttendeesGet all Activities attendees assigned to a particular User
ActivitiesParticipantsGetdetails of activities participants
ActivityFieldsReturns all activity fields.
ActivityFieldsOptionsReturns all activity fields.
ActivityTypesGet all ActivityTypes.
CallLogsReturns all call logs assigned to a particular user.
CurrenciesReturns all supported currencies in given account which should be used when saving monetary values with other objects.
CurrentUsersReturns data about an authorized user within the company with bound company data: company ID, company name, and domain.
DealFieldsReturns data about all deal fields.
DealFieldsOptionsReturns data about all deal fields.
DealsGet all deals.
DealsActivitiesGet all Deals Activities assigned to a particular User.
DealsActivitiesAttendeesGet Details of Deals Activities Attendees.
DealsActivitiesParticipantsGetdetails of activities participants.
DealsFilesGet details of deals file.
DealsFollowersGet details of deals followers.
DealsMailMessagesGet details of Deal mail Messages.
DealsMailMessagesBccGet details of Deal mail Messages.
DealsMailMessagesCcGet details of Deal mail Messages.
DealsMailMessagesFromGet details of Deal mail Messages.
DealsMailMessagesToGet details of Deal mail Messages.
DealsParticipantsGet details of deals participants.
DealsParticipantsEmailGet details of deals participants Person Email.
DealsParticipantsPersonEmailGet details of deals participants Person Email.
DealsParticipantsPersonPhoneGet details of deals participants Person Phone.
DealsParticipantsPhoneGet details of deals participants Person Email.
DealsPermittedUsersGet details of deals Permitted users
DealsPersonEmailsGet all emails asscociated with persons in deal
DealsPersonPhoneGet all phone asscociated with persons in deal.
DealsPersonsGet details of deals persons.
DealsPersonsEmailGet details of deals participants Person Email.
DealsPersonsPhoneGet details of deals participants Person Email.
DealsProductsGet details of deals products.
DealsSummaryReturn detils of deals summary.
DealsTimelineReturn details of deals timeline
DealsTimelineDealsReturn details of DealsTimeline deals.
DealsUpdatesGet details of deals updates.
DealsUpdatesAttachmentsGet details of deals Updates Attachments.
DealsUpdatesAttendeesGet Details of Deals Activities Attendees.
DealsUpdatesBccGet details of Deal updates Bcc.
DealsUpdatesCcGet details of Deals Updates cc.
DealsUpdatesFromGet details of Deals Updates From.
DealsUpdatesParticipantsGet details of deals updates participants.
DealsUpdatesToGet details of Deals Updates to.
FilesReturns data about all files.
FilterHelpersReturns all supported filter helpers.
FiltersReturns data about all filters.
FindUsersByNameFinds users by their name.
GoalsGoals help your team meet your sales targets.
LeadLabelsReturns details of all Lead Labels.
LeadsReturns lead data.
LeadSourcesReturns all Lead Sources.
MailMessagesReturns data about a specific mail message.
MailThreadMessagesReturns all the mail messages inside a specified mail thread..
MailThreadMessagesFromReturns all the mail messages inside a specified mail thread.
MailThreadMessagesToReturns all the mail messages inside a specified mail thread.
MailThreadsGet, Update and Delete mail threads in a specified folder ordered by the most recent message within.
MailThreadsFromGet details of the user who sent the mail.
MailThreadsToGet details of the user to whom sent the mail.
NoteCommentsCreate, Update, Delete and Get the comments associated with a note.
NoteFieldsReturns data about all note fields.
NoteFieldsOptionsReturns data about all note fields options.
NotesReturns all notes.
OrganizationFieldsReturns data about all organization fields.
OrganizationFieldsOptionsReturns data about all organization fields options.
OrganizationRelationshipsGets all of the relationships.
OrganizationsGet details of organizations
OrganizationsActivitiesGet details of organizations activities.
OrganizationsActivitiesAttendeesGet details of organizations activities attendees.
OrganizationsActivitiesParticipantsGet details of organizations activities participants.
OrganizationsDealsGet details of organization deals.
OrganizationsDealsPersonEmailget details of deals person email.
OrganizationsDealsPersonphoneget details of deals person phone.
OrganizationsFilesGet details of deals file.
OrganizationsFollowersGet details of organizations followers.
OrganizationsInternalGet details of organizations.
OrganizationsMailMessagesGet details of organizations mail Messages.
OrganizationsMailMessagesBccGet details of organizations mail Messages.
OrganizationsMailMessagesCcGet details of organizations mail Messages.
OrganizationsMailMessagesFromGet details of organizations mail Messages.
OrganizationsMailMessagesToGet details of organizations mail Messages.
OrganizationsPermittedUsersGet details of permitted users of organizations.
OrganizationsPersonsGet details of organizations persons
OrganizationsPersonsEmailGet details of organizations persons email
OrganizationsPersonsPhoneGet details of organizations persons phone
OrganizationsUpdatesGet details of organizations updates..
OrganizationsUpdatesAttendeesGet details of all attendees of organizations.
OrganizationsUpdatesParticipantsGetdetails of activities participants.
PermissionSetsGet all permissions.
PermissionSetsAssignments.
PersonFieldsReturns data about all person fields.
PersonFieldsOptionsReturns data about all person fields options.
PersonFollowersGet details of persons followers.
PersonsGet all details of persons.
PersonsActivitiesGet all Persons Activities assigned to a particular Persons.
PersonsActivitiesAttendeesGet Details of Persons Activities Attendees.
PersonsActivitiesParticipantsGet details of Persons activities participants.
PersonsDealsGet details of Persons deals.
PersonsDealsEmailGet details of Persons deals email.
PersonsDealsPhoneGet details of Persons deals phone.
PersonsEmailsGet all emails asscociated with persons.
PersonsFilesGet details of Persons file.
PersonsMailMessagesGet details of organizations mail Messages.
PersonsMailMessagesBccGet details of Persons mail Messages.
PersonsMailMessagesCcGet details of persons mail Messages.
PersonsMailMessagesFromGet details of persons mail Messages.
PersonsMailMessagesToGet details of Persons mail Messages.
PersonsPermittedUsersGet details of permitted users of persons.
PersonsPhoneGet all phone asscociated with persons.
PersonsProductsGet details of Persons Products.
PersonsUpdatesGet details of persons updates.
PersonsUpdatesAttendeesGet details of Deals Activities Attendees.
PersonsUpdatesParticipantsGet details of activities participants
PipelineDealsLists deals in a specific pipeline across all its stages.
PipelineDealsConversionRatesReturns statistics for deals movements for given time period.
PipelineDealsMovementsReturns statistics for deals movements for given time period.
PipelineDealsMovementsAverageAgeInDaysByStagesReturns statistics for deals movements for given time period average age in days.
PipelineDealsStageConversionsReturns statistics for deals movements for given time period
PipelinesGet all Pipelines.
ProductFieldsReturns data about all product fields.
ProductFieldsOptionsReturns data about all product fields options.
ProductsGet details of Products
ProductsDealsGet details of Products Deals.
ProductsDealsPersonEmailGet details of Products Deals person email.
ProductsDealsPersonphoneGet details of deals person phone.
ProductsFilesGet details of Persons file.
ProductsFollowersGet details of products followers.
ProductsPermittedUsersGet details of users permitted to access a Product.
ProductsPricesGet details of Products Prices.
RecentsReturns data about all recent changes occurred after given timestamp.
RecentsAttendeesReturns data about all recent changes occurred after given timestamp attendees.
RecentsParticipantsReturns data about all recent changes occurred after given timestamp participants.
RolesReturns all the role.
RolesAssignmentsList assignments for a role.
RolesPipelinesVisibilityGet the list of either visible or hidden pipeline IDs for a specific role.
RolesSettingReturns all the roles settings.
StagesReturns data about all stages.
StagesDealsGet deals in a specific stage.
SubscriptionPaymentsReturns all payments of an installment or recurring subscription.
SubscriptionsReturns details of an installment or a recurring Subscription
UserConnectionThe data of user connections.
UsersReturns data about all users within the company
UsersAccessReturns data about all users within the company access.
UserSettingsList settings of an authorized user.
UsersFollowersLists the followers of a specific user.
UsersPermissionsLists the followers of a specific user.
UsersRoleAssignmentsLists role assignments for a user.
UsersRoleSettingsLists the settings of user assigned role.
NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoActivity Id.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
AssignedToUserIdIntegerTrueNoAssignedToUserId.
AttendeesStringFalseNoAttendees of the Activity This can be either your existing Pipedrive contacts or an external email address.
BusyFlagBooleanTrueNoSet the Activity as Busy or Free.
CalendarSyncStringTrueNoCalendarSync.
CompanyIdIntegerTrueNoCompanyId.
MeetingClientStringTrueNoMeetingClient.
MeetingIdStringTrueNoMeetingId.
MeetingUrlStringTrueNoMeetingUrl.
CreatedByUserIdIntegerTrueNoCreatedByUserId.
DealDropboxBccStringTrueNoDealDropboxBcc.
DealIdIntegerFalseDeals.IdNoThe ID of the Deal this Activity is associated with.
DealTitleStringTrueNoDealTitle.
DoneBooleanTrueNoWhether the Activity is done or not 0 = Not done 1 = Done If omitted returns both Done and Not done activities.
DueDateDateFalseNoDue date of the Activity Format YYYY-MM-DD
DueTimeTimeFalseNoDue time of the Activity in UTC Format HH
DurationTimeTrueNoDuration of the Activity Format HH
FileCleanNameStringTrueNoFileCleanName.
FileIdStringTrueFiles.IdNoFileId.
FileUrlStringTrueNoFileUrl.
GcalEventIdStringTrueNoGcalEventId.
GoogleCalendarEtagStringTrueNoGoogleCalendarEtag.
GoogleCalendarIdStringTrueNoGoogleCalendarId.
LastNotificationTimeDatetimeTrueNoLastNotificationTime.
LastNotificationUserIdIntegerTrueNoLastNotificationUserId.
LeadIdStringTrueLeads.IdNoLeadId.
LocationStringFalseNoThe address of the Activity.
AdminAreaLevel1StringTrueNoAdminAreaLevel1.
AdminAreaLevel2StringTrueNoAdminAreaLevel2.
LocationCountryStringTrueNoLocationCountry.
FormattedAddressStringTrueNoFormattedAddress.
LocationLatDoubleTrueNoLocationLat.
LocationLocalityStringTrueNoLocationLocality.
LocationLongDoubleTrueNoLocationLong.
PostalCodeStringTrueNoPostalCode.
LocationRouteStringTrueNoLocationRoute.
StreetNumberStringTrueNoStreetNumber.
SublocalityStringTrueNoSublocality.
SubpremiseStringTrueNoSubpremise.
MarkedAsDoneTimeDatetimeTrueNoMarkedAsDoneTime.
NoteStringFalseNoNote of the Activity HTML format.
NotificationLanguageIdIntegerTrueNoNotificationLanguageId.
OrgIdIntegerFalseNoThe ID of the Organization this Activity is associated with.
OrgNameStringTrueNoOrgName.
OwnerNameStringTrueNoOwnerName.
ParticipantsStringFalseNoList of multiple Persons participants this Activity is associated with If omitted single participant from person_id field is used.
PersonDropboxBccStringTrueNoPersonDropboxBcc.
PersonIdIntegerFalsePersons.IdNoThe ID of the Person this Activity is associated with.
PersonNameStringTrueNoPersonName.
PublicDescriptionStringFalseNoAdditional details about the Activity that is synced to your external calendar Unlike the note added to the Activity the description is publicly visible to any guests added to the Activity.
RecMasterActivityIdStringTrueNoRecMasterActivityId.
RecRuleStringTrueNoRecRule.
RecRuleExtensionStringTrueNoRecRuleExtension.
ReferenceIdIntegerTrueNoReferenceId.
ReferenceTypeStringTrueNoReferenceType.
SeriesStringTrueNoSeries.
SourceTimezoneStringTrueNoSourceTimezone.
SubjectStringFalseNoSubject of the Activity.
TypeStringTrueNoType of the Activity This is in correlation with the key_string parameter of ActivityTypes When value for type is not set, it will be given a default value Call.
UpdateTimeDatetimeTrueNoUpdateTime.
UpdateUserIdIntegerTrueNoThe ID of the User whose Activities will be fetched If omitted the User associated with the API token will be used If 0 Activities for all company Users will be fetched based on the permission sets.
UserIdIntegerFalseUsers.IdNoUserId.
FilterIdIntegerFalseYesThe ID of the Filter to use.
StartDateStringFalseYesUse the Activity due date where you wish to begin fetching Activities from Insert due date in YYYY-MM-DD format.
EndDateStringFalseYesUse the Activity due date where you wish to stop fetching Activities from Insert due date in YYYY-MM-DD format.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ActivitiesId [KEY]IntegerTrueActivities.IdNoActivities ID.
EmailAddressStringFalseNoEmailAddress.
IsOrganizerIntegerTrueNoIsOrganizer.
NameStringTrueNoName.
PersonIdIntegerFalsePersons.IdNoPersonId.
StatusStringTrueNoStatus.
UserIdStringTrueUsers.IdNoUserId.
TypeStringFalseYesType of the Activity This is in correlation with the key_string parameter of ActivityTypes When value for type is not set, it will be given a default value Call.
DoneBooleanFalseYesWhether the Activity is done or not. 0 = Not done 1 = Done. If omitted, returns both Done and Not done activities.
FilterIdIntegerFalseYesThe ID of the Filter to use.
StartDateStringFalseYesUse the Activity due date where you wish to begin fetching Activities from Insert due date in YYYY-MM-DD format.
EndDateStringFalseYesUse the Activity due date where you wish to stop fetching Activities from Insert due date in YYYY-MM-DD format.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonId [KEY]IntegerFalseNoPersonId
ActivitiesIdIntegerTrueActivities.IdNoActivities ID.
PrimaryFlagBooleanFalseNoPrimaryFlag
TypeStringFalseYesType of the Activity This is in correlation with the key_string parameter of ActivityTypes When value for type is not set, it will be given a default value Call
DoneBooleanFalseYesWhether the Activity is done or not 0 = Not done 1 = Done If omitted returns both Done and Not done activities
FilterIdIntegerFalseYesThe ID of the Filter to use
StartDateStringFalseYesUse the Activity due date where you wish to begin fetching Activities from Insert due date in YYYY-MM-DD format
EndDateStringFalseYesUse the Activity due date where you wish to stop fetching Activities from Insert due date in YYYY-MM-DD format
UserIdStringFalseYesUserId

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
AddVisibleFlagBooleanTrueNoAddVisibleFlag.
BulkEditAllowedBooleanTrueNoBulkEditAllowed.
DetailsVisibleFlagBooleanTrueNoDetailsVisibleFlag.
EditFlagBooleanTrueNoEditFlag.
FieldTypeStringTrueNoFieldType.
FilteringAllowedBooleanTrueNoFilteringAllowed.
ImportantFlagBooleanTrueNoImportantFlag.
IndexVisibleFlagBooleanTrueNoIndexVisibleFlag.
KeyStringTrueNoKey.
LastUpdatedByUserIdStringTrueNoLastUpdatedByUserId.
MandatoryFlagBooleanTrueNoMandatoryFlag.
NameStringTrueNoName.
OptionsStringTrueNoOptions.
OrderNrIntegerTrueNoOrderNr.
SearchableFlagBooleanTrueNoSearchableFlag.
SortableFlagBooleanTrueNoSortableFlag.
UpdateTimeDatetimeTrueNoUpdateTime.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId.
LabelStringTrueNoLabel.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoThe ID of the ActivityType.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
ColorStringFalseNoA designated color for the ActivityType in 6-character HEX format.
IconKeyStringFalseNoIcon graphic to use for representing this activity type.
IsCustomFlagBooleanTrueNoIsCustomFlag.
KeyStringStringTrueNoKeyString.
NameStringFalseNoThe name of the ActivityType.
OrderNrIntegerFalseNoAn order number for this ActivityType. Order numbers should be used to order the types in the ActivityType selections.
UpdateTimeDatetimeTrueNoUpdateTime.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoID.
ActivityIdIntegerFalseNoActivityId.
CompanyIdIntegerTrueNoCompanyId.
DealIdIntegerFalseNoThe ID of the Deal this call is associated with.
DurationStringFalseNoCall duration in seconds.
EndTimeDatetimeFalseNoThe date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM
FromPhoneNumberStringFalseNoThe number that made the call.
HasRecordingBooleanTrueNoHasRecording.
NoteStringFalseNoNote for the call log in HTML format.
OrgIdIntegerFalseNoThe ID of the Organization this call is associated with.
OutcomeStringFalseNoDescribes the outcome of the call.
PersonIdIntegerFalseNoThe ID of the Person this call is associated with.
StartTimeDatetimeFalseNoThe date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM
SubjectStringFalseNoName of the activity this call is attached to.
ToPhoneNumberStringFalseNoThe number called.
UserIdIntegerFalseNoThe ID of the owner of the call log.
LeadIdStringFalseYesOnly used for insert. The ID of the lead the call log is associated with in UUID format (optional).

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActiveFlag.
CodeStringTrueNoCode.
DecimalPointsIntegerTrueNoDecimalPoints.
IsCustomFlagBooleanTrueNoIsCustomFlag.
NameStringTrueNoName.
SymbolStringTrueNoSymbol.
TermStringFalseYesOptional search term that is searched for from currency's name and/or code.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the user.
ActivatedBooleanTrueNoActivated.
ActiveFlagBooleanTrueNoWhether the user is active or not.
CreatedDatetimeTrueNoCreated.
DefaultCurrencyStringTrueNoDefaultCurrency.
EmailStringTrueNoEmail of the user.
HascreatedcompanyBooleanTrueNoHascreatedcompany.
IconUrlStringTrueNoIconUrl.
IsAdminIntegerTrueNoIsAdmin.
IsYouBooleanTrueNoIsYou.
LangIntegerTrueNoLang.
LastLoginDatetimeTrueNoLastLogin.
LocaleStringTrueNoLocale.
ModifiedDatetimeTrueNoModified.
NameStringTrueNoName of the user.
PhoneStringTrueNoPhone.
RoleIdIntegerTrueNoID of the role.
TimezoneNameStringTrueNoTimezoneName.
TimezoneOffsetStringTrueNoTimezoneOffset.
AccessStringTrueNoThe access given to the user.
CompanyIdIntegerTrueNoCompany Id.
CompanyNameStringTrueNoCompany Name.
CompanyDomainStringTrueNoCompany Domain.
CompanyCountryStringTrueNoCompany Country.
CompanyIndustryStringTrueNoCompany Industry.
LanguageCodeStringTrueNoLanguage Code.
CountryCodeStringTrueNoCountry Code.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the field.
ActiveFlagBooleanTrueNoWhether the field is available in 'add new' modal or not (both in web and mobile app).
AddTimeDatetimeTrueNoAddTime.
AddVisibleFlagBooleanFalseNoAddVisibleFlag.
BulkEditAllowedBooleanTrueNoBulkEditAllowed.
DetailsVisibleFlagBooleanTrueNoDetailsVisibleFlag.
EditFlagBooleanTrueNoEditFlag.
FieldTypeStringFalseNoType of the field.
FilteringAllowedBooleanTrueNoFilteringAllowed.
ImportantFlagBooleanTrueNoImportantFlag.
IndexVisibleFlagBooleanTrueNoIndexVisibleFlag.
KeyStringTrueNoKey.
LastUpdatedByUserIdStringTrueNoLastUpdatedByUserId.
MandatoryFlagBooleanTrueNoMandatoryFlag.
NameStringFalseNoName of the field.
OptionsStringFalseNoOptions.
OrderNrIntegerTrueNoOrderNr.
SearchableFlagBooleanTrueNoSearchableFlag.
SortableFlagBooleanTrueNoSortableFlag.
UpdateTimeDatetimeTrueNoUpdateTime.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoId.
LabelStringFalseNoLabel.
NameStringFalseYesName of the field.
FieldTypeStringFalseYesType of the field.
AddVisibleFlagBooleanFalseYesAddVisibleFlag.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoDeals id.
ActiveBooleanTrueNoActive.
ActivitiesCountIntegerTrueNoActivities Count.
AddTimeDatetimeFalseNoAddTime.
CcEmailStringTrueNoCc Email.
CloseTimeStringTrueNoClose Time.
CreatorActiveFlagBooleanTrueNoCreator ActiveFlag.
CreatorEmailStringTrueNoCreator Email.
CreatorHasPicBooleanTrueNoCreator HasPic.
CreatorIdIntegerTrueNoCreator Id.
CreatorNameStringTrueNoCreator Name.
CreatorPicHashStringTrueNoCreatorPicHash.
CreatorvalueIntegerTrueNoCreatorvalue.
CurrencyStringFalseNoCurrency.
CustomeFieldStringTrueNoCustomeField you will get the result of this column only when criteria filter title is used.
DeletedBooleanTrueNoDeleted.
DoneActivitiesCountIntegerTrueNoDone Activities Count.
EmailMessagesCountIntegerTrueNoEmail Messages Count.
ExpectedCloseDateDateFalseNoExpected Close Date.
FilesCountIntegerTrueNoFiles Count.
FirstWonTimeDatetimeTrueNoFirst Won Time.
FollowersCountIntegerTrueNoFollowers Count.
FormattedValueStringTrueNoFormatted Value.
FormattedWeightedValueStringTrueNoFormatted Weighted Value.
LabelStringTrueNoLabel.
LastActivityDateStringTrueNoLast Activity Date.
LastActivityIdStringTrueNoLast Activity Id.
LastIncomingMailTimeDatetimeTrueNoLast Incoming MailTime.
LastOutgoingMailTimeDatetimeTrueNoLast OutgoingMail Time.
LostReasonStringFalseNoLost Reason.
LostTimeStringTrueNoLost Time.
NextActivityDateDateTrueNoNext Activity Date.
NextActivityDurationTimeTrueNoNext Activity Duration.
NextActivityIdIntegerTrueNoNext Activity Id.
NextActivityNoteStringTrueNoNext Activity Note.
NextActivitySubjectStringTrueNoNext Activity Subject.
NextActivityTimeTimeTrueNoNext Activity Time.
NextActivityTypeStringTrueNoNext Activity Type.
NotesCountIntegerTrueNoNotesCount.
NotesStringTrueNoNotes.
OrgHiddenBooleanTrueNoOrg Hidden.
OrgActiveFlagBooleanTrueNoOrg ActiveFlag.
OrgAddressStringTrueNoOrg Address.
OrgCcEmailStringTrueNoOrg CcEmail.
OrgNameStringTrueNoOrg Name.
OrgOwnerIdIntegerTrueNoOrg OwnerId.
OrgPeopleCountIntegerTrueNoOrg PeopleCount.
OrgValueIntegerTrueNoOrg Value.
OwnerNameStringTrueNoOwner Name.
OwnerIdStringTrueNoOwner Id you will get the result of this column only when criteria filter title is used.
ParticipantsCountIntegerTrueNoParticipants Count.
PersonHiddenBooleanTrueNoPerson Hidden.
PersonActiveFlagBooleanTrueNoPerson Active Flag.
PersonEmailStringTrueNoPerson Email.
PersonNameStringTrueNoPerson Name.
PersonPhoneStringTrueNoPerson Phone.
PersonvalueIntegerTrueNoPersonvalue.
PipelineIdIntegerTrueNoPipelineId.
ProbabilityStringTrueNoProbability.
ProductsCountIntegerTrueNoProducts Count.
RottenTimeStringTrueNoRottenTime.
ResultScoreStringTrueNoResult score you will get the result of this column only when criteria filter title is used.
StageChangeTimeDatetimeTrueNoStage Change Time.
StageIdIntegerTrueStages.IdNoStageId.
StageNameStringTrueNoStageName.
StageOrderNrIntegerTrueNoStage OrderNr.
StatusStringFalseNoStatus.
TitleStringFalseNoTitle.
TypeStringTrueNoType you will get the result of this column only when criteria filter title is used.
UndoneActivitiesCountIntegerTrueNoUndone Activities Count.
UpdateTimeDatetimeTrueNoUpdate Time.
UserActiveFlagBooleanTrueNoUser ActiveFlag.
UserEmailStringTrueNoUser Email.
UserHasPicBooleanTrueNoUser HasPic.
UserIdIntegerFalseNoUser Id.
UserNameStringTrueNoUser Name.
UserPicHashStringTrueNoUser PicHash.
UservalueIntegerTrueNoUser value.
ValueIntegerFalseNoValue of the deal.
VisibleToStringFalseNoVisibility of the deal.
WeightedValueIntegerTrueNoVisible To.
WeightedValueCurrencyStringTrueNoWeighted Value Currency.
OrderOfStagesIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AverageTimeToWonYIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AverageTimeToWonMIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AverageTimeToWondIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AverageTimeToWonhIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AverageTimeToWonsIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AverageTimeToWoniIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AverageTotalSecondsIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AverageStageProgressIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AgeYIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AgeMIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AgedIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AgehIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AgesIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AgeiIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
AgeTotalSecondsIntegerTrueNoYou will get the result of this column only when criteria filter id is used.
WonTimeDatetimeTrueNoWon time.
FilterIdIntegerFalseYesFilter Id
OwnedByYouIntegerFalseYesOwned By You
PersonIdIntegerFalseYesPerson Id. Only used when performing INSERT or UPDATE operation.
OrgIdIntegerFalseYesOrg Id. Only used when performing INSERT or UPDATE operation.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActive Flag.
AddTtimeDatetimeTrueNoAdd Ttime.
AssignedToUserIdIntegerTrueNoAssigned To UserId.
AttendeesStringTrueNoAttendees.
BusyFlagBooleanTrueNoBusyFlag.
IncludeContextStringTrueNoInclude Context.
CompanyIdIntegerTrueNoCompany Id.
MeetingClientStringTrueNoMeeting Client.
MeetingIdStringTrueNoMeeting Id.
MeetingUrlStringTrueNoMeeting Url.
CreatedByUserIdIntegerTrueNoCreatedBy UserId.
DealDropboxBccStringTrueNoDeal Dropbox Bcc.
DealIdIntegerTrueNoDeal Id.
DealTitleStringTrueNoDeal Title.
DoneBooleanTrueNoWhether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
DueDateDateTrueNoDue Date.
DueTimeTimeTrueNoDue Time.
DurationTimeTrueNoDuration.
FileCleanNameStringTrueNoFileCleanName.
FileIdStringTrueNoFileId.
FileUrlStringTrueNoFileUrl.
EventIdStringTrueNoeventId.
CalendarEtagStringTrueNoCalendarEtag.
CalendarIdStringTrueNoCalendar Id.
NotificationTimeDatetimeTrueNoNotification Time.
NotificationUserIdIntegerTrueNoNotification UserId.
LeadIdStringTrueNoLead Id.
LocationStringTrueNoLocation.
AreaLevel1StringTrueNoAreaLevel1.
AreaLevel2StringTrueNoAreaLevel2.
CountryStringTrueNoCountry.
FormattedAddressStringTrueNoFormattedAddress.
LatDoubleTrueNoLat.
LocalityStringTrueNoLocality.
LongDoubleTrueNoLong.
PostalCodeStringTrueNoPostalCode.
RouteStringTrueNoRoute.
StreetNumberStringTrueNoStreetNumber.
SublocalityStringTrueNoSublocality.
SubpremiseStringTrueNoSubpremise.
MarkedAsDoneTimeDatetimeTrueNoMarkedAsDoneTime.
NoteStringTrueNoNote.
NotificationLanguageIdIntegerTrueNoNotificationLanguageId.
OrgIdIntegerTrueNoOrgId.
OrgNameStringTrueNoOrgName.
OwnerNameStringTrueNoOwnerName.
ParticipantsStringTrueNoParticipants.
PersonDropboxBccStringTrueNoPerson Dropbox Bcc.
PersonIdIntegerTrueNoPersonId.
PersonNameStringTrueNoPersonName.
PublicDescriptionStringTrueNoPublicDescription.
MasterActivityIdStringTrueNoMasterActivityId.
RuleStringTrueNoRule.
RuleExtensionStringTrueNoRuleExtension.
ReferenceIdIntegerTrueNoReferenceId.
ReferenceTypeStringTrueNoReferenceType.
SeriesStringTrueNoSeries.
SourceTimezoneStringTrueNoSourceTimezone.
SubjectStringTrueNoSubject.
TypeStringTrueNoType.
UpdateTimeDatetimeTrueNoUpdateTime.
UpdateUserIdIntegerTrueNoUpdateUserId.
UserIdIntegerTrueNoUserId.
ExcludeStringFalseYesA comma-separated string of activity IDs to exclude from result.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealIdIntegerTrueNoDeal Id.
EmailAddressStringFalseNoEmailAddress.
IsOrganizerIntegerTrueNoIsOrganizer.
NameStringTrueNoName.
PersonIdIntegerFalsePersons.IdNoPersonId.
StatusStringTrueNoStatus.
UserIdStringTrueUsers.IdNoUserId.
DoneBooleanFalseYesWhether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
ExcludeStringFalseYesA comma-separated string of activity IDs to exclude from result.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealIdIntegerTrueNoDeal Id.
PersonId [KEY]IntegerFalseNoPersonId.
PrimaryFlagBooleanFalseNoPrimaryFlag.
DoneBooleanFalseYesWhether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
ExcludeStringFalseYesA comma-separated string of activity IDs to exclude from result.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the deal.
ActiveFlagBooleanTrueNoActive Flag.
ActivityIdStringTrueNoActivity Id.
AddTimeDatetimeTrueNoAddTime.
CidStringTrueNoCid.
DealIdStringTrueNoDeal Id.
DealNameStringTrueNoDealName.
DescriptionStringTrueNoDescription.
FileNameStringTrueNoFile Name.
FileSizeIntegerTrueNoFile Size.
FileTypeStringTrueNoFile Type.
InlineFlagBooleanTrueNoInline Flag.
LogIdStringTrueNoLog Id.
MailMessageIdStringTrueNoMailMessage Id.
MailTemplateIdStringTrueNoMailTemplate Id.
NameStringTrueNoName.
OrgIdIntegerTrueNoOrg Id.
OrgNameStringTrueNoOrg Name.
PeopleNameStringTrueNoPeople Name.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPerson Name.
ProductIdStringTrueNoProduct Id.
ProductNameStringTrueNoProduct Name.
RemoteIdStringTrueNoRemote Id.
RemoteLocationStringTrueNoRemote Location.
S3BucketStringTrueNoS3Bucket.
UpdateTimeDatetimeTrueNoUpdate Time.
UrlStringTrueNoUrl.
UserIdIntegerTrueNoUserId.
LeadIdStringTrueNoLead Id.
LeadNameStringTrueNoLead Name.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
AddTimeDatetimeTrueNoAddTime.
UserIdIntegerFalseUsers.IdNoUser Id.
DealIdIntegerTrueDeals.IdNoDeal Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoid.
AccountIdStringTrueNoAccountId.
AddTimeDatetimeTrueNoaddTime.
BccStringTrueNoBcc.
BodyUrlStringTrueNobodyUrl.
CcStringTrueNocc.
CompanyIdIntegerTrueNocompanyId.
DeletedFlagIntegerTrueNoDeletedFlag.
DraftStringTrueNoDraft.
DraftFlagIntegerTrueNoDraftFlag.
ExternalDeletedFlagIntegerTrueNoExternalDeletedFlag.
FromStringTrueNoFrom.
AttachmentsFlagIntegerTrueNoAttachmentsFlag.
BodyFlagIntegerTrueNoBodyFlag.
InlineAttachmentsFlagIntegerTrueNoInlineAttachmentsFlag.
RealAttachmentsFlagIntegerTrueNoRealAttachmentsFlag.
ItemTypeStringTrueNoItemType.
TrackingEnabledFlagIntegerTrueNoTrackingEnabledFlag.
ThreadIdIntegerTrueNoThreadId.
TrackingStatusStringTrueNoTrackingStatus.
MessageTimeStringTrueNoMessageTime.
MessageIdStringTrueNoMessageId.
NylasIdStringTrueNoNylasId.
ReadFlagIntegerTrueNoReadFlag.
S3BucketStringTrueNoS3Bucket.
S3BucketPathStringTrueNoS3BucketPath.
SentFlagIntegerTrueNoSentFlag.
SentFromPipedriveFlagIntegerTrueNoSentFromPipedriveFlag.
SmartBccFlagIntegerTrueNoSmartBccFlag.
SnippetStringTrueNoSnippet.
SubjectStringTrueNoSubject.
SyncedFlagIntegerTrueNoSyncedFlag.
TemplateIdStringTrueNoTemplateId.
TimestampDatetimeTrueNoTimestamp.
ToStringTrueNoTo.
UpdateTimeDatetimeTrueNoUpdateTime.
UserIdIntegerTrueNoUserId.
WriteFlagBooleanTrueNowriteFlag.
ObjectStringTrueNoObject.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoid.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
AddedByactiveFlagBooleanTrueNoAddedByactiveFlag.
AddedByemailStringTrueNoAddedByemail.
AddedByhasPicIntegerTrueNoAddedByhasPic.
AddedByidIntegerTrueNoAddedByid.
AddedBynameStringTrueNoAddedByname.
AddedBypicHashStringTrueNoAddedBypicHash.
AddedByvalueIntegerTrueNoAdded_byvalue.
PersonActiveFlagBooleanTrueNoPersonActiveFlag.
ActivitiesCountIntegerTrueNoActivitiesCount.
PersonAddTimeDatetimeTrueNoAddTime.
CcEmailStringTrueNoCcEmail.
ClosedDealsCountIntegerTrueNoClosedDealsCount.
CompanyIdIntegerTrueNoCompanyId.
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount.
EmailStringTrueNoEmail.
EmailMessagesCountIntegerTrueNoEmailMessagesCount.
FilesCountIntegerTrueNoFilesCount.
FirstCharStringTrueNoFirstChar.
FirstNameStringTrueNoFirstName.
FollowersCountIntegerTrueNoFollowersCount.
PersonlabelStringTrueNoPersonlabel.
LastActivityDateDateTrueNoLastActivityDate.
LastActivityIdIntegerTrueNoLastActivityId.
LastincomingMailTimeStringTrueNoLastincomingMailTime.
LastnameStringTrueNoLastname.
LastoutgoingMailTimeStringTrueNoLastoutgoingMailTime.
LostdealsCountIntegerTrueNoLostdealsCount.
NameStringTrueNoName.
NextActivityDateDateTrueNonextActivityDate.
NextActivityIdIntegerTrueNonextActivityId.
NextActivityTimeStringTrueNonextActivityTime.
NotesCountIntegerTrueNoNotesCount.
OpenDealsCountIntegerTrueNoOpenDealsCount.
OrgActiveFlagBooleanTrueNoOrgActiveFlag.
OrgAddressStringTrueNoOrgAddress.
OrgCcEmailStringTrueNoOrgCcEmail.
OrgNameStringTrueNoOrgName.
OrgownerIdIntegerTrueNoOrgownerId.
OrgpeopleCountIntegerTrueNoOrgpeopleCount.
OrgIdIntegerTrueNoOrgId.
OwnerActiveFlagBooleanTrueNoOwnerActiveFlag.
OwnerEmailStringTrueNoOwnerEmail.
OwnerHasPicIntegerTrueNoOwnerHasPic.
OwnerIdIntegerTrueNoOwnerId.
OwnerNameStringTrueNoOwnerName.
OwnerPicHashStringTrueNoOwnerPicHash.
OwnerValueIntegerTrueNoOwnerValue.
ParticipantClosedDealsCountIntegerTrueNoClosedDealsCount.
ParticipantOpenDealsCountIntegerTrueNoOpenDealsCount.
PhoneStringTrueNoPhone.
PictureIdStringTrueNoPictureId.
RelatedclosedDealsCountIntegerTrueNoRelatedclosedDealsCount.
RelatedlostDealsCountIntegerTrueNoRelatedlostDealsCount.
RelatedopenDealsCountIntegerTrueNoRelatedopenDealsCount.
RelatedwonDealsCountIntegerTrueNoRelatedwonDealsCount.
SyncNeededBooleanTrueNoSyncNeeded.
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount.
UpdateTimeDatetimeTrueNoUpdateTime.
VisibleToStringTrueNovisibleTo.
WonDealsCountIntegerTrueNoWonDealsCount.
PersonIdActiveFlagBooleanTrueNoPersonactiveFlag.
PersonemailStringTrueNoPersonemail.
PersonnameStringTrueNoPersonname.
PersonphoneStringTrueNoPersonphone.
PersonValuesIntegerFalseNoPersonValues.
ItemDealIdIntegerTrueDeals.idNoItemDealId.
ItemTitleStringTrueNoItemTitle.
ItemIdIntegerTrueNoItemId.
ItemTypeStringTrueNoItemType.
PersonIdIntegerFalsePersons.IdNoPerson Id.
PersonOrgNameStringTrueNoPerson OrgName.
PersonOwnerNameStringTrueNoPerson OwnerName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealsParticipantsId [KEY]IntegerTrueDealsParticipants.IdNoId.
LabelStringTrueNoLabel.
ValueStringTrueNoEmail.
PrimaryBooleanTrueNoBoolean value Primary.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealsParticipantsId [KEY]IntegerTrueDealsParticipants.IdNoId.
LabelStringTrueNoLabel.
ValueStringTrueNoEmail.
PrimaryBooleanTrueNoBoolean value Primary.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealsParticipantsId [KEY]IntegerTrueDealsParticipants.IdNoId.
LabelStringTrueNoLabel.
ValueStringTrueNoValue.
PrimaryBooleanTrueNoBoolean value Primary.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealsParticipantsId [KEY]IntegerTrueDealsParticipants.IdNoId.
LabelStringTrueNoLabel.
ValueStringTrueNoValue.
PrimaryBooleanTrueNoBoolean value Primary.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DataStringTrueNoData.
IdStringFalseYesId.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealsId [KEY]IntegerTrueDeals.IdNoDeals ID.
LabelStringTrueNoLabel.
ValueStringTrueNoValue.
PrimaryBooleanTrueNoPrimary.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealsId [KEY]IntegerTrueDeals.IdNoDeals ID.
labelStringTrueNoLabel.
ValueStringTrueNoValue.
PrimaryBooleanTrueNoPrimary.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
DealIdIntegerTrueNoDeal Id.
ActivitiesCountIntegerTrueNoActivitiesCount.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
CcEmailStringTrueNoCcEmail.
ClosedDealsCountIntegerTrueNoClosedDealsCount.
CompanyIdIntegerTrueNoCompanyId.
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount.
EmailStringTrueNoEmail.
EmailMessagesCountIntegerTrueNoEmailMessagesCount.
FilesCountIntegerTrueNoFilesCount.
LabelIntegerTrueNolabel.
LastActivityDateDateTrueNoLastActivityDate.
LastActivityIdIntegerTrueNoLastActivityId.
LastincomingMailTimeStringTrueNoLastincomingMailTime.
LastnameStringTrueNoLastname.
LastoutgoingMailTimeStringTrueNoLastoutgoingMailTime.
LostdealsCountIntegerTrueNoLostdealsCount.
NameStringTrueNoName.
NextActivityDateDateTrueNonextActivityDate.
NextActivityIdIntegerTrueNonextActivityId.
NextActivityTimeStringTrueNonextActivityTime.
NotesCountIntegerTrueNoNotesCount.
OpenDealsCountIntegerTrueNoOpenDealsCount.
OrgActiveFlagBooleanTrueNoOrgActiveFlag.
OrgAddressStringTrueNoOrgAddress.
OrgCcEmailStringTrueNoOrgCcEmail.
OrgNameStringTrueNoOrgName.
OrgownerIdIntegerTrueNoOrgownerId.
OrgpeopleCountIntegerTrueNoOrgpeopleCount.
OrgIdIntegerTrueNoOrgId.
OwnerActiveFlagBooleanTrueNoOwnerActiveFlag.
OwnerEmailStringTrueNoOwnerEmail.
OwnerHasPicIntegerTrueNoOwnerHasPic.
OwnerIdIntegerTrueNoOwnerId.
OwnerNameStringTrueNoOwnerName.
OwnerPicHashStringTrueNoOwnerPicHash.
OwnerValueIntegerTrueNoOwnerValue.
ParticipantClosedDealsCountIntegerTrueNoClosedDealsCount.
ParticipantOpenDealsCountIntegerTrueNoOpenDealsCount.
PhoneStringTrueNoPhone.
PictureActiveFlagBooleanTrueNoPictureActiveFlag.
PictureaddTimeDatetimeTrueNoPictureaddTime.
PictureaddedByUserIdIntegerTrueNoPictureaddedByUserId.
PictureItemIdIntegerTrueNoPictureItemId.
PictureitemTypeStringTrueNoPictureitemType.
Picture128StringTrueNoPicture128.
Picture512StringTrueNoPicture512.
PictureupdateTimeStringTrueNoPictureupdateTime.
PicturevalueIntegerTrueNoPicturevalue.
PictureIdStringTrueNoPictureId.
RelatedclosedDealsCountIntegerTrueNoRelatedclosedDealsCount.
RelatedlostDealsCountIntegerTrueNoRelatedlostDealsCount.
RelatedopenDealsCountIntegerTrueNoRelatedopenDealsCount.
RelatedwonDealsCountIntegerTrueNoRelatedwonDealsCount.
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount.
UpdateTimeDatetimeTrueNoUpdateTime.
VisibleToStringTrueNovisibleTo.
WonDealsCountIntegerTrueNoWonDealsCount.
FirstNameStringTrueNoFirst Name.
FollowersCountIntegerTrueNoFollowers Count.
PrimaryEmailStringTrueNoPrimary Email.
FirstCharStringTrueNoFirst Char.
MarketingStatusStringTrueNoMarketing Status.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealsPersonsId [KEY]IntegerTrueDealsPersons.IdNoId.
LabelStringTrueNoLabel.
ValueStringTrueNoEmail.
PrimaryBooleanTrueNoBoolean value Primary.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealsPersonsId [KEY]IntegerTrueDealsPersons.IdNoId.
LabelStringTrueNoLabel.
ValueStringTrueNoValue.
PrimaryBooleanTrueNoBoolean value Primary.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
CommentsStringFalseNoAny textual comment associated with this product-deal attachment.
CurrencyStringTrueNoCurrency.
DealIdIntegerTrueDeals.IdNoDeal id.
DiscountPercentageDoubleTrueNoDiscount %.
DurationIntegerTrueNoDuration of the product.
DurationUnitStringTrueNoDurationUnit.
EnabledFlagBooleanFalseNoWhether the product is enabled on the deal or not.
ItemPriceIntegerFalseNoPrice at which this product will be added to the deal.
LastEditStringTrueNoLastEdit.
NameStringTrueNoName.
OrderNrIntegerTrueNoOrderNr.
ProductActiveFlagBooleanTrueNoProduct ActiveFlag.
ProductAddTimeDatetimeTrueNoProduct AddTime.
CategoryStringTrueNoCategory.
codeStringTrueNoCode.
descriptionStringTrueNoDescription.
FilesCountStringTrueNoFilesCount.
FirstCharStringTrueNoFirstChar.
ProductsIdIntegerTrueNoProductsId.
ProductNameStringTrueNoProductName.
OwnerActiveFlagBooleanTrueNoOwnerActiveFlag.
OwnerEmailStringTrueNoOwnerEmail.
OwnerHasPicBooleanTrueNoOwnerHasPic.
OwnerIdIntegerTrueNoOwnerId.
OwnerNameStringTrueNoOwnerName.
OwnerPicHashStringTrueNoOwnerPicHash.
OwnerValueIntegerTrueNoOwnerValue.
EURCostIntegerTrueNoEURCost.
EURCurrencyStringTrueNoEURCurrency.
EURIdIntegerTrueNoEURId.
EUROverheadCostIntegerTrueNoEUROverheadCost.
EURPriceIntegerTrueNoEURPrice.
EURProductIdIntegerTrueNoEURProductId.
SelectableBooleanTrueNoselectable.
ProductTaxIntegerTrueNoProductTax.
unitStringTrueNounit.
UpdateTimeDatetimeTrueNoUpdateTime.
VisibleToStringTrueNoVisibleTo.
ProductIdIntegerFalseProducts.idNoID of the product that will be attached.
VariationIdStringFalseNoID of the product variation.
QuantityIntegerFalseNoHow many items of this product will be added to the deal.
QuantityFormattedStringTrueNoQuantityFormatted.
SumDoubleTrueNoSum.
SumFormattedStringTrueNoSumFormatted.
SumNoDiscountIntegerTrueNoSumNoDiscount.
TaxIntegerFalseNoTax percentage.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TotalCountIntegerTrueNoTotal Count.
TotalvalueDoubleTrueNoTotal value.
TotalValueFormattedStringTrueNoTotal Value Formatted.
TotalWeightedValueDoubleTrueNoTotal Weighted Value.
TotalWeightedValueFormattedStringTrueNoTotal Weighted Value Formatted.
EURCountIntegerTrueNoEUR Count.
EURValueIntegerTrueNoEUR Value.
EURConvertedDoubleTrueNoEUR Converted.
EURConvertedFormattedStringTrueNoEUR Converted Formatted.
EURFormattedStringTrueNoEUR Formatted.
USDCountIntegerTrueNoUSD Count.
USDValueIntegerTrueNoUSD Value.
USDConvertedIntegerTrueNoUSD Converted.
USDConvertedFormattedStringTrueNoUSD Converted Formatted.
USDFormattedStringTrueNoUSD Formatted.
WeightedEURCountIntegerTrueNoWeighted EUR Count.
WeightedEURValueIntegerTrueNoWeighted EUR Value.
WeightedEURValueFormattedStringTrueNoWeighted EUR Value Formatted.
WeightedUSDCountIntegerTrueNoWeighted USD Count.
WeightedUSDIntegerTrueNoWeighted USD.
WeightedUSDFormattedStringTrueNoWeighted USD Formatted.
FilterIdIntegerFalseYesFilter Id.
UserIdIntegerFalseYesUser Id.
StageIdIntegerFalseYesStage Id.
StatusStringFalseYesStatus.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealsStringTrueNoDeals
PeriodEndDatetimeTrueNoPeriod End
PeriodStartDateTrueNoPeriod Start
CountIntegerTrueNoCount
OpenCountIntegerTrueNoopen Count
OpenValuesEURIntegerTrueNoopen Values EUR
ValuesEURIntegerTrueNoValues EUR
ValuesUSDIntegerTrueNoValues USD
WeightedOpenValuesEURIntegerTrueNoWeighted Open Values EUR
WeightedValuesEURIntegerTrueNoWeighted Values EUR
WeightedValuesUSDIntegerTrueNoWeighted Values USD
WonCountIntegerTrueNoWon Count
WonValuesUSDIntegerTrueNoWon Values USD
StartDateDateFalseYesDate where the first interval starts. Format: YYYY-MM-DD.
IntervalTypeStringFalseYesType Of Interval.
AmountIntegerFalseYesThe number of given intervals, starting from start_date, to fetch E.g 3 months.
FieldKeyStringFalseYesThe date field key which deals will be retrieved from.
UserIdIntegerFalseYesUser id.
FilterIdIntegerFalseYesType Of Interval.
ExcludeDealsIntegerFalseYesWhether to exclude deals list 1 or not 0.
ConvertCurrencyStringFalseYes3-letter currency code of any of the supported currencies.
PipelineIdIntegerFalseYesPipeline Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveBooleanTrueNoActive.
ActivitiesCountIntegerTrueNoActivitiesCount.
AddTimeDatetimeTrueNoAddTime.
CcEmailStringTrueNoCcEmail.
CloseTimeStringTrueNoCloseTime.
CreatorUserIdIntegerTrueNoCreatorUserId.
CurrencyStringTrueNoCurrency.
DeletedBooleanTrueNoDeleted.
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount.
EmailMessagesCountIntegerTrueNoEmailMessagesCount.
ExpectedCloseDateDateTrueNoExpectedCloseDate.
FilesCountIntegerTrueNoFilesCount.
FirstWonTimeDatetimeTrueNoFirstWonTime.
FollowersCountIntegerTrueNoFollowersCount.
FormattedValueStringTrueNoFormattedValue.
FormattedWeightedValueStringTrueNoFormattedWeightedValue.
LabelStringTrueNoLabel.
LastActivityDateStringTrueNoLastActivityDate.
LastActivityIdStringTrueNoLastActivityId.
LastncomingMailTimeDatetimeTrueNoLastncomingMailTime.
LastoutgoingMailTimeDatetimeTrueNoLastoutgoingMailTime.
LostreasonStringTrueNoLostreason.
LostTimeStringTrueNoLostTime.
NextActivityDateDateTrueNoNextActivityDate.
NextActivityDurationTimeTrueNoNextActivityDuration.
NextActivityIdIntegerTrueNoNextActivityId.
NextActivityNoteStringTrueNoNextActivityNote.
NextActivitySubjectStringTrueNoNextActivitySubject.
NextActivityTimeTimeTrueNoNextActivityTime.
NextActivityTypeStringTrueNoNextActivityType.
NotesCountIntegerTrueNoNotesCount.
OrgHiddenBooleanTrueNoOrgHidden.
OrgIdIntegerTrueNoOrgId.
OrgNameStringTrueNoOrgName.
OwnerNameStringTrueNoOwnerName.
ParticipantsCountIntegerTrueNoParticipantsCount.
PersonHiddenBooleanTrueNoPersonHidden.
PersonIdIntegerTrueNoPersonId.
PersonNameStringTrueNoPersonName.
PipelineIdIntegerTruePipelines.IdNoPipelineId.
ProbabilityStringTrueNoProbability.
ProductsCountIntegerTrueNoProductsCount.
RottenTimeStringTrueNoRottenTime.
StageChangeTimeDatetimeTrueNoStageChangeTime.
StageIdIntegerTrueNoStageId.
StageOrderNrIntegerTrueNoStageOrderNr.
StatusStringTrueNoStatus.
TitleStringTrueNoTitle.
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount.
UpdateTimeDatetimeTrueNoUpdateTime.
UserIdIntegerTrueUsers.IdNoUserId.
ValueIntegerTrueNoValue.
VisibleToStringTrueNoVisibleTo.
WeightedValueIntegerTrueNoWeightedValue.
WeightedValueCurrencyStringTrueNoWeightedValueCurrency.
WonTimeDatetimeTrueNoWonTime.
StartDateDateFalseYesDate where the first interval starts. Format: YYYY-MM-DD
IntervalTypeStringFalseYesType Of Interval.
AmountIntegerFalseYesThe number of given intervals, starting from start_date, to fetch E.g 3 months.
FieldKeyStringFalseYesThe date field key which deals will be retrieved from.
FilterIdIntegerFalseYesType Of Interval.
ExcludeDealsIntegerFalseYesWhether to exclude deals list 1 or not 0.
ConvertCurrencyStringFalseYes3-letter currency code of any of the supported currencies.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdIntegerTrueNoId.
AccountIdStringTrueNoAccountId.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
AdditionalDataStringTrueNoAdditionalData.
AssignedToUserIdIntegerTrueNoAssignedToUserId.
AttachmentsStringTrueNoAttachments.
AttendeesStringTrueNoAttendees.
BccStringTrueNoBcc.
BodyUrlStringTrueNoBodyUrl.
BusyFlagBooleanTrueNoBusyFlag.
IncludeContextStringTrueNoIncludeContext.
CcStringTrueNoCc.
ChangeSourceStringTrueNoChangeSource.
UserAgentStringTrueNoUserAgent.
CompanyIdIntegerTrueNoCompanyId.
MeetingClientStringTrueNoMeetingClient.
MeetingIdStringTrueNoMeetingId.
MeetingUrlStringTrueNoMeetingUrl.
CreatedByUserIdIntegerTrueNoCreatedByUserId.
DealDropboxBccStringTrueNoDealDropboxBcc.
DealIdIntegerTrueNoDealId.
DealTitleStringTrueNoDealTitle.
DeletedFlagIntegerTrueNoDeletedFlag.
DoneBooleanTrueNoDone.
DraftStringTrueNoDraft.
DraftFlagIntegerTrueNoDraftFlag.
DueDateDateTrueNoDueDate.
DueTimeTimeTrueNoDueTime.
DurationTimeTrueNoDuration.
ExternalDeletedFlagIntegerTrueNoExternalDeletedFlag.
FieldKeyStringTrueNoFieldKey.
CleanNameStringTrueNoCleanName.
FileIdStringTrueNoFileId.
UrlStringTrueNoUrl.
FromStringTrueNoFrom.
GcalEventIdStringTrueNoGcalEventId.
GoogleCalendarEtagStringTrueNoGoogleCalendarEtag.
GoogleCalendarIdStringTrueNoGoogleCalendarId.
AttachmentsFlagIntegerTrueNoAttachmentsFlag.
BodyFlagIntegerTrueNoBodyFlag.
InlineAttachmentsFlagIntegerTrueNoInlineAttachmentsFlag.
RealAttachmentsFlagIntegerTrueNoRealAttachmentsFlag.
IsBulkUpdateFlagStringTrueNoIsBulkUpdateFlag.
ItemIdIntegerTrueNoItemId.
ItemTypeStringTrueNoItemType.
NotificationTimeDatetimeTrueNoNotificationTime.
NotificationUserIdIntegerTrueNoNotificationUserId.
LeadIdStringTrueNoLeadId.
LocationStringTrueNoLocation.
AdminAreaLevel1StringTrueNoAdminAreaLevel1.
AdminAreaLevel2StringTrueNoAdminAreaLevel2.
CountryStringTrueNoCountry.
FormattedAddressStringTrueNoFormattedAddress.
LatDoubleTrueNoLat.
LocalityStringTrueNoLocality.
LongDoubleTrueNoLong.
PostalCodeStringTrueNoPostalCode.
RouteStringTrueNoRoute.
StreetNumberStringTrueNoStreetNumber.
SublocalityStringTrueNoSublocality.
SubpremiseStringTrueNoSubpremise.
LogTimeDatetimeTrueNoLogTime.
TrackingEnabledFlagIntegerTrueNoTrackingEnabledFlag.
MailThreadIdIntegerTrueNoMailThreadId.
MailTrackingStatusStringTrueNoMailTrackingStatus.
MarkedAsDoneTimeDatetimeTrueNoMarkedAsDoneTime.
MessageTimeStringTrueNoMessageTime.
MuaMessageIdStringTrueNoMuaMessageId.
NewValueStringTrueNoNewValue.
NoteStringTrueNoNote.
LanguageIdIntegerTrueNoLanguageId.
NylasIdStringTrueNoNylasId.
OldValueIntegerTrueNoOldValue.
OrgIdIntegerTrueNoOrgId.
OrgNameStringTrueNoOrgName.
OwnerNameStringTrueNoOwnerName.
ParticipantsStringTrueNoParticipants.
PersonDropboxBccStringTrueNoPersonDropboxBcc.
PersonIdIntegerTrueNoPersonId.
PersonNameStringTrueNoPersonName.
PublicDescriptionStringTrueNoPublicDescription.
ReadFlagIntegerTrueNoReadFlag.
RecActivityIdStringTrueNoRecActivityId.
RecRuleStringTrueNoRecRule.
RecRuleExtensionStringTrueNoRecRuleExtension.
ReferenceIdIntegerTrueNoReferenceId.
ReferenceTypeStringTrueNoReferenceType.
S3BucketStringTrueNoS3Bucket.
S3BucketPathStringTrueNoS3BucketPath.
SentFlagIntegerTrueNoSentFlag.
SentFromPipedriveFlagIntegerTrueNoSentFromPipedriveFlag.
SeriesStringTrueNoSeries.
SmartBccFlagIntegerTrueNoSmartBccFlag.
SnippetStringTrueNoSnippet.
SourceTimezoneStringTrueNoSourceTimezone.
SubjectStringTrueNoSubject.
SyncedFlagIntegerTrueNoSyncedFlag.
TemplateIdStringTrueNoTemplateId.
TimestampDatetimeTrueNoTimestamp.
ToStringTrueNoTo.
TypeStringTrueNoType.
UpdateTimeDatetimeTrueNoUpdateTime.
UpdateUserIdIntegerTrueNoUpdateUserId.
UserIdIntegerTrueNoUserId.
WriteFlagBooleanTrueNoWriteFlag.
ObjectStringTrueNoObject.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesItem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActiveFlag.
ActivityIdStringTrueNoActivityId.
AddTimeDatetimeTrueNoAddTime.
CidStringTrueNoCid.
DealNameStringTrueNoDealName.
DealIdIntegerTrueNodealid.
DescriptionStringTrueNoDescription.
FileNameStringTrueNoFileName.
FileSizeIntegerTrueNoFileSize.
FileTypeStringTrueNoFileType.
InlineFlagBooleanTrueNoInlineFlag.
LogIdStringTrueNoLogId.
MailMessageIdStringTrueNoMailMessageId.
MailTemplateIdStringTrueNoMailTemplateId.
NameStringTrueNoName.
OrgIdIntegerTrueNoOrgId.
OrgNameStringTrueNoOrgName.
PeopleNameStringTrueNoPeopleName.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
ProductIdStringTrueNoProductId.
ProductNameStringTrueNoProductName.
RemoteIdStringTrueNoRemoteId.
RemoteLocationStringTrueNoRemoteLocation.
S3BucketStringTrueNoS3Bucket.
UpdateTimeDatetimeTrueNoUpdateTime.
UrlStringTrueNoUrl.
UserIdIntegerTrueNoUserId.
LeadIdIntegerTrueNoLead Id.
LeadNameIntegerTrueNoLead Name.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesItem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DealIdIntegerFalseNoDeal Id.
EmailAddressStringFalseNoEmailAddress.
IsOrganizerIntegerTrueNoIsOrganizer.
NameStringTrueNoName.
StatusStringTrueNoStatus.
UserIdStringTrueUsers.IdNoUserId.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesItem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
DealIdIntegerFalseNoDeal Id.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesitem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
PersonIdStringTrueNoPersonId.
DealIdIntegerFalseNoDeal Id.
EmailAddressStringTrueNoEmailAddress.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesitem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
DealIdIntegerFalseNoDeal Id.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.
AllChangesStringFalseYesWhether to show custom field updates or not
ItemsStringFalseYesitem specific updates

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonId [KEY]IntegerFalseNoPersonId.
DealIdIntegerFalseNoDeal Id.
PrimaryFlagBooleanFalseNoPrimaryFlag.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesItem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
DealIdIntegerFalseNoDeal Id.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesitem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the file.
ActiveFlagBooleanTrueNoActiveFlag.
ActivityIdStringTrueNoID of the activity to associate file.
AddTimeDatetimeTrueNoAddTime.
CidStringTrueNoCid.
DealIdStringTrueNoID of the deal to associate file.
DealNameStringTrueNoDealName.
DescriptionStringFalseNoDescription of the file.
FileNameStringTrueNoFileName.
FileSizeIntegerTrueNoFileSize.
FileTypeStringTrueNoFileType.
InlineFlagBooleanTrueNoInlineFlag.
LogIdStringTrueNoLogId.
MailMessageIdStringTrueNoMailMessageId.
MailTemplateIdStringTrueNoMailTemplateId.
NameStringFalseNoVisible name of the file.
OrgIdStringTrueNoID of the organization to associate file.
OrgNameStringTrueNoOrgName.
PersonIdIntegerTrueNoID of the person to associate file.
PersonNameStringTrueNoPersonName.
ProductIdStringTrueNoID of the product to associate file.
ProductNameStringTrueNoProductName.
RemoteIdStringTrueNoRemoteId.
RemoteLocationStringTrueNoRemoteLocation.
S3BucketStringTrueNoS3Bucket.
UpdateTimeDatetimeTrueNoUpdateTime.
UrlStringTrueNoUrl.
UserIdIntegerTrueNoUserId.
LeadIdStringTrueNoLeadId.
LeadNameStringTrueNoLeadName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdminAreaLevel1StringTrueNoAdminAreaLevel1.
AdminAreaLevel2StringTrueNoAdminAreaLevel2.
CountryStringTrueNoCountry.
FormattedAddressStringTrueNoFormattedAddress.
LocalityStringTrueNoLocality.
PostalCodeStringTrueNoPostalCode.
RouteStringTrueNoRoute.
StreetNumberStringTrueNoStreetNumber.
SublocalityStringTrueNoSublocality.
SubpremiseStringTrueNoSubpremise.
CurrencyNotEqualStringTrueNoCurrencyNotEqual.
CurrencyEqualStringTrueNoCurrencyEqual.
DateNotEqualStringTrueNoDateNotEqual.
DateLessThanStringTrueNoDateLessThan.
DateLessThanOrEqualStringTrueNoDateLessThanOrEqual.
DateEqualStringTrueNoDateEqual.
DateGreaterThanStringTrueNoDateGreaterThan.
DateGreaterThanOrEqualStringTrueNoDateGreaterThanOrEqual.
DateISNOTNULLStringTrueNoDateISNOTNULL.
DateISNULLStringTrueNoDateISNULL.
DateRangeNotEqualStringTrueNoDateRangeNotEqual.
DateRangeLessThanStringTrueNoDateRangeLessThan.
DateRangeLessThanOrEqualStringTrueNoDateRangeLessThanOrEqual.
DateRangeEqualStringTrueNoDateRangeEqual.
DateRangeGreaterThanStringTrueNoDateRangeGreaterThan.
DateRangeGreaterThanOrEqualStringTrueNoDateRangeGreaterThanOrEqual.
DateRangeDoesNotEndAtStringTrueNoDateRangeDoesNotEndAt.
DateRangeEndsAfterStringTrueNoDateRangeEndsAfter.
DateRangeEndsAtStringTrueNoDateRangeEndsAt.
DateRangeEndsBeforeStringTrueNoDateRangeEndsBefore.
DateRangeEndsEAfterStringTrueNoDateRangeEndsEAfter.
DateRangeEndsEBeforeStringTrueNoDateRangeEndsEBefore.
DateRangeincludesStringTrueNoDateRangeincludes.
DateRangeISNOTNULLStringTrueNoDateRangeISNOTNULL.
DateRangeISNULLStringTrueNoDateRangeISNULL.
DealNotEqualStringTrueNoDealNotEqual.
DealEqualStringTrueNoDealEqual.
DealISNOTNULLStringTrueNoDealISNOTNULL.
DealISNULLStringTrueNoDealISNULL.
DoubleNotEqualStringTrueNoDoubleNotEqual.
DoubleLessThanStringTrueNoDoubleLessThan.
DoubleLessThanOrEqualStringTrueNoDoubleLessThanOrEqual.
DoubleEqualStringTrueNoDoubleEqual.
DoubleGreaterThanStringTrueNoDoubleGreaterThan.
DoubleGreaterThanOrEqualStringTrueNoDoubleGreaterThanOrEqual.
DoubleISNOTNULLStringTrueNoDoubleISNOTNULL.
DoubleISNULLStringTrueNoDoubleISNULL.
EnteredStageNotEqualStringTrueNoEnteredStageNotEqual.
EnteredStageLessThanStringTrueNoEnteredStageLessThan.
EnteredStageLessThanOrEqualStringTrueNoEnteredStageLessThanOrEqual.
EnteredStageEqualStringTrueNoEnteredStageEqual.
EnteredStageGreaterThanStringTrueNoEnteredStageGreaterThan.
EnteredStageGreaterThanOrEqualStringTrueNoEnteredStageGreaterThanOrEqual.
EnumNotEqualStringTrueNoEnumNotEqual.
EnumEqualStringTrueNoEnumEqual.
EnumISNOTNULLStringTrueNoEnumISNOTNULL.
EnumISNULLStringTrueNoEnumISNULL.
IntNotEqualStringTrueNoIntNotEqual.
IntLessThanStringTrueNoIntLessThan.
IntLessThanOrEqualStringTrueNoIntLessThanOrEqual.
IntEqualStringTrueNoIntEqual.
IntGreaterThanStringTrueNoIntGreaterThan.
IntGreaterThanOrEqualStringTrueNoIntGreaterThanOrEqual.
IntISNOTNULLStringTrueNoIntISNOTNULL.
IntISNULLStringTrueNoIntISNULL.
MonetaryNotEqualStringTrueNoMonetaryNotEqual.
MonetaryLessThanStringTrueNoMonetaryLessThan.
MonetaryLessThanOrEqualStringTrueNoMonetaryLessThanOrEqual.
MonetaryEqualStringTrueNoMonetaryEqual.
MonetaryGreaterThanStringTrueNoMonetaryGreaterThan.
MonetaryGreaterThanOrEqualStringTrueNoMonetaryGreaterThanOrEqual.
MonetaryISNOTNULLStringTrueNoMonetaryISNOTNULL.
MonetaryISNULLStringTrueNoMonetaryISNULL.
OrganizationNotEqualStringTrueNoOrganizationNotEqual.
OrganizationEqualStringTrueNoOrganizationEqual.
OrganizationISNOTNULLStringTrueNoOrganizationISNOTNULL.
OrganizationISNULLStringTrueNoOrganizationISNULL.
PersonNotEqualStringTrueNoPersonNotEqual.
PersonEqualStringTrueNoPersonEqual.
PersonISNOTNULLStringTrueNoPersonISNOTNULL.
PersonISNULLStringTrueNoPersonISNULL.
PipelineNotEqualStringTrueNoPipelineNotEqual.
PipelineEqualStringTrueNoPipelineEqual.
ProductNotEqualStringTrueNoProductNotEqual.
ProductEqualStringTrueNoProductEqual.
ProductISNOTNULLStringTrueNoProductISNOTNULL.
ProductISNULLStringTrueNoProductISNULL.
SetNotEqualStringTrueNoSetNotEqual.
SetEqualStringTrueNoSetEqual.
SetContainsStringTrueNoSetContains.
SetISNOTNULLStringTrueNoSetISNOTNULL.
SetISNULLStringTrueNoSetISNULL.
SetNotContainsStringTrueNoSetNotContains.
StageNotEqualStringTrueNoStageNotEqual.
StageEqualStringTrueNoStageEqual.
StageHasBeenStringTrueNoStageHasBeen.
StatusNotEqualStringTrueNoStatusNotEqual.
StatusEqualStringTrueNoStatusEqual.
TimeNotEqualStringTrueNoTimeNotEqual.
TimeLessThanStringTrueNoTimeLessThan.
TimeLessThanOrEqualStringTrueNoTimeLessThanOrEqual.
TimeEqualStringTrueNoTimeEqual.
TimeGreaterThanStringTrueNoTimeGreaterThan.
TimeGreaterThanOrEqualStringTrueNoTimeGreaterThanOrEqual.
TimeISNOTNULLStringTrueNoTimeISNOTNULL.
TimeISNULLStringTrueNoTimeISNULL.
TimerangeNotEqualStringTrueNoTimerangeNotEqual.
TimerangeLessThanStringTrueNoTimerangeLessThan.
TimerangeLessThanOrEqualStringTrueNoTimerangeLessThanOrEqual.
TimerangeEqualStringTrueNoTimerangeEqual.
TimerangeGreaterThanStringTrueNoTimerangeGreaterThan.
TimerangeGreaterThanOrEqualStringTrueNoTimerangeGreaterThanOrEqual.
TimerangedoesNotEndAtStringTrueNoTimerangeDoes_not_end_at.
TimerangeEndsAfterStringTrueNoTimerangeEndsAfter.
TimerangeEndsAtStringTrueNoTimerangeEndsAt.
TimerangeEndsBeforeStringTrueNoTimerangeEndsBefore.
TimerangeEndsEAfterStringTrueNoTimerangeEndsEAfter.
TimerangeEndsEBeforeStringTrueNoTimerangeEndsEBefore.
TimerangeIncludesStringTrueNoTimerangeIncludes.
TimerangeISNOTNULLStringTrueNoTimerangeISNOTNULL.
TimerangeISNULLStringTrueNoTimerangeISNULL.
TitleEqualStringTrueNoTitleEqual.
TitleLIKE'$%'StringTrueNoTitleLIKE'$%'.
TitleLIKE'%$'StringTrueNoTitleLIKE'%$'.
TitleLIKE'%$%'StringTrueNoTitleLIKE'%$%'.
TitleNOTLIKE'$%'StringTrueNoTitleNOTLIKE'$%'.
TitleNOTLIKE'%$'StringTrueNoTitleNOTLIKE'%$'.
TitleNOTLIKE'%$%'StringTrueNoTitleNOTLIKE'%$%'.
UserNotEqualStringTrueNoUserNotEqual.
UserEqualStringTrueNoUserEqual.
UserBelongsToTeamStringTrueNoUser.belongs_to_team.
UserISNOTNULLStringTrueNoUser.IS_NOT_NULL.
UserISNULLStringTrueNoUser.IS_NULL.
VarcharNotEqualStringTrueNoVarcharNotEqual.
VarcharEqualStringTrueNoVarcharEqual.
VarcharISNOTNULLStringTrueNoVarcharISNOTNULL.
VarcharISNULLStringTrueNoVarcharISNULL.
VarcharLIKE'$%'StringTrueNoVarcharLIKE'$%'
VarcharLIKE'%$'StringTrueNoVarcharLIKE'%$'
VarcharLIKE'%$%'StringTrueNoVarcharLIKE'%$%'
VarcharNOTLIKE'$%'StringTrueNoVarcharNOTLIKE'$%'
VarcharNOTLIKE'%$'StringTrueNoVarcharNOTLIKE'%$'
VarcharNOTLIKE'%$%'StringTrueNoVarcharNOTLIKE'%$%'
VisibletoNotEqualStringTrueNoVisibletoNotEqual.
VisibletoEqualStringTrueNoVisibletoEqual.
RottenTimeStringTrueNoRottenTime.
LastMonthStringTrueNoLastMonth.
LastQuarterStringTrueNoLastQuarter.
LastWeekStringTrueNoLastWeek.
NextMonthStringTrueNoNextMonth.
NextWeekStringTrueNoNextWeek.
ThisMonthStringTrueNoThisMonth.
ThisQuarterStringTrueNoThisQuarter.
ThisWeekStringTrueNoThisWeek.
OnemonthsAgoStringTrueNoOnemonthsAgo.
OneweekAgoStringTrueNoOneweekAgo.
TwoMonthsAgoStringTrueNoTwoMonthsAgo.
TwoWeeksAgoStringTrueNoTwoWeeksAgo.
ThreeMonthsAgoStringTrueNoThreeMonthsAgo.
ThreeWeeksAgoStringTrueNoThreeWeeksAgo.
FourMonthsAgoStringTrueNoFourMonthsAgo.
FiveMonthsAgoStringTrueNoFiveMonthsAgo.
SixMonthsAgoStringTrueNoSixMonthsAgo.
BeforeTodayStringTrueNoBeforeToday.
BeforeTomorrowStringTrueNoBeforeTomorrow.
InOneMonthStringTrueNoInOneMonth.
InOneWeekStringTrueNoInOneWeek.
InTwoMonthsStringTrueNoInTwoMonths.
InTwoWeeksStringTrueNoInTwoWeeks.
InThreeMonthsStringTrueNoInThreeMonths.
InThreeWeeksStringTrueNoInThreeWeeks.
InFourMonthsStringTrueNoInFourMonths.
InFiveMonthsStringTrueNoInFiveMonths.
InSixMonthsStringTrueNoInSixMonths.
LaterOrTodayStringTrueNoLaterOrToday.
LaterOrTomorrowStringTrueNoLaterOrTomorrow.
NowStringTrueNoNow.
TodayStringTrueNoToday.
TomorrowStringTrueNoTomorrow.
YesterdayStringTrueNoYesterday.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoThe ID of the filter.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
CustomViewIdStringTrueNoCustomViewId.
NameStringFalseNoThe name of the filter.
TemporaryFlagStringTrueNoTemporaryFlag.
TypeStringFalseNoThe types of filters to fetch.
UpdateTimeStringTrueNoUpdateTime.
UserIdIntegerTrueNoUserId.
VisibleToIntegerTrueNoVisibleTo.
ConditionsStringFalseYesThe conditions of the filter as a JSON object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the user.
ActivatedBooleanTrueNoActivated.
ActiveFlagBooleanTrueNoWhether the user is active or not.
CreatedDatetimeTrueNoCreated.
DefaultCurrencyStringTrueNoDefaultCurrency.
EmailStringTrueNoEmail of the user.
HascreatedcompanyBooleanTrueNoHascreatedcompany.
IconUrlStringTrueNoIconUrl.
IsAdminIntegerTrueNoIsAdmin.
IsYouBooleanTrueNoIsYou.
LangIntegerTrueNoLang.
LastLoginDatetimeTrueNoLastLogin.
LocaleStringTrueNoLocale.
ModifiedDatetimeTrueNoModified.
NameStringTrueNoName of the user.
PhoneStringTrueNoPhone.
RoleIdIntegerTrueNoID of the role.
TimezoneNameStringTrueNoTimezoneName.
TimezoneOffsetStringTrueNoTimezoneOffset.
AccessStringTrueNoThe access given to the user.
TermStringTrueNoThe search term to look for.
SearchByEmailIntegerTrueNoWhen enabled, the term will only be matched against email addresses of users.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId.
AssigneeIdIntegerFalseNoID of the user who's goal to fetch.
AssigneeTypeStringFalseNoType of the goal's assignee. If provided, everyone's goals will be returned.
DurationEndDateFalseNoEnd date of the period for which to find goals.
DurationStartDateFalseNoStart date of the period for which to find goals.
TargetIntegerFalseNoNumeric value of the outcome. If provided, everyone's goals will be returned.
CurrencyIdStringFalseNoNumeric value of the outcome. If provided, everyone's goals will be returned.
TrackingMetricStringFalseNoTracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
IntervalStringFalseNoInterval of the goal.
IsActiveBooleanFalseNoWhether goal is active or not.
OwnerIdIntegerTrueNoOwnerId.
ReportIdsStringTrueNoReportIds.
TitleStringFalseNoTitle of the goal.
TypeNameStringFalseNoType of the goal. If provided, everyone's goals will be returned.
PipelineIdStringFalseNoID of the pipeline.
ActivityTypeIdStringFalseNoID of the activity_type.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe ID of the Lead Label.
AddTimeDatetimeTrueNoAddTime.
ColorStringFalseNoThe color of the label.
NameStringFalseNoThe name of the Lead Label.
UpdateTimeDatetimeTrueNoUpdateTime.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe ID of the Lead.
AddtimeDatetimeTrueNoAddtime.
CcEmailStringTrueNoCcemail.
CreatorIdIntegerTrueNoCreatorid.
ExpectedCloseDateStringFalseNoThe date of when the Deal which will be created from the Lead is expected to be closed.
IsarchivedBooleanTrueNoA flag indicating whether the Lead is archived or not.
LabelidsStringFalseNoThe IDs of the Lead Labels which will be associated with the Lead.
NextactivityIdIntegerTrueNoNextactivityid.
OrganizationIdStringFalseNoThe ID of an Organization which this Lead will be linked to.
OwnerIdIntegerFalseNoThe ID of the User which will be the owner of the created Lead.
PersonIdIntegerFalseNoThe ID of a Person which this Lead will be linked to.
SourcenameStringFalseNoSourcename.
TitleStringFalseNoThe name of the Lead.
UpdatetimeDatetimeTrueNoUpdateTime.
AmountIntegerFalseNoThe potential value of the Lead.
CurrencyStringTrueNoThe currency value of the Lead.
VisibletoStringFalseNoVisibility of the Lead.
WasseenBooleanFalseNoA flag indicating whether the Lead was seen by someone in the Pipedrive UI.
SearchByEmailIntegerFalseYesFiltering based on archived status of a Lead. If not provided, All is used.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the Mail Threads.
PartiesToStringTrueNoTo.
PartiesFromStringTrueNoFrom.
DraftPartiesStringTrueNoDraft Parties.
FoldersStringTrueNoFolders.
AccountIdStringTrueNoAccount Id.
UserIdIntegerTrueNoUser Id.
VersionIntegerTrueNoVersion.
SubjectStringTrueNoSubject.
SnippetStringTrueNoSnippet.
SnippetDraftStringTrueNoSnippetDraft.
SnippetSentStringTrueNoSnippetSent.
HasAttachmentsFlagIntegerTrueNoHasAttachmentsFlag.
HasInlineAttachmentsFlagIntegerTrueNoHasInlineAttachmentsFlag.
HasRealAttachmentsFlagIntegerTrueNoHasRealAttachmentsFlag.
HasDraftFlagIntegerTrueNoHasDraftFlag.
HasSentFlagIntegerTrueNoHasSentFlag.
ArchivedFlagIntegerTrueNoArchivedFlag.
DeletedFlagIntegerTrueNoDeletedFlag.
SyncedFlagIntegerTrueNoSyncedFlag.
ExternalDeletedFlagIntegerTrueNoExternalDeletedFlag.
SmartBccFlagIntegerTrueNoSmartBccFlag.
FirstMessageToMeFlagIntegerTrueNoFirstMessageToMeFlag.
MailLinkTrackingEnabledFlagIntegerTrueNoMailLinkTrackingEnabledFlag.
LastMessageTimestampStringTrueNoLastMessageTimestamp.
FirstMessageTimestampStringTrueNoFirstMessageTimestamp.
LastMessageSentTimestampStringTrueNoLastMessageSentTimestamp.
LastMessageReceivedTimestampStringTrueNoLastMessageReceivedTimestamp.
AddTimeStringTrueNoAddTime.
UpdateTimeStringTrueNoUpdateTime.
DealIdIntegerTrueNoDealId.
DealStatusIntegerTrueNoDealStatus.
AllMessagesSentFlagIntegerTrueNoAllMessagesSentFlag.
FolderStringFalseYesThe type of folder to fetch.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the Mail Thread Messages.
MailThreadIdIntegerTrueNoID of the Mail Thread.
ToStringTrueNoTo.
FromStringTrueNoFrom.
CcStringTrueNoCc.
BccStringTrueNoBcc.
BodyUrlStringTrueNoBody url.
AccountIdStringTrueNoAccount Id.
UserIdIntegerTrueNoUser Id.
SubjectStringTrueNoSubject.
SnippetStringTrueNoSnippet.
MailTrackingStatusStringTrueNoMail Tracking status.
MailLinkTrackingEnabledFlagIntegerTrueNoMailLinkTrackingEnabledFlag.
ReadFlagIntegerTrueNoReadflag.
DraftStringTrueNoDraft.
DraftFlagIntegerTrueNoDraft flag.
SyncedFlagIntegerTrueNoSynced flag.
DeletedFlagIntegerTrueNoDeleted flag.
HasBodyFlagIntegerTrueNoHas body flag.
SentFlagIntegerTrueNoSent flag.
SentFromPipeDriveFlagIntegerTrueNoSentFromPipeDriveFlag.
SmartBccFlagIntegerTrueNoSmartBccFlag.
MessageTimeStringTrueNoMessageTime.
AddTimeStringTrueNoAddTime.
UpdateTimeStringTrueNoUpdateTime.
HasAttachmentsFlagIntegerTrueNoHasAttachmentsFlag.
HasInlineAttachmentsFlagIntegerTrueNoHasInlineAttachmentsFlag.
HasRealAttachmentsFlagIntegerTrueNoHasRealAttachmentsFlag.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the Mail Thread Messages.
MailThreadIdIntegerTrueNoID of the Mail Thread.
EmailAddressStringTrueNoEmail address.
NameStringTrueNoName.
LinkedPersonIdIntegerTrueNoLinked Person Id.
LinkedPersonNameStringTrueNoLinked Person Name.
MailMessagePartyIdIntegerTrueNoMail message Party Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the Mail Thread Messages.
MailThreadIdIntegerTrueNoID of the Mail Thread.
EmailAddressStringTrueNoEmail address.
NameStringTrueNoName.
LinkedPersonIdIntegerTrueNoLinked Person Id.
LinkedPersonNameStringTrueNoLinked Person Name.
MailMessagePartyIdIntegerTrueNoMail message Party Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the Mail Threads.
PartiesToStringTrueNoTo.
PartiesFromStringTrueNoFrom.
DraftPartiesStringTrueNoDraft Parties.
FoldersStringTrueNoFolders.
AccountIdStringTrueNoAccount Id.
UserIdIntegerTrueNoUser Id.
VersionIntegerTrueNoVersion.
SubjectStringTrueNoSubject.
SnippetStringTrueNoSnippet.
SnippetDraftStringTrueNoSnippetDraft.
SnippetSentStringTrueNoSnippetSent.
HasAttachmentsFlagIntegerTrueNoHasAttachmentsFlag.
HasInlineAttachmentsFlagIntegerTrueNoHasInlineAttachmentsFlag.
HasRealAttachmentsFlagIntegerTrueNoHasRealAttachmentsFlag.
HasDraftFlagIntegerTrueNoHasDraftFlag.
HasSentFlagIntegerTrueNoHasSentFlag.
ArchivedFlagIntegerTrueNoArchivedFlag.
DeletedFlagIntegerTrueNoDeletedFlag.
SyncedFlagIntegerTrueNoSyncedFlag.
ExternalDeletedFlagIntegerTrueNoExternalDeletedFlag.
SmartBccFlagIntegerTrueNoSmartBccFlag.
FirstMessageToMeFlagIntegerTrueNoFirstMessageToMeFlag.
MailLinkTrackingEnabledFlagIntegerTrueNoMailLinkTrackingEnabledFlag.
LastMessageTimestampStringTrueNoLastMessageTimestamp.
FirstMessageTimestampStringTrueNoFirstMessageTimestamp.
LastMessageSentTimestampStringTrueNoLastMessageSentTimestamp.
LastMessageReceivedTimestampStringTrueNoLastMessageReceivedTimestamp.
AddTimeStringTrueNoAddTime.
UpdateTimeStringTrueNoUpdateTime.
DealIdIntegerTrueNoDealId.
DealStatusIntegerTrueNoDealStatus.
AllMessagesSentFlagIntegerTrueNoAllMessagesSentFlag.
FolderStringFalseYesThe type of folder to fetch.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID.
NameStringTrueNoName.
LatestSentBooleanTrueNoLatestSent.
EmailAddressStringTrueNoEmailAddress.
MessageTimeStringTrueNoMessageTime.
LinkedPersonIdIntegerTrueNoLinkedPersonId.
LinkedPersonNameStringTrueNoLinkedPersonName.
LinkedOrganizationIdStringTrueNoLinkedOrganizationId.
MailMessagePartyIdIntegerTrueNoMailMessagePartyId.
FolderStringFalseYesThe type of folder to fetch.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID.
NameStringTrueNoName.
LatestSentBooleanTrueNoLatestSent.
EmailAddressStringTrueNoEmailAddress.
MessageTimeStringTrueNoMessageTime.
LinkedPersonIdIntegerTrueNoLinkedPersonId.
LinkedPersonNameStringTrueNoLinkedPersonName.
LinkedOrganizationIdStringTrueNoLinkedOrganizationId.
MailMessagePartyIdIntegerTrueNoMailMessagePartyId.
FolderStringFalseYesThe type of folder to fetch.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
NoteId [KEY]IntegerTrueNoID of the note.
UUIDStringFalseNoComment Id.
ActiveFlagBooleanFalseNoActive flag.
AddTimeStringFalseNoAdd time of the note comment.
CompanyIdIntegerTrueNoCompany Id.
ContentStringFalseNoContent of the comment.
ObjectIdStringTrueNoObject Id.
ObjectTypeStringFalseNoObject type.
UpdateTimeStringFalseNoUpdate time of the comment.
UpdaterIdIntegerTrueNoUpdater Id.
UserIdIntegerTrueNoUser Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActiveFlag.
BulkEditAllowedBooleanTrueNoBulkEditAllowed.
EditFlagBooleanTrueNoEditFlag.
FieldTypeStringTrueNoFieldType.
KeyStringTrueNoKey.
MandatoryFlagBooleanTrueNoMandatoryFlag.
NameStringTrueNoName.
OptionsStringTrueNoOptions.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
LabelStringTrueNoLabel.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the note.
ActiveFlagBooleanFalseNoActiveFlag.
AddTimeDatetimeFalseNoAddTime.
ContentStringFalseNoContent.
DealTitleStringTrueNoDealTitle.
DealIdIntegerFalseNoThe ID of the deal which notes to fetch.
LastUpdateUserIdIntegerTrueNoLastUpdateUserId.
LeadIdStringFalseNoThe ID of the lead which notes to fetch.
OrgIdIntegerFalseNoThe ID of the organization which notes to fetch.
OrganizationNameStringTrueNoOrganizationName.
PersonNameStringTrueNoPersonName.
PersonIdIntegerFalseNoThe ID of the person whose notes to fetch.
PinnedToDealFlagBooleanFalseNoIf set, then results are filtered by note to deal pinning state.
PinnedToLeadFlagBooleanFalseNoIf set, then results are filtered by note to lead pinning state.
PinnedToOrganizationFlagBooleanFalseNoIf set, then results are filtered by note to organization pinning state.
PinnedToPersonFlagBooleanFalseNoIf set, then results are filtered by note to person pinning state.
UpdateTimeDatetimeTrueNoUpdateTime.
UserEmailStringTrueNoUserEmail.
UserIconUrlStringTrueNoUserIconUUserNamerl.
UserIsYouBooleanTrueNoUserIsYouUserName.
UserNameStringTrueNoUserName.
UserIdIntegerTrueNoThe ID of the user whose notes to fetch.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the field.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
AddVisibleFlagBooleanFalseNoWhether the field is available in 'add new' modal or not.
BulkEditAllowedBooleanTrueNoBulkEditAllowed.
DetailsVisibleFlagBooleanTrueNoDetailsVisibleFlag.
EditFlagBooleanTrueNoEditFlag.
FieldTypeStringFalseNoType of the field.
FilteringAllowedBooleanTrueNoFilteringAllowed.
ImportantFlagBooleanTrueNoImportantFlag.
IndexVisibleFlagBooleanTrueNoIndexVisibleFlag.
KeyStringTrueNoKey.
LastUpdatedByUserIdStringTrueNoLastUpdatedByUserId.
MandatoryFlagBooleanTrueNoMandatoryFlag.
NameStringFalseNoName of the field.
OptionsStringFalseNoOptions.
OrderNrIntegerTrueNoOrderNr.
SearchableFlagBooleanTrueNoSearchableFlag.
SortableFlagBooleanTrueNoSortableFlag.
UpdateTimeDatetimeTrueNoUpdateTime.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the field.
LabelStringTrueNoLabel.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the organization relationship.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
CalculatedRelatedOrgIdIntegerFalseNoCalculatedRelatedOrgId.
CalculatedTypeStringFalseNoCalculatedType.
RelLinkedOrgIdActiveFlagBooleanFalseNoRelLinkedOrgIdActiveFlag.
RelLinkedOrgIdAddressStringFalseNoRelLinkedOrgIdAddress.
RelLinkedOrgIdCcEmailStringFalseNoRelLinkedOrgIdCcEmail.
RelLinkedOrgIdnameStringFalseNoRelLinkedOrgIdname.
RelLinkedOrgIdownerIdIntegerFalseNoRelLinkedOrgIdownerId.
RelLinkedOrgIdPeopleCountIntegerFalseNoRelLinkedOrgIdPeopleCount.
RelLinkedOrgIdvalueIntegerFalseNoRelLinkedOrgIdvalue.
RelOwnerOrgIdActiveFlagBooleanFalseNoRelOwnerOrgIdActiveFlag.
RelOwnerOrgIdAddressStringFalseNoRelOwnerOrgIdAddress.
RelOwnerOrgIdCcEmailStringFalseNoRelOwnerOrgIdCcEmail.
RelOwnerOrgIdNameStringFalseNoRelOwnerOrgIdName.
RelOwnerOrgIdOwnerIdIntegerFalseNoRelOwnerOrgIdOwnerId.
RelOwnerOrgIdPeopleCountIntegerFalseNoRelOwnerOrgIdPeopleCount.
OrgIdIntegerFalseNoRelOwnerOrgIdValue.
RelatedOrganizationNameStringFalseNoRelatedOrganizationName.
TypeStringFalseNoThe type of organization relationship.
UpdateTimeDatetimeFalseNoUpdateTime.
RelOwnerOrgIdIntegerFalseYesReal Organization Id.
RelLinkedOrgIdIntegerFalseYesReal Organization Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId
ActiveFlagBooleanTrueNoActiveFlag
ActivitiesCountIntegerTrueNoActivitiesCount
AddTimeDatetimeFalseNoOptional creation date time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM
AddressStringTrueNoAddress
AdminArealevel1StringTrueNoAdminArealevel1
AdminArealevel2StringTrueNoAdminArealevel2
CountryStringTrueNoCountry
FormattedAddressStringTrueNoFormattedAddress
LocalityStringTrueNoLocality
PostalCodeStringTrueNoPostalCode
RouteStringTrueNoRoute
StreetNumberStringTrueNoStreetNumber
SublocalityStringTrueNoSublocality
SubpremiseStringTrueNoSubpremise
CcEmailStringTrueNoCcEmail
CustomeFieldStringTrueNoCustomeField you will get the result of this column only when criteria filter title is used
ClosedDealsCountIntegerTrueNoClosedDealsCount
CompanyIdIntegerTrueNoCompanyId
CountryCodeStringTrueNoCountryCode
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount
EmailMessagesCountIntegerTrueNoEmailMessagesCount
FilesCountIntegerTrueNoFilesCount
FirstCharStringTrueNoFirstChar
FollowersCountIntegerTrueNoFollowersCount
LabelIntegerTrueNoLabel
LastActivityDateDateTrueNoLastActivityDate
LastActivityIdIntegerTrueNoLastActivityId
LostDealsCountIntegerTrueNoLostDealsCount
NameStringFalseNoName
NextActivityDateDateTrueNoNextActivityDate
NextActivityIdIntegerTrueNoNextActivityId
NextActivityTimeTimeTrueNoNextActivityTime
NotesCountIntegerTrueNoNotesCount
OpenDealsCountIntegerTrueNoOpenDealsCount
Owneractive_flagBooleanTrueNoOwneractive_flag
OwnerEmailStringTrueNoOwnerEmail
OwnerHasPicIntegerTrueNoOwnerHasPic
OwnerIdIntegerFalseNoOwnerId
OwnerNameStringTrueNoOwnerName
OwnerPicHashStringTrueNoOwnerPicHash
OwnerIdValueIntegerTrueNoOwnerIdValue
OwnerNameStringTrueNoOwnerName
PeopleCountIntegerTrueNoPeopleCount
PictureActiveFlagBooleanTrueNoPictureActiveFlag
PictureAddTimeDatetimeTrueNoPictureAddTime
PictureAddedByUserIdIntegerTrueNoPictureAddedByUserId
PictureItemIdIntegerTrueNoPictureItemId
PictureItemTypeStringTrueNoPictureItemType
Picture128StringTrueNoPicture128
Picture512StringTrueNoPicture512
PictureUpdateTimeStringTrueNoPictureUpdateTime
PictureIidIntegerTrueNoPictureIid
RelatedClosedDealsCountIntegerTrueNoRelatedClosedDealsCount
RelatedLostDealsCountIntegerTrueNoRelatedLostDealsCount
RelatedOpenDealsCountIntegerTrueNoRelatedOpenDealsCount
RelatedWonDealsCountIntegerTrueNoRelatedWonDealsCount
TypeStringTrueNoType you will get the result of this column only when criteria filter title is used
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount
UpdateTimeDatetimeTrueNoUpdateTime
VisibleToIntegerFalseNoVisibility of the organization
WonDealsCountIntegerTrueNoWonDealsCount
UserIdIntegerFalseYesUser Id
FilterIdIntegerFalseYesFilter Id

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
AssignedTouserIdIntegerTrueNoAssignedTouserId.
AttendeesStringTrueNoAttendees.
BusyFlagBooleanTrueNoBusyFlag.
IncludeContextStringTrueNoIncludeContext.
CompanyIdIntegerTrueNoCompanyId.
MeetingClientStringTrueNoMeetingClient.
MeetingIdStringTrueNoMeetingId.
MeetingUrlStringTrueNoMeetingUrl.
CreatedByUserIdIntegerTrueNoCreatedByUserId.
DealDropboxBccStringTrueNoDealDropboxBcc.
DealIdIntegerTrueNoDealId.
DealTitleStringTrueNoDealTitle.
DoneBooleanTrueNoDone.
DueDateDateTrueNoDueDate.
DueTimeTimeTrueNoDueTime.
DurationTimeTrueNoDuration.
FileCleanNameStringTrueNoFileCleanName.
FileIdStringTrueNoFileId.
FileUrlStringTrueNoFileUrl.
GcaleventIdStringTrueNoGcaleventId.
GoogleCalendarEtagStringTrueNoGoogleCalendarEtag.
GoogleCalendarIdStringTrueNoGoogleCalendarId.
LastNotificationTimeDatetimeTrueNoLastNotificationTime.
LastNotificationUserIdIntegerTrueNoLastNotificationUserId.
LeadIdStringTrueNoLeadId.
LocationStringTrueNoLocation.
AdminAreaLevel1StringTrueNoAdminAreaLevel1.
AdminAreaLevel2StringTrueNoAdminAreaLevel2.
CountryStringTrueNoCountry.
FormattedAddressStringTrueNoFormattedAddress.
LatDoubleTrueNoLat.
LocalityStringTrueNoLocality.
LongDoubleTrueNoLong.
PostalCodeStringTrueNoPostalCode.
RouteStringTrueNoRoute.
StreetNumberStringTrueNoStreetNumber.
SublocalityStringTrueNoSublocality.
SubpremiseStringTrueNoSubpremise.
MarkedAsDoneTimeDatetimeTrueNoMarkedAsDoneTime.
NoteStringTrueNoNote.
NotificationLanguageIdIntegerTrueNoNotificationLanguageId.
OrgIdIntegerTrueNoOrgId.
OrgNameStringTrueNoOrgName.
OwnerNameStringTrueNoOwnerName.
ParticipantsStringTrueNoParticipants.
PersonDropboxBccStringTrueNoPersonDropboxBcc.
PersonIdIntegerTrueNoPersonId.
PersonNameStringTrueNoPersonName.
PublicDescriptionStringTrueNoPublicDescription.
MasterActivityIdStringTrueNoMasterActivityId.
RuleStringTrueNoRule.
RuleExtensionStringTrueNoRuleExtension.
ReferenceIdIntegerTrueNoReferenceId.
ReferenceTypeStringTrueNoReferenceType.
SeriesStringTrueNoSeries.
SourceTimezoneStringTrueNoSourceTimezone.
SubjectStringTrueNoSubject.
TypeStringTrueNoType.
UpdateTimeDatetimeTrueNoUpdateTime.
UpdateUserIdIntegerTrueNoUpdateUserId.
UserIdIntegerTrueNoUserId.
ExcludeStringFalseYesA comma-separated string of activity IDs to exclude from result.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrgIdIntegerTrueNoOrgId.
EmailAddressStringTrueNoEmail Address.
IsOrganizerIntegerTrueNoIsOrganizer.
NameStringTrueNoName.
PersonIdIntegerTrueNoPersonId.
StatusStringTrueNoStatus.
UserIdStringTrueNoUserId.
ExcludeStringFalseYesA comma-separated string of activity IDs to exclude from result.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrgIdIntegerTrueNoOrgId.
PersonIdIntegerTrueNoPersonId.
PrimaryFlagBooleanTrueNoPrimary Flag.
ExcludeStringFalseYesA comma-separated string of activity IDs to exclude from result.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveBooleanTrueNoActive.
ActivitiesCountIntegerTrueNoActivitiesCount.
AddTimeDatetimeTrueNoAddTime.
CcEmailStringTrueNoCcEmail.
CloseTimeStringTrueNoCloseTime.
CreatoractiveFlagBooleanTrueNoCreatoractiveFlag.
CreatoremailStringTrueNoCreatoremail.
CreatorhasPicBooleanTrueNoCreatorhasPic.
CreatoridIntegerTrueNoCreatorid.
CreatornameStringTrueNoCreatorname.
CreatorPicHashStringTrueNoCreatorPicHash.
CreatorvalueIntegerTrueNoCreatorvalue.
CurrencyStringTrueNoCurrency.
DeletedBooleanTrueNoDeleted.
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount.
EmailMessagesCountIntegerTrueNoEmailMessagesCount.
ExpectedCloseDateDateTrueNoExpectedCloseDate.
FilesCountIntegerTrueNoFilesCount.
FirstWonTimeDatetimeTrueNoFirstWonTime.
FollowersCountIntegerTrueNoFollowersCount.
FormattedValueStringTrueNoFormattedValue.
FormattedWeightedValueStringTrueNoFormattedWeightedValue.
LabelStringTrueNoLabel.
LastActivityDateStringTrueNoLastActivityDate.
LastActivityIdStringTrueNoLastActivityId.
LastIncomingMailTimeDatetimeTrueNoLastIncomingMailTime.
LastOutgoingMailTimeDatetimeTrueNoLastOutgoingMailTime.
LostReasonStringTrueNoLostReason.
LostTimeStringTrueNoLostTime.
NextActivityDateDateTrueNoNextActivityDate.
NextActivityDurationTimeTrueNoNextActivityDuration.
NextActivityIdIntegerTrueNoNextActivityId.
NextActivitynoteStringTrueNoNextActivitynote.
NextActivitysubjectStringTrueNoNextActivitysubject.
NextActivitytimeTimeTrueNoNextActivitytime.
NextActivitytypeStringTrueNoNextActivitytype.
NotesCountIntegerTrueNoNotesCount.
OrgHiddenBooleanTrueNoOrgHidden.
OrgActive_flagBooleanTrueNoOrgActive_flag.
OrgAddressStringTrueNoOrgAddress.
OrgCcEmailStringTrueNoOrgCcEmail.
OrgIdNameStringTrueNoOrgName.
OrgOwnerIdIntegerTrueNoOrgOwnerId.
OrgPeopleCountIntegerTrueNoOrgPeopleCount.
OrgIdIntegerTrueNoOrgValue.
OwnerNameStringTrueNoOwnerName.
ParticipantsCountIntegerTrueNoParticipantsCount.
PersonHiddenBooleanTrueNoPersonHidden.
PersonActiveFlagBooleanTrueNoPersonActiveFlag.
PersonEmailStringTrueNoPersonEmail.
PersonNameStringTrueNoPersonName.
PersonPhoneStringTrueNoPersonPhone.
PersonValueIntegerTrueNoPersonValue.
PipelineIdIntegerTrueNoPipelineId.
ProbabilityStringTrueNoProbability.
ProductsCountIntegerTrueNoProductsCount.
RottenTimeStringTrueNoRottenTime.
StageChangeTimeDatetimeTrueNoStageChangeTime.
StageIdIntegerTrueNoStageId.
StageOrderNrIntegerTrueNoStageOrderNr.
StatusStringTrueNoOnly fetch deals with specific status..
TitleStringTrueNoTitle.
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount.
UpdateTimeDatetimeTrueNoUpdateTime.
UserActiveFlagBooleanTrueNoUserActiveFlag.
UserEmailStringTrueNoUserEmail.
UserHasPicBooleanTrueNoUserHasPic.
UserIdIntegerTrueNoUserId.
UserNameStringTrueNoUserName.
UserPicHashStringTrueNoUserPicHash.
UserValueIntegerTrueNoUserValue.
ValueIntegerTrueNoValue.
VisibleToStringTrueNoVisibleTo.
WeightedValueIntegerTrueNoWeightedValue.
WeightedValueCurrencyStringTrueNoWeightedValueCurrency.
WonTimeDatetimeTrueNoWonTime.
OrgNameStringTrueNoOrg Name.
OnlyPrimaryAssociationIntegerFalseYesIf set, only deals that are directly associated to the organization are fetched.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrgId [KEY]IntegerTrueOrganizations.IdNoOrg Id.
LabelStringTrueNoLabel.
PrimaryBooleanTrueNoPrimary.
ValueStringTrueNoValue.
StatusStringFalseYesOnly fetch deals with specific status.
OnlyPrimaryAssociationIntegerFalseYesIf set, only deals that are directly associated to the organization are fetched.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrgId [KEY]IntegerTrueOrganizations.IdNoOrg Id.
LabelStringTrueNoLabel.
PrimaryBooleanTrueNoPrimary.
ValueStringTrueNoValue.
StatusStringFalseYesOnly fetch deals with specific status.
OnlyPrimaryAssociationIntegerFalseYesIf set, only deals that are directly associated to the organization are fetched

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the organizations.
ActiveFlagBooleanTrueNoActive Flag.
ActivityIdStringTrueNoActivity Id.
AddTimeDatetimeTrueNoAddTime.
CidStringTrueNoCid.
DealIdStringTrueNoDeal Id.
DealNameStringTrueNoDealName.
DescriptionStringTrueNoDescription.
FileNameStringTrueNoFile Name.
FileSizeIntegerTrueNoFile Size.
FileTypeStringTrueNoFile Type.
InlineFlagBooleanTrueNoInline Flag.
LogIdStringTrueNoLog Id.
MailMessageIdStringTrueNoMailMessage Id.
MailTemplateIdStringTrueNoMailTemplate Id.
NameStringTrueNoName.
OrgIdIntegerTrueNoOrg Id.
OrgNameStringTrueNoOrg Name.
PeopleNameStringTrueNoPeople Name.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPerson Name.
ProductIdStringTrueNoProduc tId.
ProductNameStringTrueNoProduct Name.
RemoteIdStringTrueNoRemote Id.
RemoteLocationStringTrueNoRemote Location.
S3BucketStringTrueNoS3Bucket.
UpdateTimeDatetimeTrueNoUpdate Time.
UrlStringTrueNoUrl.
UserIdIntegerTrueNoUserId.
LeadIdStringTrueNoLeadId.
LeadNameStringTrueNoLeadName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
AddTimeDatetimeTrueNoAddTime.
OrgIdIntegerTrueNoOrgId.
UserIdIntegerFalseNoUserId.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActiveFlag.
ActivitiesCountIntegerTrueNoActivitiesCount.
AddTimeDatetimeFalseNoOptional creation date time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM
AddressStringTrueNoAddress.
AdminArealevel1StringTrueNoAdminArealevel1.
AdminArealevel2StringTrueNoAdminArealevel2.
CountryStringTrueNoCountry.
FormattedAddressStringTrueNoFormattedAddress.
LocalityStringTrueNoLocality.
PostalCodeStringTrueNoPostalCode.
RouteStringTrueNoRoute.
StreetNumberStringTrueNoStreetNumber.
SublocalityStringTrueNoSublocality.
SubpremiseStringTrueNoSubpremise.
CcEmailStringTrueNoCcEmail.
CustomeFieldStringTrueNoCustomeField you will get the result of this column only when criteria filter title is used.
ClosedDealsCountIntegerTrueNoClosedDealsCount.
CompanyIdIntegerTrueNoCompanyId.
CountryCodeStringTrueNoCountryCode.
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount.
EmailMessagesCountIntegerTrueNoEmailMessagesCount.
FilesCountIntegerTrueNoFilesCount.
FirstCharStringTrueNoFirstChar.
FollowersCountIntegerTrueNoFollowersCount.
LabelIntegerTrueNoLabel.
LastActivityDateDateTrueNoLastActivityDate.
LastActivityIdIntegerTrueNoLastActivityId.
LostDealsCountIntegerTrueNoLostDealsCount.
NameStringFalseNoName.
NextActivityDateDateTrueNoNextActivityDate.
NextActivityIdIntegerTrueNoNextActivityId.
NextActivityTimeTimeTrueNoNextActivityTime.
NotesCountIntegerTrueNoNotesCount.
OpenDealsCountIntegerTrueNoOpenDealsCount.
OwneractiveFlagBooleanTrueNoOwneractive_flag.
OwnerEmailStringTrueNoOwnerEmail.
OwnerHasPicBooleanTrueNoOwnerHasPic.
OwnerIdIntegerFalseNoOwnerId.
OwnerIdNameStringTrueNoOwnerName.
OwnerPicHashStringTrueNoOwnerPicHash.
OwnerIdValueIntegerTrueNoOwnerIdValue.
PeopleCountIntegerTrueNoPeopleCount.
PictureActiveFlagBooleanTrueNoPictureActiveFlag.
PictureAddTimeDatetimeTrueNoPictureAddTime.
PictureAddedByUserIdIntegerTrueNoPictureAddedByUserId.
PictureItemIdIntegerTrueNoPictureItemId.
PictureItemTypeStringTrueNoPictureItemType.
Picture128StringTrueNoPicture128.
Picture512StringTrueNoPicture512.
PictureUpdateTimeStringTrueNoPictureUpdateTime.
PictureIdIntegerTrueNoPictureIid.
RelatedClosedDealsCountIntegerTrueNoRelatedClosedDealsCount.
RelatedLostDealsCountIntegerTrueNoRelatedLostDealsCount.
RelatedOpenDealsCountIntegerTrueNoRelatedOpenDealsCount.
RelatedWonDealsCountIntegerTrueNoRelatedWonDealsCount.
TypeStringTrueNoType you will get the result of this column only when criteria filter title is used.
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount.
UpdateTimeDatetimeTrueNoUpdateTime.
VisibleToIntegerFalseNoVisibility of the organization.
WonDealsCountIntegerTrueNoWonDealsCount.
OwnerNameStringTrueNoOwner Name.
UserIdIntegerFalseYesUser Id.
FilterIdIntegerFalseYesFilter Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoOrg id.
OrgIdIntegerTrueOrganizations.IdNoActivities ID.
AccountIdStringTrueNoAccountId.
AddTimeDatetimeTrueNoaddTime.
BccStringTrueNoBcc.
BodyUrlStringTrueNobodyUrl.
CcStringTrueNocc.
CompanyIdIntegerTrueNocompanyId.
DeletedFlagBooleanTrueNoDeletedFlag.
DraftStringTrueNoDraft.
DraftFlagBooleanTrueNoDraftFlag.
ExternalDeletedFlagBooleanTrueNoExternal DeletedFlag.
FromStringTrueNoFrom.
AttachmentsFlagBooleanTrueNoAttachmentsFlag.
BodyFlagBooleanTrueNoBodyFlag.
InlineAttachmentsFlagBooleanTrueNoInlineAttachmentsFlag.
RealAttachmentsFlagBooleanTrueNoRealAttachmentsFlag.
ItemTypeStringTrueNoItemType.
TrackingEnabledFlagBooleanTrueNoTrackingEnabledFlag.
ThreadIdIntegerTrueNoThreadId.
TrackingStatusStringTrueNoTrackingStatus.
MessageTimeStringTrueNoMessageTime.
MessageIdStringTrueNoMessageId.
NylasIdStringTrueNoNylasId.
ReadFlagBooleanTrueNoReadFlag.
S3BucketStringTrueNoS3Bucket.
S3BucketPathStringTrueNoS3BucketPath.
SentFlagBooleanTrueNoSentFlag.
SentFromPipedriveFlagBooleanTrueNoSentFromPipedriveFlag.
SmartBccFlagBooleanTrueNoSmartBccFlag.
SnippetStringTrueNoSnippet.
SubjectStringTrueNoSubject.
SyncedFlagBooleanTrueNoSyncedFlag.
TemplateIdStringTrueNoTemplateId.
TimestampDatetimeTrueNoTimestamp.
ToStringTrueNoTo.
UpdateTimeDatetimeTrueNoUpdateTime.
UserIdIntegerTrueNoUserId.
WriteFlagBooleanTrueNowriteFlag.
ObjectStringTrueNoObject.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoid.
OrgIdIntegerTrueOrganizations.IdNoOrg Id.
EmailAddressStringTrueNoEmailAddress.
PersonIdIntegerTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
OrgIdIntegerTrueOrganizations.IdNoOrg Id.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
OrgIdIntegerTrueOrganizations.IdNoOrg Id.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
OrgIdIntegerTrueOrganizations.IdNoOrg Id.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrgIdIntegerTrueNoOrganization Id.
UserIdIntegerTrueNoUser Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId
ActivitiesCountIntegerTrueNoActivitiesCount
ActiveFlagBooleanTrueNoActiveFlag
AddTimeDatetimeTrueNoAddTime
CcEmailStringTrueNoCcEmail
ClosedDealsCountIntegerTrueNoClosedDealsCount
CompanyIdIntegerTrueNoCompanyId
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount
EmailStringTrueNoEmail
EmailMessagesCountIntegerTrueNoEmailMessagesCount
FilesCountIntegerTrueNoFilesCount
LabelIntegerTrueNolabel
LastActivityDateDateTrueNoLastActivityDate
LastActivityIdIntegerTrueNoLastActivityId
LastincomingMailTimeStringTrueNoLastincomingMailTime
LastnameStringTrueNoLastname
LastoutgoingMailTimeStringTrueNoLastoutgoingMailTime
LostdealsCountIntegerTrueNoLostdealsCount
NameStringTrueNoName
NextActivityDateDateTrueNonextActivityDate
NextActivityIdIntegerTrueNonextActivityId
NextActivityTimeStringTrueNonextActivityTime
NotesCountIntegerTrueNoNotesCount
OpenDealsCountIntegerTrueNoOpenDealsCount
OrgActiveFlagBooleanTrueNoOrgActiveFlag
OrgAddressStringTrueNoOrgAddress
OrgCcEmailStringTrueNoOrgCcEmail
OrgIdNameStringTrueNoOrgName
OrgownerIdIntegerTrueNoOrgownerId
OrgpeopleCountIntegerTrueNoOrgpeopleCount
OrgIdIntegerTrueNoOrgId
OwnerActiveFlagBooleanTrueNoOwnerActiveFlag
OwnerEmailStringTrueNoOwnerEmail
OwnerHasPicBooleanTrueNoOwnerHasPic
OwnerIdIntegerTrueNoOwnerId
OwnerNameStringTrueNoOwnerName
OwnerPicHashStringTrueNoOwnerPicHash
OwnerValueIntegerTrueNoOwnerValue
ParticipantClosedDealsCountIntegerTrueNoParticipantClosedDealsCount
ParticipantOpenDealsCountIntegerTrueNoParticipantOpenDealsCount
PhoneStringTrueNoPhone
PictureActiveFlagBooleanTrueNoPictureActiveFlag
PictureaddTimeDatetimeTrueNoPictureaddTime
PictureaddedByUserIdIntegerTrueNoPictureaddedByUserId
PictureItemIdIntegerTrueNoPictureItemId
PictureitemTypeStringTrueNoPictureitemType
Picture128StringTrueNoPicture128
Picture512StringTrueNoPicture512
PictureupdateTimeStringTrueNoPictureupdateTime
PicturevalueIntegerTrueNoPicturevalue
PictureIdStringTrueNoPictureId
RelatedclosedDealsCountIntegerTrueNoRelatedclosedDealsCount
RelatedlostDealsCountIntegerTrueNoRelatedlostDealsCount
RelatedopenDealsCountIntegerTrueNoRelatedopenDealsCount
RelatedwonDealsCountIntegerTrueNoRelatedwonDealsCount
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount
UpdateTimeDatetimeTrueNoUpdateTime
VisibleToStringTrueNovisibleTo
WonDealsCountIntegerTrueNoWonDealsCount
FirstNameStringTrueNoFirst name.
FollowersCountIntegerTrueNoFollowes Count.
PrimaryEmailStringTrueNoPrimary Email.
FirstCharStringTrueNoFirst Char.
MarketingStatusStringTrueNoMarketing Status.
OrgNameStringTrueNoOrg name.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrgId [KEY]IntegerTrueNoOrgId
ValueStringTrueNoValue.
PrimaryBooleanTrueNoPrimary.
LabelStringTrueNoLabel.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrgId [KEY]IntegerTrueNoOrgId
ValueStringTrueNoValue.
PrimaryBooleanTrueNoPrimary.
LabelStringTrueNoLabel.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActiveFlag.
ActivityIdStringTrueNoActivityId.
AddTimeDatetimeTrueNoAddTime.
NewValueFormattedStringTrueNoNewValueFormatted.
OldValueFormattedStringTrueNoOldValueFormatted.
AssignedToUserIdIntegerTrueNoAssignedToUserId.
AttendeesStringTrueNoAttendees.
BusyFlagBooleanTrueNoBusyFlag.
IncludeContextStringTrueNoIncludeContext.
ChangeSourceStringTrueNoChangeSource.
User_agentStringTrueNoUser_agent.
CidStringTrueNoCid.
CompanyIdIntegerTrueNoCompanyId.
ConferenceMeetingClientStringTrueNoConferenceMeetingClient.
ConferenceMeetingIdStringTrueNoConferenceMeetingId.
ConferenceMeetingUrlStringTrueNoConferenceMeetingUrl.
CreatedByUserIdIntegerTrueNoCreatedByUserId.
DealDropboxBccStringTrueNoDealDropboxBcc.
DealIdIntegerTrueNoDealId.
DealNameStringTrueNoDealName.
DealTitleStringTrueNoDealTitle.
DescriptionStringTrueNoDescription.
DoneBooleanTrueNoDone.
DueDateDateTrueNoDueDate.
DueTimeTimeTrueNoDueTime.
DurationTimeTrueNoDuration.
FieldKeyStringTrueNoFieldKey.
FileCleanNameStringTrueNoFileCleanName.
FileIdStringTrueNoFileId.
FileUrlStringTrueNoFileUrl.
FileNameStringTrueNoFileName.
FileSizeIntegerTrueNoFileSize.
FileTypeStringTrueNoFileType.
GcalEventIdStringTrueNoGcalEventId.
GoogleCalendarEtagStringTrueNoGoogleCalendarEtag.
GoogleCalendarIdStringTrueNoGoogleCalendarId.
InlineFlagBooleanTrueNoInlineFlag.
IsBulkUpdateFlagStringTrueNoIsBulkUpdateFlag.
ItemIdIntegerTrueNoItemId.
LastNotificationTimeDatetimeTrueNoLastNotificationTime.
LastNotificationUserIdIntegerTrueNoLastNotificationUserId.
LeadIdStringTrueNoLeadId.
LocationStringTrueNoLocation.
AdminAreaLevel1StringTrueNoAdminAreaLevel1.
AdminAreaLevel2StringTrueNoAdminAreaLevel2.
CountryStringTrueNoCountry.
FormattedAddressStringTrueNoFormattedAddress.
LatDoubleTrueNoLat.
LocalityStringTrueNoLocality.
LongDoubleTrueNoLong.
PostalCodeStringTrueNoPostalCode.
RouteStringTrueNoRoute.
StreetNumberStringTrueNoStreetNumber.
SublocalityStringTrueNoSublocality.
SubpremiseStringTrueNoSubpremise.
LogIdStringTrueNoLogId.
LogTimeDatetimeTrueNoLogTime.
MessageIdStringTrueNoMessageId.
TemplateIdStringTrueNoTemplateId.
MarkedAsDoneTimeDatetimeTrueNoMarkedAsDoneTime.
NameStringTrueNoName.
NewValueStringTrueNoNewValue.
NoteStringTrueNoNote.
NotificationLanguageIdIntegerTrueNoNotificationLanguageId.
OldValueIntegerTrueNoOldValue.
OrgIdIntegerTrueNoOrgId.
OrgNameStringTrueNoOrgName.
OwnerNameStringTrueNoOwnerName.
ParticipantsStringTrueNoParticipants.
PeopleNameStringTrueNoPeopleName.
PersonDropboxBccStringTrueNoPersonDropboxBcc.
PersonIdIntegerTrueNoPersonId.
PersonNameStringTrueNoPersonName.
ProductIdStringTrueNoProductId.
ProductNameStringTrueNoProductName.
PublicDescriptionStringTrueNoPublicDescription.
RecActivityIdStringTrueNoRecActivityId.
RecRuleStringTrueNoRecRule.
RecRuleExtensionStringTrueNoRecRuleExtension.
ReferenceIdIntegerTrueNoReferenceId.
ReferenceTypeStringTrueNoReferenceType.
RemoteIdStringTrueNoRemoteId.
RemoteLocationStringTrueNoRemoteLocation.
S3BucketStringTrueNoS3Bucket.
SeriesStringTrueNoSeries.
SourcetimezoneStringTrueNoSourcetimezone.
SubjectStringTrueNoSubject.
TypeStringTrueNoType.
UpdateTimeDatetimeTrueNoUpdateTime.
UpdateUserIdIntegerTrueNoUpdateUserId.
UrlStringTrueNoUrl.
UserIdIntegerTrueNoUserId.
ObjectStringTrueNoObject.
TimestampDatetimeTrueNoTimestamp.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesitem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrgId [KEY]IntegerTrueOrganizations.IdNoActivities ID.
EmailAddressStringFalseNoEmailAddress.
IsOrganizerBooleanTrueNoIsOrganizer.
NameStringTrueNoName.
PersonIdIntegerFalsePersons.IdNoPersonId.
StatusStringTrueNoStatus.
UserIdStringTrueUsers.IdNoUserId.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesitem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrgId [KEY]IntegerTrueOrganizations.IdNoActivities ID.
PersonIdIntegerFalseNoPersonId.
PrimaryFlagBooleanFalseNoPrimaryFlag.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesitem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoID of the permission set.
AssignmentCountIntegerTrueNoAssignmentCount.
NameStringTrueNoName.
TypeStringTrueNoType.
DescriptionStringTrueNoDescription.
AppStringTrueNoApp.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoID of the permission set Assignments.
NameStringTrueNoName.
PermissionSetIdStringTrueNoPermissionSetId.
UserIdIntegerTrueNoUserId.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the field.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
AddVisibleFlagBooleanFalseNoWhether the field is available in 'add new' modal or not (both in web and mobile app).
BulkEditAllowedBooleanTrueNoBulkEditAllowed.
DetailsVisibleFlagBooleanTrueNoDetailsVisibleFlag.
EditFlagBooleanTrueNoEditFlag.
FieldTypeStringFalseNoType of the field.
FilteringAllowedBooleanTrueNoFilteringAllowed.
ImportantFlagBooleanTrueNoImportantFlag.
IndexVisibleFlagBooleanTrueNoIndexVisibleFlag.
KeyStringTrueNoKey.
LastUpdatedByUserIdStringTrueNoLastUpdatedByUserId.
MandatoryFlagBooleanTrueNoMandatoryFlag.
NameStringFalseNoName of the field.
OptionsStringFalseNoOptions.
OrderNrIntegerTrueNoOrderNr.
SearchableFlagBooleanTrueNoSearchableFlag.
SortableFlagBooleanTrueNoSortableFlag.
UpdateTimeDatetimeTrueNoUpdateTime.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the field.
LabelStringTrueNoLabel.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoFollowers id.
AddTimeDatetimeTrueNoAdd time.
PersonIdIntegerTrueNoPerson id.
UserIdIntegerFalseNoUser id.
DealIdIntegerTrueNoDeal id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanFalseNoActiveFlag.
ActivitiesCountIntegerTrueNoActivitiesCount.
AddTimeDatetimeFalseNoOptional creation date time of the person Requires admin user API token. Format: YYYY-MM-DD HH:MM
CcEmailStringTrueNoCcEmail.
ClosedDealsCountIntegerTrueNoClosedDealsCount.
CompanyIdIntegerTrueNoCompanyId.
CustomeFieldStringTrueNoCustomeField you will get the result of this column only when criteria filter title is used.
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount.
EmailStringFalseNoEmail.
EmailMessagesCountIntegerTrueNoEmailMessagesCount.
FilesCountIntegerTrueNoFilesCount.
FirstCharStringTrueNoIf supplied, only persons whose name starts with the specified letter will be returned.
FirstNameStringTrueNoFirstName.
FollowersCountIntegerTrueNoFollowersCount.
LabelIntegerTrueNoLabel.
LastActivityDateDateTrueNoLastActivityDate.
LastActivityIdIntegerTrueNoLastActivityId.
LastIncomingMailTimeDatetimeTrueNoLastIncomingMailTime.
LastNameStringTrueNoLastName.
LastOutgoingMailTimeDatetimeTrueNoLastOutgoingMailTime.
LostDealsCountIntegerTrueNoLostDealsCount.
NameStringFalseNoName.
NextActivityDateDateTrueNoNextActivityDate.
NextActivityIdIntegerTrueNoNextActivityId.
NextActivityTimeTimeTrueNoNextActivityTime.
NotesStringTrueNoNotes.
NotesCountIntegerTrueNoNotesCount.
OpenDealsCountIntegerTrueNoOpenDealsCount.
OrgActiveFlagBooleanTrueNoOrgActiveFlag.
OrgAddressStringTrueNoOrgAddress.
OrgccEmailStringTrueNoOrgccEmail.
OrgNameStringTrueNoOrgName.
OrgownerIdIntegerTrueNoOrgownerId.
OrgpeopleCountIntegerTrueNoOrgpeopleCount.
OrgvalueIntegerFalseNoOrgvalue.
OwnerActiveFlagBooleanTrueNoOwnerActiveFlag.
OwnerEmailStringTrueNoOwnerEmail.
OwnerHasPicIntegerTrueNoOwnerHasPic.
OwnerIdIntegerFalseNoOwnerId.
OwnerIdNameStringTrueNoOwnerName.
OwnerPicHashStringTrueNoOwnerPicHash.
OwnerValueIntegerTrueNoOwnerValue.
ParticipantClosedDealscountIntegerTrueNoParticipantClosedDealscount.
ParticipantOpenDealsCountIntegerTrueNoParticipantOpenDealsCount.
PhoneStringFalseNoPhone.
PictureActiveFlagBooleanTrueNoPictureActiveFlag.
PictureAddTimeDatetimeTrueNoPictureAddTime.
PictureAddedByUserIdIntegerTrueNoPictureAddedByUserId.
PictureItemIdIntegerTrueNoPictureItemId.
PictureItemTypeStringTrueNoPictureItemType.
Picture128StringTrueNoPicture128.
Picture512StringTrueNoPicture512.
PictureUpdateTimeStringTrueNoPictureUpdateTime.
PicturevalueIntegerTrueNoPicturevalue.
RelatedClosedDealsCountIntegerTrueNoRelatedClosedDealsCount.
RelatedLostDealsCountIntegerTrueNoRelatedLostDealsCount.
RelatedOpenDealsCountIntegerTrueNoRelatedOpenDealsCount.
RelatedWonDealsCountIntegerTrueNoRelatedWonDealsCount.
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount.
UpdateTimeDatetimeTrueNoUpdateTime.
VisibleToStringFalseNoVisibility of the person.
WonDealsCountIntegerTrueNoWonDealsCount.
PrimaryEmailStringTrueNoPrimary Email.
MarketingStatusStringTrueNoMarketing Status.
OwnerNameStringTrueNoOwner Name.
FilterIdIntegerFalseYesFilter Id.
UserIdIntegerFalseYesUser Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActive Flag.
AddTtimeDatetimeTrueNoAdd Ttime.
AssignedToUserIdIntegerTrueNoAssigned To UserId.
AttendeesStringTrueNoAttendees.
BusyFlagBooleanTrueNoBusyFlag.
IncludeContextStringTrueNoInclude Context.
CompanyIdIntegerTrueNoCompany Id.
MeetingClientStringTrueNoMeeting Client.
MeetingIdStringTrueNoMeeting Id.
MeetingUrlStringTrueNoMeeting Url.
CreatedByUserIdIntegerTrueNoCreatedBy UserId.
DealDropboxBccStringTrueNoDeal Dropbox Bcc.
DealIdIntegerTrueNoDeal Id.
DealTitleStringTrueNoDeal Title.
DoneBooleanTrueNoWhether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
DueDateDateTrueNoDue Date.
DueTimeTimeTrueNoDue Time.
DurationTimeTrueNoDuration.
FileCleanNameStringTrueNoFileCleanName.
FileIdStringTrueNoFileId.
FileUrlStringTrueNoFileUrl.
EventIdStringTrueNoeventId.
CalendarEtagStringTrueNoCalendarEtag.
CalendarIdStringTrueNoCalendar Id.
NotificationTimeDatetimeTrueNoNotification Time.
NotificationUserIdIntegerTrueNoNotification UserId.
LeadIdStringTrueNoLead Id.
LocationStringTrueNoLocation.
AreaLevel1StringTrueNoAreaLevel1.
AreaLevel2StringTrueNoAreaLevel2.
CountryStringTrueNoCountry.
FormattedAddressStringTrueNoFormattedAddress.
LatDoubleTrueNoLat.
LocalityStringTrueNoLocality.
LongDoubleTrueNoLong.
PostalCodeStringTrueNoPostalCode.
RouteStringTrueNoRoute.
StreetNumberStringTrueNoStreetNumber.
SublocalityStringTrueNoSublocality.
SubpremiseStringTrueNoSubpremise.
MarkedAsDoneTimeDatetimeTrueNoMarkedAsDoneTime.
NoteStringTrueNoNote.
NotificationLanguageIdIntegerTrueNoNotificationLanguageId.
OrgIdIntegerTrueNoOrgId.
OrgNameStringTrueNoOrgName.
OwnerNameStringTrueNoOwnerName.
ParticipantsStringTrueNoParticipants.
PersonDropboxBccStringTrueNoPerson Dropbox Bcc.
PersonIdIntegerTruePersons.IdNoPersonId.
PersonNameStringTrueNoPersonName.
PublicDescriptionStringTrueNoPublicDescription.
MasterActivityIdStringTrueNoMasterActivityId.
RuleStringTrueNoRule.
RuleExtensionStringTrueNoRuleExtension.
ReferenceIdIntegerTrueNoReferenceId.
ReferenceTypeStringTrueNoReferenceType.
SeriesStringTrueNoSeries.
SourceTimezoneStringTrueNoSourceTimezone.
SubjectStringTrueNoSubject.
TypeStringTrueNoType.
UpdateTimeDatetimeTrueNoUpdateTime..
UpdateUserIdIntegerTrueNoUpdateUserId..
UserIdIntegerTrueNoUserId..
ExcludeStringFalseYesA comma-separated string of activity IDs to exclude from result..

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonId [KEY]IntegerFalsePersons.IdNoPersonId.
EmailAddressStringFalseNoEmailAddress.
IsOrganizerIntegerTrueNoIsOrganizer.
NameStringTrueNoName.
StatusStringTrueNoStatus.
UserIdStringTrueUsers.IdNoUserId.
DoneBooleanFalseYesWhether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
ExcludeStringFalseYesA comma-separated string of activity IDs to exclude from result.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonId [KEY]IntegerFalseNoPersonId.
PrimaryFlagBooleanFalseNoPrimaryFlag.
DoneBooleanFalseYesWhether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
ExcludeStringFalseYesA comma-separated string of activity IDs to exclude from result.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveBooleanTrueNoActive.
ActivitiesCountIntegerTrueNoActivitiesCount.
AddTimeDatetimeTrueNoAddTime.
CcEmailStringTrueNoCcEmail.
CloseTimeStringTrueNoCloseTime.
CreatoractiveFlagBooleanTrueNoCreatoractiveFlag.
CreatoremailStringTrueNoCreatoremail.
CreatorhasPicBooleanTrueNoCreatorhasPic.
CreatoridIntegerTrueNoCreatorid.
CreatornameStringTrueNoCreatorname.
CreatorPicHashStringTrueNoCreatorPicHash.
CreatorvalueIntegerTrueNoCreatorvalue.
CurrencyStringTrueNoCurrency.
DeletedBooleanTrueNoDeleted.
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount.
EmailMessagesCountIntegerTrueNoEmailMessagesCount.
ExpectedCloseDateDateTrueNoExpectedCloseDate.
FilesCountIntegerTrueNoFilesCount.
FirstWonTimeDatetimeTrueNoFirstWonTime.
FollowersCountIntegerTrueNoFollowersCount.
FormattedValueStringTrueNoFormattedValue.
FormattedWeightedValueStringTrueNoFormattedWeightedValue.
LabelStringTrueNoLabel.
LastActivityDateStringTrueNoLastActivityDate.
LastActivityIdStringTrueNoLastActivityId.
LastIncomingMailTimeDatetimeTrueNoLastIncomingMailTime.
LastOutgoingMailTimeDatetimeTrueNoLastOutgoingMailTime.
LostReasonStringTrueNoLostReason.
LostTimeStringTrueNoLostTime.
NextActivityDateDateTrueNoNextActivityDate.
NextActivityDurationTimeTrueNoNextActivityDuration.
NextActivityIdIntegerTrueNoNextActivityId.
NextActivitynoteStringTrueNoNextActivitynote.
NextActivitysubjectStringTrueNoNextActivitysubject.
NextActivitytimeTimeTrueNoNextActivitytime.
NextActivitytypeStringTrueNoNextActivitytype.
NotesCountIntegerTrueNoNotesCount.
OrgHiddenBooleanTrueNoOrgHidden.
OrgActive_flagBooleanTrueNoOrgActive_flag.
OrgAddressStringTrueNoOrgAddress.
OrgCcEmailStringTrueNoOrgCcEmail.
OrgIdNameStringTrueNoOrgName.
OrgOwnerIdIntegerTrueNoOrgOwnerId.
OrgPeopleCountIntegerTrueNoOrgPeopleCount.
OrgValueIntegerTrueNoOrgValue.
OwnerNameStringTrueNoOwnerName.
ParticipantsCountIntegerTrueNoParticipantsCount.
PersonHiddenBooleanTrueNoPersonHidden.
PersonActiveFlagBooleanTrueNoPersonActiveFlag.
PersonEmailStringTrueNoPersonEmail.
PersonIdNameStringTrueNoPersonName.
PersonPhoneStringTrueNoPersonPhone.
PersonValueIntegerTrueNoPersonValue.
PipelineIdIntegerTrueNoPipelineId.
ProbabilityStringTrueNoProbability.
ProductsCountIntegerTrueNoProductsCount.
RottenTimeStringTrueNoRottenTime.
StageChangeTimeDatetimeTrueNoStageChangeTime.
StageIdIntegerTrueNoStageId.
StageOrderNrIntegerTrueNoStageOrderNr.
StatusStringTrueNoOnly fetch deals with specific status.
TitleStringTrueNoTitle.
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount.
UpdateTimeDatetimeTrueNoUpdateTime.
UserActiveFlagBooleanTrueNoUserActiveFlag.
UserEmailStringTrueNoUserEmail.
UserHasPicBooleanTrueNoUserHasPic.
UserIdIntegerTrueNoUserId.
UserNameStringTrueNoUserName.
UserPicHashStringTrueNoUserPicHash.
UserValueIntegerTrueNoUserValue.
ValueIntegerTrueNoValue.
VisibleToStringTrueNoVisibleTo.
WeightedValueIntegerTrueNoWeightedValue.
WeightedValueCurrencyStringTrueNoWeightedValueCurrency.
WonTimeDatetimeTrueNoWonTime.
PersonNameStringTrueNoPerson Name.
OrgNameStringTrueNoOrg Name.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonsDealsId [KEY]IntegerTrueNoId.
LabelStringTrueNoLabel.
ValueStringTrueNoValue.
PrimaryBooleanTrueNoPrimary.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonsDealsId [KEY]IntegerTrueNoId.
LabelStringTrueNoLabel.
ValueStringTrueNoValue.
PrimaryBooleanTrueNoPrimary.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonIdIntegerTruePersons.IdNoPersons Id.
labelStringFalseNoLabel.
ValueStringFalseNoValue.
PrimaryBooleanFalseNoPrimary.
FirstCharStringFalseYesIf supplied, only persons whose name starts with the specified letter will be returned.
FilterIdIntegerFalseYesFilter Id.
UserIdIntegerFalseYesUser Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId of the files.
ActiveFlagBooleanTrueNoActive Flag.
ActivityIdStringTrueNoActivity Id.
AddTimeDatetimeTrueNoAddTime.
CidStringTrueNoCid.
DealIdStringTrueNoDeal Id.
DealNameStringTrueNoDealName.
DescriptionStringTrueNoDescription.
FileNameStringTrueNoFile Name.
FileSizeIntegerTrueNoFile Size.
FileTypeStringTrueNoFile Type.
InlineFlagBooleanTrueNoInline Flag.
LogIdStringTrueNoLog Id.
MailMessageIdStringTrueNoMailMessage Id.
MailTemplateIdStringTrueNoMailTemplate Id.
NameStringTrueNoName.
OrgIdIntegerTrueNoOrg Id.
OrgNameStringTrueNoOrg Name.
PeopleNameStringTrueNoPeople Name.
PersonIdStringTruePersons.IdNoPersonId.
PersonNameStringTrueNoPerson Name.
ProductIdStringTrueNoProduc tId.
ProductNameStringTrueNoProduct Name.
RemoteIdStringTrueNoRemote Id.
RemoteLocationStringTrueNoRemote Location.
S3BucketStringTrueNoS3Bucket.
UpdateTimeDatetimeTrueNoUpdate Time.
UrlStringTrueNoUrl.
UserIdIntegerTrueNoUserId.
LeadIdStringTrueNoLeadId.
LeadNameStringTrueNoLeadName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
PersonIdIntegerTruePersons.IdNoPersons Id.
AccountIdStringTrueNoAccountId.
AddTimeDatetimeTrueNoaddTime.
BccStringTrueNoBcc.
BodyUrlStringTrueNobodyUrl.
CcStringTrueNocc.
CompanyIdIntegerTrueNocompanyId.
DeletedFlagBooleanTrueNoDeletedFlag.
DraftStringTrueNoDraft.
DraftFlagBooleanTrueNoDraftFlag.
ExternalDeletedFlagBooleanTrueNoExternalDeletedFlag.
FromStringTrueNoFrom.
AttachmentsFlagBooleanTrueNoAttachmentsFlag.
BodyFlagBooleanTrueNoBodyFlag.
InlineAttachmentsFlagBooleanTrueNoInlineAttachmentsFlag.
RealAttachmentsFlagBooleanTrueNoRealAttachmentsFlag.
ItemTypeStringTrueNoItemType.
TrackingEnabledFlagBooleanTrueNoTrackingEnabledFlag.
ThreadIdIntegerTrueNoThreadId.
TrackingStatusStringTrueNoTrackingStatus.
MessageTimeStringTrueNoMessageTime.
MessageIdStringTrueNoMessageId.
NylasIdStringTrueNoNylasId.
ReadFlagBooleanTrueNoReadFlag.
S3BucketStringTrueNoS3Bucket.
S3BucketPathStringTrueNoS3BucketPath.
SentFlagBooleanTrueNoSentFlag.
SentFromPipedriveFlagBooleanTrueNoSentFromPipedriveFlag.
SmartBccFlagBooleanTrueNoSmartBccFlag.
SnippetStringTrueNoSnippet.
SubjectStringTrueNoSubject.
SyncedFlagBooleanTrueNoSyncedFlag.
TemplateIdStringTrueNoTemplateId.
TimestampDatetimeTrueNoTimestamp.
ToStringTrueNoTo.
UpdateTimeDatetimeTrueNoUpdateTime.
UserIdIntegerTrueNoUserId.
WriteFlagBooleanTrueNowriteFlag.
ObjectStringTrueNoObject.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
EmailAddressStringTrueNoEmailAddress.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPersonName.
MessagePartyIdIntegerTrueNoMessagePartyId.
NameStringTrueNoName.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonIdIntegerTruePersons.IdNoPersons Id.
DataStringTrueNoUsers permitted to access an organization.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonIdIntegerTruePersons.IdNoPersons ID.
labelStringFalseNoLabel.
ValueStringFalseNoValue.
PrimaryBooleanFalseNoPrimary.
FirstCharStringFalseYesIf supplied, only persons whose name starts with the specified letter will be returned.
FilterIdIntegerFalseYesFilter Id.
UserIdIntegerFalseYesUser Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ProductId [KEY]IntegerTrueNoProductId.
DealActiveBooleanTrueNoDealActive.
DealActivitiesCountIntegerTrueNoDealActivitiesCount.
DealAddTimeDatetimeTrueNoDealAddTime.
DealCloseTimeStringTrueNoDealCloseTime.
DealCompanyIdIntegerTrueNoDealCompanyId.
DealCreatorUserIdIntegerTrueNoDealCreatorUserId.
DealCurrencyStringTrueNoDealCurrency.
DealDeletedBooleanTrueNoDealDeleted.
DealDoneActivitiesCountIntegerTrueNoDealDoneActivitiesCount.
DealEmailMessagesCountIntegerTrueNoDealEmailMessagesCount.
DealExpectedCloseDateStringTrueNoDealExpectedCloseDate.
DealFilesCountIntegerTrueNoDealFilesCount.
DealFirstAddtimeDatetimeTrueNoDealFirstAddtime.
DealFirstWonTimeStringTrueNoDealFirstWonTime.
DealFollowersCountIntegerTrueNoDealFollowersCount.
DealIdIntegerTrueNoDealId.
DealLabelStringTrueNoDealLabel.
DealLastActivityDateStringTrueNoDealLastActivityDate.
DealLastActivityIdStringTrueNoDealLastActivityId.
DealLastIncomingMailTimeDatetimeTrueNoDealLastIncomingMailTime.
DealLastOutgoingMailTimeDatetimeTrueNoDealLastOutgoingMailTime.
DealLostReasonStringTrueNoDealLostReason.
DealLostTimeStringTrueNoDealLostTime.
DealNextActivityDateDateTrueNoDealNextActivityDate.
DealNextActivityIdIntegerTrueNoDealNextActivityId.
DealNextActivityTimeStringTrueNoDealNextActivityTime.
DealNotesCountIntegerTrueNoDealNotesCount.
DealOrgIdIntegerTrueNoDealOrgId.
DealParticipantsCountIntegerTrueNoDealParticipantsCount.
DealPersonIdIntegerTruePersons.IdNopersons Id.
DealPipelineIdIntegerTrueNoDealPipelineId.
DealProbabilityStringTrueNoDealProbability.
DealProductsCountIntegerTrueNoDealProductsCount.
DealStageChangetimeDatetimeTrueNoDealStageChangetime.
DealStageIdIntegerTrueNoDealStageId.
DealStatusStringTrueNoDealStatus.
DealTitleStringTrueNoDealTitle.
UndoneActivitiescountIntegerTrueNoUndoneActivitiescount.
DealUpdateTimeDatetimeTrueNoDealUpdateTime.
DealUserIdIntegerTrueNoDealUserId.
DealValueDoubleTrueNoDealValue.
DealVisibleToStringTrueNoDealVisibleTo.
DealWonTimeStringTrueNoDealWonTime.
ProductActiveFlagBooleanTrueNoProductActiveFlag.
ProductAddTimeDatetimeTrueNoProductAddTime.
ProductCategoryStringTrueNoProductCategory.
ProductCodeStringTrueNoProductCode.
ProductCompanyIdIntegerTrueNoProductCompanyId.
ProductDealIdIntegerTrueNoProductDealId.
ProductDescriptionStringTrueNoProductDescription.
ProductFilesCountStringTrueNoProductFilesCount.
ProductFirstCharStringTrueNoProductFirstChar.
ProductFollowersCountIntegerTrueNoProductFollowersCount.
ProductNameStringTrueNoProductName.
ProductOwnerIdIntegerTrueNoProductOwnerId.
ProductSelectableBooleanTrueNoProductSelectable.
ProductTaxIntegerTrueNoProductTax.
ProductUnitStringTrueNoProductUnit.
ProductUpdateTimeDatetimeTrueNoProductUpdateTime.
ProductVisibleToStringTrueNoProductVisibleTo.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
NewValueFormattedStringTrueNoNewValueFormatted.
AssignedToUserIdIntegerTrueNoAssignedToUserId.
AttendeesStringTrueNoAttendees.
BusyFlagBooleanTrueNoBusyFlag.
SyncIncludecontextStringTrueNoSyncIncludecontext.
changeSourceStringTrueNochangeSource.
UserAgentStringTrueNoUserAgent.
CompanyIdIntegerTrueNoCompanyId.
MeetingClientStringTrueNoMeetingClient.
MeetingIdStringTrueNoMeetingId.
MeetingUrlStringTrueNoMeetingUrl.
CreatedByUserIdIntegerTrueNoCreatedByUserId.
DealDropboxBccStringTrueNoDealDropboxBcc.
DealIdIntegerTrueNoDealId.
DealTitleStringTrueNoDealTitle.
DoneBooleanTrueNoDone.
DueDateDateTrueNoDueDate.
DueTimeTimeTrueNoDueTime.
DurationTimeTrueNoDuration.
FieldKeyStringTrueNoFieldKey.
Fileclean_nameStringTrueNoFileclean_name.
FileIdStringTrueNoFileId.
FileUrlStringTrueNoFileUrl.
GcaleventIdStringTrueNoGcaleventId.
GoogleCalendarEtagStringTrueNoGoogleCalendarEtag.
GoogleCalendarIdStringTrueNoGoogleCalendarId.
IsBulkUpdateFlagStringTrueNoIsBulkUpdateFlag.
ItemIdIntegerTrueNoItemId.
NotificationTimeDatetimeTrueNoNotificationTime.
NotificationUserIdIntegerTrueNoNotificationUserId.
LeadIdStringTrueNoLeadId.
LocationStringTrueNoLocation.
AdminAreaLevel1StringTrueNoAdminAreaLevel1.
AdminAreaLevel2StringTrueNoAdminAreaLevel2.
CountryStringTrueNoCountry.
FormattedAddressStringTrueNoFormattedAddress.
LatDoubleTrueNoLat.
LocalityStringTrueNoLocality.
LongDoubleTrueNoLong.
PostalCodeStringTrueNoPostalCode.
RouteStringTrueNoRoute.
StreetNumberStringTrueNoStreetNumber.
SublocalityStringTrueNoSublocality.
SubpremiseStringTrueNoSubpremise.
LogTimeDatetimeTrueNoLogTime.
MarkedAsDoneTimeDatetimeTrueNoMarkedAsDoneTime.
NewValueStringTrueNoNewValue.
NoteStringTrueNoNote.
LanguageIdIntegerTrueNoLanguageId.
OldValueStringTrueNoOldValue.
OrgIdIntegerTrueorganizations.IdNoOrganizations Id.
OrgNameStringTrueNoOrganizations Name.
OwnerNameStringTrueNoOwner Name.
ParticipantsStringTrueNoParticipants.
PersonDropboxBccStringTrueNoPerson Dropbox Bcc.
PersonIdIntegerTruePersons.IdNoPersons Id.
PersonNameStringTrueNoPersonName.
PublicdescriptionStringTrueNoPublicdescription.
RecMasterActivityIdStringTrueNoRecMasterActivityId.
RecRuleStringTrueNoRecRule.
RecRuleExtensionStringTrueNoRecRuleExtension.
ReferenceIdIntegerTrueNoReferenceId.
ReferenceTypeStringTrueNoReferenceType.
SeriesStringTrueNoSeries.
SourceTimezoneStringTrueNoSourceTimezone.
SubjectStringTrueNoSubject.
TypeStringTrueNoType.
UpdateTimeDatetimeTrueNoUpdateTime.
UpdateUserIdIntegerTrueNoUpdateUserId.
UserIdIntegerTrueNoUserId.
ObjectStringTrueNoObject.
TimestampDatetimeTrueNoTimestamp.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesitem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonId [KEY]IntegerTruePersons.IdNoPersonId.
EmailAddressStringTrueNoEmailAddress.
IsOrganizerIntegerTrueNoIsOrganizer.
NameStringTrueNoName.
StatusStringTrueNoStatus.
UserIdStringTrueUsers.IdNoUserId.
AllChangesStringFalseYesWhether to show custom field updates or not.
ItemsStringFalseYesItem specific updates.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonId [KEY]IntegerTrueNoPersonId.
PrimaryFlagBooleanTrueNoPrimaryFlag.
AllChangesStringFalseYesWhether to show custom field updates or not
ItemsStringFalseYesitem specific updates

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the pipeline.
ActiveBooleanTrueNoActive.
ActivitiesCountIntegerTrueNoActivitiesCount.
AddTimeDatetimeTrueNoAddTime.
CcEmailStringTrueNoCcEmail.
CloseTimeStringTrueNoCloseTime.
CreatorUserIdIntegerTrueNoCreatorUserId.
CurrencyStringTrueNoCurrency.
DeletedBooleanTrueNoDeleted.
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount.
EmailMessagesCountIntegerTrueNoEmailMessagesCount.
ExpectedCloseDateDateTrueNoExpectedCloseDate.
FilesCountIntegerTrueNoFilesCount.
FirstWonTimeDatetimeTrueNoFirstWonTime.
FollowersCountIntegerTrueNoFollowersCount.
FormattedValueStringTrueNoFormattedValue.
FormattedWeightedValueStringTrueNoFormattedWeightedValue.
LabelStringTrueNoLabel.
LastActivityDateStringTrueNoLastActivityDate.
LastActivityIdStringTrueNoLastActivityId.
LastIncomingMailTimeDatetimeTrueNoLastIncomingMailTime.
LastOutgoingMailTimeDatetimeTrueNoLastOutgoingMailTime.
LostReasonStringTrueNoLostReason.
LostTimeStringTrueNoLostTime.
NextActivityDateDateTrueNoNextActivityDate.
NextActivityDurationTimeTrueNoNextActivityDuration.
NextActivityIdIntegerTrueNoNextActivityId.
NextActivityNoteStringTrueNoNextActivityNote.
NextActivitySubjectStringTrueNoNextActivitySubject.
NextActivityTimeTimeTrueNoNextActivityTime.
NextActivityTypeStringTrueNoNextActivityType.
NotesCountIntegerTrueNoNotesCount.
OrgHiddenBooleanTrueNoOrgHidden.
OrgIdIntegerTrueNoOrgId.
OrgNameStringTrueNoOrgName.
OwnerNameStringTrueNoOwnerName.
ParticipantsCountIntegerTrueNoParticipantsCount.
PersonHiddenBooleanTrueNoPersonHidden.
PersonIdIntegerTrueNoPersonId.
PersonNameStringTrueNoPersonName.
PipelineIdIntegerTrueNoPipelineId.
ProbabilityStringTrueNoProbability.
ProductsCountIntegerTrueNoProductsCount.
RottenTimeStringTrueNoRottenTime.
StageChangeTimeDatetimeTrueNoStageChangeTime.
StageIdIntegerTrueNoIf supplied, only deals within the given stage will be returned.
StageOrderNrIntegerTrueNoStageOrderNr.
StatusStringTrueNoStatus.
TitleStringTrueNoTitle.
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount.
UpdateTimeDatetimeTrueNoUpdateTime.
UserIdIntegerTrueNoUserId.
ValueIntegerTrueNoValue.
VisibleToStringTrueNoVisibleTo.
WeightedValueIntegerTrueNoWeightedValue.
WeightedValueCurrencyStringTrueNoWeightedValueCurrency.
WonTimeDatetimeTrueNoWonTime.
FilterIdIntegerFalseYesIf supplied, only deals matching the given filter will be returned.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PipelineIdIntegerTrueNoID of the pipeline.
LostConversionIntegerTrueNoLostConversion.
StageConversionsStringTrueNoStageConversions.
WonConversionIntegerTrueNoWonConversion.
UserIdIntegerFalseYesID of the user who's pipeline statistics to fetch.
StartDateDatetimeFalseYesStart of the period.
EndDateDatetimeFalseYesEnd of the period.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PipelineIdIntegerTrueNoID of the pipeline.
AverageAgeInDaysAcrossAllStagesIntegerTrueNoAverageAgeInDaysAcrossAllStages.
AverageAgeInDaysByStagesStringTrueNoAverageAgeInDaysByStages.
DealsLeftOpenCountIntegerTrueNoDealsLeftOpenCount.
DealsLeftOpenDealsIdsStringTrueNoDealsLeftOpenDealsIds.
DealsLeftOpenFormattedValuesUSDStringTrueNoDealsLeftOpenFormattedValuesUSD.
DealsLeftOpenValuesUSDIntegerTrueNoDealsLeftOpenValuesUSD.
LostDealsCountIntegerTrueNoLostDealsCount.
LostDealsDealsIdsStringTrueNoLostDealsDealsIds.
LostDealsFormattedValuesUSDStringTrueNoLostDealsFormattedValuesUSD.
LostDealsValuesUSDIntegerTrueNoLostDealsValuesUSD.
MovementsBetweenStagesCountIntegerTrueNoMovementsBetweenStagesCount.
NewDealsCountIntegerTrueNoNewDealsCount.
NewDealsDealsIdsStringTrueNoNewDealsDealsIds.
NewDealsFormattedValuesUSDStringTrueNoNewDealsFormattedValuesUSD.
NewDealsValuesUSDIntegerTrueNoNewDealsValuesUSD.
WonDealsCountIntegerTrueNoWonDealsCount.
WonDealsDealsIdsStringTrueNoWonDealsDealsIds.
WonDealsFormattedValuesUSDStringTrueNoWonDealsFormattedValuesUSD.
WonDealsValuesUSDIntegerTrueNoWonDealsValuesUSD.
UserIdIntegerFalseYesID of the user who's pipeline statistics to fetch.
StartDateDatetimeFalseYesStart of the period. Date in format of YYYY-MM-DD
EndDateDatetimeFalseYesEnd of the period. Date in format of YYYY-MM-DD

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PipelineIdIntegerTrueNoID of the pipeline.
StageIdIntegerTrueNoAverageAgeInDaysAcrossAllStages.
ValueIntegerTrueNoAverageAgeInDaysAcrossAllStages.
UserIdIntegerFalseYesID of the user who's pipeline statistics to fetch.
StartDateDatetimeFalseYesStart of the period. Date in format of YYYY-MM-DD
EndDateDatetimeFalseYesEnd of the period. Date in format of YYYY-MM-DD

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PipelineIdIntegerTrueNoID of the pipeline
ConversionRateIntegerTrueNoConversionRate
FromStageIdStringTrueNoFromStageId
ToStageIdIntegerTrueNoToStageId
UserIdIntegerFalseYesID of the user who's pipeline statistics to fetch
StartDateDateFalseYesStart of the period
EndDateDateFalseYesEnd of the period

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the pipeline.
NameStringFalseNoThe name of the Pipeline.
ActiveBooleanFalseNoWhether this Pipeline will be made inactive (hidden) or active.
DealProbabilityIntegerFalseNoWhether Deal probability is disabled or enabled for this Pipeline.
OrderNrIntegerFalseNoDefines the order of Pipelines.
SelectedBooleanTrueNoSelected.
UpdateTimeDatetimeTrueNoUpdateTime.
AddTimeDatetimeTrueNoAddTime.
UrlTitleStringFalseNoUrlTitle.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the Product Field.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
AddVisibleFlagBooleanTrueNoAddVisibleFlag.
BulkEditAllowedBooleanTrueNoBulkEditAllowed.
DetailsVisibleFlagBooleanTrueNoDetailsVisibleFlag.
EditFlagBooleanTrueNoEditFlag.
FieldTypeStringFalseNoType of the field.
FilteringAllowedBooleanTrueNoFilteringAllowed.
ImportantFlagBooleanTrueNoImportantFlag.
IndexVisibleFlagBooleanTrueNoIndexVisibleFlag.
KeyStringTrueNoKey.
LastUpdatedByUserIdStringTrueNoLastUpdatedByUserId.
MandatoryFlagBooleanTrueNoMandatoryFlag.
NameStringFalseNoName of the field.
OptionsStringFalseNoOptions.
OrderNrIntegerTrueNoOrderNr.
PicklistDataStringTrueNoPicklistData.
SearchableFlagBooleanTrueNoSearchableFlag.
SortableFlagBooleanTrueNoSortableFlag.
UpdateTimeDatetimeTrueNoUpdateTime.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the Product Field Options.
LabelStringTrueNoLabel.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdIntegerTrueNoproduct Id
ActiveFlagBooleanTrueNoWhether this product will be made active or not
AddTimeDatetimeTrueNoAdd Time
CategoryStringTrueNocategory
CodeStringFalseNoProduct code.
CustomeFieldStringTrueNoCustomeField you will get the result of this column only when criteria filter title is used
DescriptionStringTrueNodescription
FilesCountStringTrueNoFilesCount
FirstCharStringTrueNoIf supplied only Products whose name starts with the specified letter will be returned
NameStringFalseNoName of the product
OwnerActiveFlagBooleanTrueNoOwnerActiveFlag
OwnerEmailStringTrueNoOwnerEmail
OwnerHasPicBooleanTrueNoOwnerHasPic
OwnerIdIntegerFalseNoID of the user who will be marked as the owner of this product
OwnerNameStringTrueNoOwnerName
OwnerPicHashStringTrueNoOwnerPicHas
OwnervalueIntegerTrueNoOwner Id
PricesStringFalseNoObject containing price objects
SelectableBooleanFalseNoWhether this product can be selected in Deals or not
TaxIntegerFalseNoTax percentage
TypeStringTrueNoType you will get the result of this column only when criteria filter title is used
UnitStringFalseNoUnit in which this product is sold
UpdateTimeDatetimeTrueNoUpdate Time
VisibleToStringFalseNoVisibility of the product
SummaryTotalCountStringTrueNoYou will get data of this column when Criterial filter is GetSummary is used
UserIdIntegerFalseYesUser Id
FilterIdIntegerFalseYesFilter Id
GetSummaryBooleanFalseYesGet SUmmary
IdsIntegerFalseYesThe Ids of the Products that should be returned in the response

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
ProductIdIntegerTrueNoProducts Id.
ActiveBooleanTrueNoActive.
ActivitiesCountIntegerTrueNoActivitiesCount.
AddTimeDatetimeTrueNoAddTime.
CcEmailStringTrueNoCcEmail.
CloseTimeStringTrueNoCloseTime.
CreatorActiveFlagBooleanTrueNoCreatorActiveFlag.
CreatorEmailStringTrueNoCreatorEmail.
CreatorHasPicBooleanTrueNoCreatorHasPic.
CreatorIdIntegerTrueNoCreatorId.
CreatorNameStringTrueNoCreatorName.
CreatorPicHashStringTrueNoCreatorPicHash.
CreatorValueIntegerTrueNoCreatorValue.
CurrencyStringTrueNoCurrency.
DeletedBooleanTrueNoDeleted.
DoneActivitiesCountIntegerTrueNoDoneActivitiesCount.
EmailMessagesCountIntegerTrueNoEmailMessagesCount.
ExpectedCloseDateStringTrueNoExpectedCloseDate.
FilesCountIntegerTrueNoFilesCount.
FirstWonTimeStringTrueNoFirstWonTime.
FollowersCountIntegerTrueNoFollowersCount.
FormattedValueStringTrueNoFormattedValue.
FormattedWeightedValueStringTrueNoFormattedWeightedValue.
LabelStringTrueNoLabel.
LastActivityDateStringTrueNoLastActivityDate.
LastActivityIdStringTrueNoLastActivityId.
LastIncomingMailTimeStringTrueNoLastIncomingMailTime.
LastOutgoingMailTimeStringTrueNoLastOutgoingMailTime.
LostReasonStringTrueNoLostReason.
LostTimeStringTrueNoLostTime.
NextActivityDateDateTrueNoNextActivityDate.
NextActivityDurationTimeTrueNoNextActivityDuration.
NextActivityIdIntegerTrueNoNextActivityId.
NextActivityNoteStringTrueNoNextActivityNote.
NextActivitySubjectStringTrueNoNextActivitySubject.
NextActivityTimeTimeTrueNoNextActivityTime.
NextActivityTypeStringTrueNoNextActivityType.
NotesCountIntegerTrueNoNotesCount.
OrgHiddenBooleanTrueNoOrgHidden.
OrgIdNameStringTrueNoOrgId Name.
OrgIdPeopleCountIntegerTrueNoOrgId People count.
OrgIdOwnerIdIntegerTrueNoOrgId Owner Id.
OrgIdAddressStringTrueNoOrgId Address.
OrgIdActiveFlagBooleanTrueNoOrgId Active flag.
OrgIdCcEmailStringTrueNoOrgId CcEmail.
OrgIdValueIntegerTrueNoOrgId Value.
OrgNameStringTrueNoOrgName.
OwnerNameStringTrueNoOwnerName.
ParticipantsCountIntegerTrueNoParticipantsCount.
PersonHiddenBooleanTrueNoPersonHidden.
PersonActiveFlagBooleanTrueNoPersonActiveFlag.
PersonEmailStringTrueNoPersonEmail.
PersonIdNameStringTrueNoPersonName.
PersonPhoneStringTrueNoPersonPhone.
PersonValueIntegerTrueNoPersonValue.
PipelineIdIntegerTrueNoPipelineId.
ProbabilityStringTrueNoProbability.
ProductsCountIntegerTrueNoProductsCount.
RottenTimeStringTrueNoRottenTime.
StageChangeTimeStringTrueNoStageChangeTime.
StageIdIntegerTrueNoStageId.
StageOrderNrIntegerTrueNoStageOrderNr.
StatusStringTrueNoOnly fetch deals with specific status.
TitleStringTrueNoTitle.
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount.
UpdateTimeDatetimeTrueNoUpdateTime.
UserActiveFlagBooleanTrueNoUserActiveFlag.
UserEmailStringTrueNoUserEmail.
UserHasPicBooleanTrueNoUserHasPic.
UserIdIntegerTrueNoUserId.
UserNameStringTrueNoUserName.
UserPicHashStringTrueNoUserPicHash.
UservalueIntegerTrueNoUservalue.
ValueDoubleTrueNoValue.
VisibleToStringTrueNoVisibleTo.
WeightedValueDoubleTrueNoWeightedValue.
WeightedValueCurrencyStringTrueNoWeightedValueCurrency.
WonTimeStringTrueNoWonTime.
PersonNameStringTrueNoPerson name.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ProductIdIntegerTrueNoProducts Id.
LabelStringTrueNoLabel.
PrimaryBooleanTrueNoPrimary.
ValueStringTrueNoValue.
StatusStringFalseYesOnly fetch deals with specific status.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ProductIdIntegerTrueNoProducts Id.
LabelStringTrueNoLabel.
PrimaryBooleanTrueNoPrimary.
ValueStringTrueNoValue.
StatusStringFalseYesOnly fetch deals with specific status.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId of the products.
ActiveFlagBooleanTrueNoActive Flag.
ActivityIdStringTrueNoActivity Id.
AddTimeDatetimeTrueNoAddTime.
CidStringTrueNoCid.
DealIdStringTrueNoDeal Id.
DealNameStringTrueNoDealName.
DescriptionStringTrueNoDescription.
FileNameStringTrueNoFile Name.
FileSizeIntegerTrueNoFile Size.
FileTypeStringTrueNoFile Type.
InlineFlagBooleanTrueNoInline Flag.
LogIdStringTrueNoLog Id.
MailMessageIdStringTrueNoMailMessage Id.
MailTemplateIdStringTrueNoMailTemplate Id.
NameStringTrueNoName.
OrgIdIntegerTrueNoOrg Id.
OrgNameStringTrueNoOrg Name.
PeopleNameStringTrueNoPeople Name.
PersonIdStringTrueNoPersonId.
PersonNameStringTrueNoPerson Name.
ProductIdStringTrueProducts.idNoProduct Id.
ProductNameStringTrueNoProduct Name.
RemoteIdStringTrueNoRemote Id.
RemoteLocationStringTrueNoRemote Location.
S3BucketStringTrueNoS3Bucket.
UpdateTimeDatetimeTrueNoUpdate Time.
UrlStringTrueNoUrl.
UserIdIntegerTrueNoUserId.
IncludeDeletedFilesIntegerFalseYesWhen enabled, the list of files will also include deleted files.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdIntegerTrueNoId.
AddTimeDatetimeTrueNoAddTime.
ProductIdIntegerTrueNoProductId.
UserIdIntegerFalseNoUserId.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ProductIdIntegerTrueProducts.IdNoProducts Id.
DataStringTrueNoData.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoId.
CostIntegerTrueNoCost.
CurrencyStringTrueNoCurrency.
OverheadCostStringTrueNoOverheadCost.
PriceIntegerTrueNoPrice.
ProductIdIntegerTrueNoProductId.
FirstCharStringFalseYesIf supplied only Products whose name starts with the specified letter will be returned.
UserIdIntegerFalseYesUser Id.
FilterIdIntegerFalseYesFilter Id.
GetSummaryBooleanFalseYesGet Summary.
IdsIntegerFalseYesThe Ids of the Products that should be returned in the response.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdIntegerTrueNoId.
DataActiveBooleanTrueNoDataActive.
DataActiveFlagBooleanTrueNoDataActiveFlag.
DataActivitiesCountIntegerTrueNoDataActivitiesCount.
DataAddTimeDatetimeTrueNoDataAddTime.
DataAssignedToUserIdIntegerTrueNoDataAssignedToUserId.
DataAttendeesStringTrueNoDataAttendees.
DataBusyFlagStringTrueNoData BusyFlag.
DataCalendarSyncContextStringTrueNoDataCalendarSyncContext.
DataCcEmailStringTrueNoDataCcEmail.
DataCloseTimeStringTrueNoDataCloseTime.
DataCompanyIdIntegerTrueNoDataCompanyId.
DataConferenceMeetingClientStringTrueNoDataConferenceMeetingClient.
DataConferenceMeetingIdStringTrueNoDataConferenceMeetingId.
DataConferenceMeetingUrlStringTrueNoDataConferenceMeetingUrl.
DataCreatedByUserIdIntegerTrueNoDataCreatedByUserId.
DataCreatorUserIdIntegerTrueNoDataCreatorUserId.
DataCurrencyStringTrueNoDataCurrency.
DataDealDropboxBccStringTrueNoDataDealDropboxBcc.
DataDealIdStringTrueNoDataDealId.
DataDealTitleStringTrueNoDataDealTitle.
DataDeletedBooleanTrueNoDataDeleted.
DataDoneBooleanTrueNoDataDone.
DataDoneActivitiesCountIntegerTrueNoDataDoneActivitiesCount.
DataDueDateDateTrueNoDataDueDate.
DataDueTimeDatetimeTrueNoDataDueTime.
DataDurationDatetimeTrueNoDataDuration.
DataEmailMessagesCountIntegerTrueNoDataEmailMessagesCount.
DataExpectedCloseDateDateTrueNoDataExpectedCloseDate.
DataFileIdStringTrueNoDataFile Id.
DataFileCleanNameStringTrueNoDataFile clean name.
DataFileUrlStringTrueNoDataFile url.
DataFilesCountIntegerTrueNoDataFilesCount.
DataFirstWonTimeStringTrueNoDataFirstWonTime.
DataFollowersCountIntegerTrueNoDataFollowersCount.
DataFormattedValueStringTrueNoDataFormattedValue.
DataFormattedWeightedValueStringTrueNoDataFormattedWeightedValue.
DataGcalEventIdStringTrueNoDataGcalEventId.
DataGoogleCalendarEtagStringTrueNoDataGoogleCalendarEtag.
DataGoogleCalendarIdStringTrueNoDataGoogleCalendarId.
DataIdIntegerTrueNoDataId.
DataLabelStringTrueNoDataLabel.
ActivityDateStringTrueNoActivityDate.
ActivityIdStringTrueNoActivityId.
IncomingMailTimeStringTrueNoIncomingMailTime.
LastNotificationTimeStringTrueNoLast_notification_time.
LastNotificationUserIdStringTrueNoLast_notification_user_id.
LastOutgoingMailTimeStringTrueNoLast_outgoing_mail_time.
LeadIdStringTrueNoLeadId.
LeadTitleStringTrueNoLeadTitle.
LocationStringTrueNoLocation.
AreaLevel1StringTrueNoAreaLevel1.
AreaLevel2StringTrueNoAreaLevel2.
LocationCountryStringTrueNoLocationCountry.
LocationFormattedAddressStringTrueNoLocationFormattedAddress.
LocationlocalityStringTrueNoLocationlocality.
LocationPostalCodeStringTrueNoLocationPostalCode.
LocationRouteStringTrueNoLocationRoute.
LocationStreetNumberStringTrueNoLocationStreetNumber.
LocationSublocalityStringTrueNoLocationSublocality.
LocationSubpremiseStringTrueNoLocationSubpremise.
LostReasonStringTrueNoLostReason.
LostTimeStringTrueNoLostTime.
MarkedAsDoneTimeStringTrueNoMarkedAsDoneTime.
NextActivityDateStringTrueNoNextActivityDate.
NextActivityDurationStringTrueNoNextActivityDuration.
NextActivityIdStringTrueNoNextActivityId.
NextActivityNoteStringTrueNoNextActivityNote.
NextActivitySubjectStringTrueNoNextActivitySubject.
NextActivityTimeStringTrueNoNextActivityTime.
NextActivityTypeStringTrueNoNextActivityType.
NoteStringTrueNoNote.
NotesCountIntegerTrueNoNotesCount.
NotificationLanguageIdIntegerTrueNoNotificationLanguageId.
OrgHiddenBooleanTrueNoOrgHidden.
OrgIdIntegerTrueNoOrgId.
OrgNameStringTrueNoOrgName.
OwnerNameStringTrueNoOwnerName.
ParticipantsStringTrueNoParticipants.
ParticipantsCountIntegerTrueNoParticipantsCount.
PersonDropboxBccStringTrueNoPersonDropboxBcc.
PersonHiddenBooleanTrueNoPersonHidden.
PersonIdIntegerTrueNoPersonId.
PersonNameStringTrueNoPersonName.
PipelineIdIntegerTrueNoPipelineId.
ProbabilityStringTrueNoProbability.
ProductsCountIntegerTrueNoProductsCount.
PublicDescriptionStringTrueNoPublicDescription.
RecMasterActivityIdStringTrueNoRecMasterActivityId.
RecRuleStringTrueNoRecRule.
RecRuleExtensionStringTrueNoRecRuleExtension.
ReferenceIdStringTrueNoReferenceId.
ReferenceTypeStringTrueNoReferenceType.
RottenTimeStringTrueNoRottenTime.
SeriesStringTrueNoSeries.
SourceTimezoneStringTrueNoSourceTimezone.
StageChangeTimeStringTrueNoStageChangeTime.
StageIdIntegerTrueNoStageId.
StageOrderNrIntegerTrueNoStageOrderNr.
StatusStringTrueNoStatus.
SubjectStringTrueNoSubject.
DataTitleStringTrueNoDataTitle.
DataTypeStringTrueNoDataType.
UndoneActivitiesCountIntegerTrueNoUndoneActivitiesCount.
UpdateTimeDatetimeTrueNoUpdateTime.
UpdateUserIdStringTrueNoUpdateUserId.
UserIdIntegerTrueNoUserId.
ValueIntegerTrueNoValue.
VisibleToStringTrueNoVisibleTo.
WeightedValueIntegerTrueNoWeightedValue.
WeightedValueCurrencyStringTrueNoWeightedValueCurrency.
WonTimeStringTrueNoWonTime.
ItemStringTrueNoItem.
SinceTimestampDatetimeFalseYesTimestamp in UTC.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
EmailAddressStringTrueNoEmail Address.
IsOrganizerIntegerTrueNoIs Organizer.
NameStringTrueNoName.
PersonIdIntegerTrueNoPerson Id.
StatusStringTrueNoStatus.
UserIdIntegerTrueNoUserId.
SinceTimestampDatetimeFalseYesTimestamp in UTC.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PersonIdIntegerTrueNoPerson Id.
PrimaryFlagBooleanTrueNoPrimary Flag.
SinceTimestampDatetimeFalseYesTimestamp in UTC.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the role.
ActiveFlagBooleanTrueNoActiveFlag.
AssignmentCountStringTrueNoAssignmentCount.
LevelIntegerTrueNoLevel.
NameStringFalseNoThe name of the Role.
ParentRoleIdIntegerFalseNoThe ID of the parent Role.
SubRoleCountStringTrueNoSubRoleCount.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RoleIdIntegerFalseNoRoleId.
ActiveFlagBooleanTrueNoActiveFlag.
NameStringTrueNoName.
ParentRoleIdStringTrueNoParentRoleId.
TypeStringTrueNoType.
UserIdIntegerFalseNoID of the user.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RoleId [KEY]IntegerTrueNoID of the Role.
PipelineIdsStringFalseNoIds of the Pipeline.
VisibleBooleanTrueNoVisible.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RoleId [KEY]IntegerTrueNoRole Id.
DealDefaultVisibilityIntegerTrueNoDealDefaultVisibility.
LeadDefaultVisibilityIntegerTrueNoLeadDefaultVisibility.
OrgDefaultVisibilityIntegerTrueNoOrgDefaultVisibility.
PersonDefaultVisibilityIntegerTrueNoPersonDefaultVisibility.
ProductDefaultVisibilityIntegerTrueNoProductDefaultVisibility.
ValueStringFalseYesPossible values for the default_visibility setting depending on the subscription plan.
SettingKeyStringFalseYesSettingKey.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the stage.
ActiveFlagBooleanTrueNoActiveFlag.
AddTimeDatetimeTrueNoAddTime.
DealProbabilityIntegerFalseNoDeal success probability percentage.
NameStringFalseNoName of the Stage.
OrderNrIntegerFalseNoAn order number for this stage.
PipelineDealProbabilityIntegerTrueNoPipelineDealProbability.
PipelineIdIntegerFalseNoThe ID of the Pipeline to add Stage to.
PipelineNameStringTrueNoPipelineName.
RottenDaysStringFalseNoThe number of days the Deals not updated in this Stage would become rotten. Applies only if the rotten_flag is set.
RottenFlagBooleanFalseNoWhether Deals in this stage can become rotten.
UpdateTimeDatetimeTrueNoUpdateTime.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoStages Deals Id.
StageIdIntegerTrueNoStage Id.
ActiveBooleanTrueNoActive.
ActivitiesCountIntegerTrueNoActivities count.
AddTimeStringTrueNoAdded time of Stage deals.
CcEmailStringTrueNoCc Email.
CloseTimeStringTrueNoClose time of Stages deals.
CreatorUserIdIntegerTrueNoCreator user id.
CurrencyStringTrueNoCurrency.
DeletedBooleanTrueNoBoolean value that represents stage deals is deleted or not.
DoneActivitiesCountIntegerTrueNoCount of done activities.
EmailMessagesCountIntegerTrueNoCount of email messages.
ExpectedCloseDateDateTrueNoExpected close date.
FilesCountIntegerTrueNoCount of files.
FirstWonTimeStringTrueNoFirst won time.
FollowersCountIntegerTrueNoCount of followers.
FormattedValueStringTrueNoFormatted value.
FormattedWeightedValueStringTrueNoFormatted weighted value.
LabelStringTrueNoLabel.
LastActivityDateStringTrueNoLast activity date.
LastActivityIdStringTrueNoLast activity id.
LastIncomingMailTimeStringTrueNoLast incoming mail time.
LastOutgoingMailTimeStringTrueNoLast outgoing mail time.
LostReasonStringTrueNoLost reason.
LostTimeStringTrueNoLost time.
NextAactivityDateDateTrueNoNext activity date.
NextActivityDurationStringTrueNoNext activity duration.
NextActivityIdIntegerTrueNoNext activity id.
NextActivityNoteStringTrueNoNext activity note.
NextActivitySubjectStringTrueNoNext activity subject.
NextActivityTimeStringTrueNoNext activity time.
NextActivityTypeStringTrueNoNext activity type.
NotesCountIntegerTrueNoNotes count.
OrgHiddenBooleanTrueNoOrg hidden.
OrgIdIntegerTrueNoOrg Id.
OrgNameStringTrueNoOrg Name.
OwnerNameStringTrueNoOwner name.
ParticipantsCountIntegerTrueNoParticipants count.
PersonHiddenBooleanTrueNoPerson hidden.
PersonIdIntegerTrueNoPerson id.
PersonNameStringTrueNoPerson name.
PipelineIdIntegerTrueNoPipeline id.
ProbabilityUnknownTrueNoProbability.
ProductsCountIntegerTrueNoProducts count.
RottenTimeStringTrueNoRotten time.
StageChangeTimeStringTrueNoStage change time.
StageOrderNrIntegerTrueNoStage order nr.
StatusStringTrueNoStatus.
TitleStringTrueNoTitle.
UndoneActivitiesCountIntegerTrueNoCount of undone activities.
UpdateTimeDatetimeTrueNoUpdated time.
UserIdIntegerTrueNoUser id.
ValueIntegerTrueNoValue.
VisibleToStringTrueNoVisible to.
WeightedValueIntegerTrueNoWeighted value.
WeightedValueCurrencyStringTrueNoWeighted value currency.
WonTimeStringTrueNoWon time.
FilterIdIntegerFalseYesFilter id.
EveryoneStringFalseYesEveryone.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the Subscription Payments.
SubscriptionIdIntegerTrueNoID of the Subscription.
DealIdIntegerTrueNoDeal Id.
IsActiveBooleanTrueNoIs Active.
AmountIntegerTrueNoAmount.
CurrencyStringTrueNoCurrency.
ChangeAmountIntegerTrueNoChange amount.
DueAtDateTrueNoDue at.
RevenueMovementTypeStringTrueNoRevenue movement type.
PaymentTypeStringTrueNoPayment type.
DescriptionStringTrueNoDescription.
AddTimeStringTrueNoAdd time.
UpdateTimeStringTrueNoUpdate time.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the Subscription.
AddTimeDatetimeTrueNoAddTime.
CadenceTypeStringFalseNoInterval between payments.
CurrencyStringFalseNoThe currency of the Installment Subscription. Accepts a 3-character currency code.
CycleAmountDoubleFalseNoAmount of each payment.
CyclesCountIntegerFalseNoShows how many payments the Subscription has.
DealIdIntegerFalseNoID of the Deal this Installment Subscription is associated with.
DescriptionStringFalseNoDescription of the Recurring Subscription.
EndDateStringFalseNoEndDate.
FinalStatusStringTrueNoFinalStatus.
InfiniteBooleanFalseNoThis indicates that the Recurring Subscription will last until it's manually canceled or deleted.
IsActiveBooleanTrueNoIsActive.
LifetimeValueDoubleTrueNoLifetimeValue.
StartDateStringFalseNoStart date of the Recurring Subscription. Format: YYYY-MM-DD
UpdateTimeDatetimeFalseNoUpdateTime.
UserIdIntegerTrueNoUserId.
SubscriptionTypeStringTrueNoSubscriptionType.
PaymentsStringFalseYesArray of payments.
EffectiveDateDateFalseYesArray of payments.
UpdateDealValueBooleanFalseYesIndicates that the Deal value must be set to Recurring Subscription's MRR value.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
GoogleStringTrueNoGoogle.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerTrueNoID of the user.
ActivatedBooleanFalseNoActivated.
ActiveFlagBooleanFalseNoWhether the user is active or not.
CreatedDatetimeFalseNoCreated.
DefaultCurrencyStringFalseNoDefaultCurrency.
EmailStringFalseNoEmail of the user.
HascreatedcompanyBooleanFalseNoHascreatedcompany.
IconUrlStringFalseNoIconUrl.
IsAdminIntegerFalseNoIsAdmin.
IsYouBooleanFalseNoIsYou.
LangIntegerFalseNoLang.
LastLoginDatetimeFalseNoLastLogin.
LocaleStringFalseNoLocale.
ModifiedDatetimeFalseNoModified.
NameStringFalseNoName of the user.
PhoneStringFalseNoPhone.
RoleIdIntegerFalseNoID of the role.
TimezoneNameStringFalseNoTimezoneName.
TimezoneOffsetStringFalseNoTimezoneOffset.
AccessStringFalseNoThe access given to the user.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AppStringFalseNoID of the user.
AdminBooleanFalseNoAdmin.
PermissionSetIdStringFalseNoPermission Set Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ExpectedCloseDateStringTrueNoExpectedCloseDate.
BetaAppStringTrueNoBetaApp.
CalltoLinkStringTrueNoCalltoLink.
FileUploadDestinationStringTrueNoFileUploadDestination.
ListLimitIntegerTrueNoListLimit.
MarketplaceCustomUrlStringTrueNoMarketplaceCustomUrl.
MarketplaceExtensionsVendorStringTrueNoMarketplaceExtensionsVendor.
MarketplaceTeamStringTrueNoMarketplaceTeam.
PersonDuplicateConditionStringTrueNoPersonDuplicateCondition.
SalesphoneCalltoOverrideStringTrueNoSalesphoneCalltoOverride.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
UserIdIntegerTrueNoID of the user.
DataIntegerTrueNoData.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
UserIdIntegerTrueNoID of the user.
CanAddCustomFieldsBooleanTrueNoCanAddCustomFields.
CanBulkEditItemsBooleanTrueNoCanBulkEditItems.
CanChangeVisibilityOfItemsBooleanTrueNoCanChangeVisibilityOfItems.
CanCreateOwnWorkflowBooleanTrueNoCanCreateOwnWorkflow.
CanModifyOwnerForDealsBooleanTrueNoCanModifyOwnerForDeals.
CanDeleteDealsBooleanTrueNoCanDeleteDeals.
CanConvertDealsToLeadsBooleanTrueNoCanConvertDealsToLeads.
CanMergeDealsBooleanTrueNoCanMergeDeals.
CanEditDealsClosedDateBooleanTrueNoCanEditDealsClosedDate.
CanModifyOwnerForLeadsBooleanTrueNoCanModifyOwnerForLeads.
CanDeleteLeadsBooleanTrueNoCanDeleteLeads.
CanMergeLeadsBooleanTrueNoCanMergeLeads.
CanSeeDealsListSummaryBooleanTrueNoCanSeeDealsListSummary.
CanAddDealsBooleanTrueNoCanAddDeals.
CanEditOtherUsersDealsBooleanTrueNoCanEditOtherUsersDeals.
CanAddLeadsBooleanTrueNoCanAddLeads.
CanEditOtherUsersLeadsBooleanTrueNoCanEditOtherUsersLeads.
CanEditCustomFieldsBooleanTrueNoCanEditCustomFields.
CanDeleteCustomFieldsBooleanTrueNoCanDeleteCustomFields.
CanUseImportBooleanTrueNoCanUseImport.
CanModifyLabelsBooleanTrueNoCanModifyLabels.
CanExportDataFromListsBooleanTrueNoCanExportDataFromLists.
CanShareFiltersBooleanTrueNoCanShareFilters.
CanEditSharedFiltersBooleanTrueNoCanEditSharedFilters.
CanShareInsightsBooleanTrueNoCanShareInsights.
CanUseEmailTrackingBooleanTrueNoCanUseEmailTracking.
CanSeeOtherUsersStatisticsBooleanTrueNoCanSeeOtherUsersStatistics.
CanSeeCompanyWideStatisticsBooleanTrueNoCanSeeCompanyWideStatistics.
CanSeeOtherUsersBooleanTrueNoCanSeeOtherUsers.
CanFollowOtherUsersBooleanTrueNoCanFollowOtherUsers.
CanSeeHiddenItemsNamesBooleanTrueNoCanSeeHiddenItemsNames.
CanModifyOwnerForActivitiesBooleanTrueNoCanModifyOwnerForActivities.
CanDeleteActivitiesBooleanTrueNoCanDeleteActivities.
CanModifyOwnerForPeopleBooleanTrueNoCanModifyOwnerForPeople.
CanDeletePeopleBooleanTrueNoCanDeletePeople.
CanMergePeopleBooleanTrueNoCanMergePeople.
CanModifyOwnerForOrganizationsBooleanTrueNoCanModifyOwnerForOrganizations.
CanDeleteOrganizationsBooleanTrueNoCanDeleteOrganizations.
CanMergeOrganizationsBooleanTrueNoCanMergeOrganizations.
CanAddProductsBooleanTrueNoCanAddProducts.
CanEditOtherUsersProductsBooleanTrueNoCanEditOtherUsersProducts.
CanModifyOwnerForProductsBooleanTrueNoCanModifyOwnerForProducts.
CanDeleteProductsBooleanTrueNoCanDeleteProducts.
CanDeleteProductVariationsBooleanTrueNoCanDeleteProductVariations.
CanUseApiBooleanTrueNoCanUseApi.
CanAddPeopleBooleanTrueNoCanAddPeople.
CanEditOtherUsersPeopleBooleanTrueNoCanEditOtherUsersPeople.
CanAddOrganizationsBooleanTrueNoCanAddOrganizations.
CanEditOtherUsersOrganizationsBooleanTrueNoCanEditOtherUsersOrganizations.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
UserIdIntegerTrueNoID of the user.
RoleIdIntegerTrueNoRole Id.
ParentRoleIdIntegerTrueNoParent Role Id.
NameStringTrueNoName.
ActiveFlagBooleanTrueNoActive flag.
TypeStringTrueNoType.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
UserIdIntegerTrueNoID of the user.
DealDefaultVisibilityIntegerTrueNoDeal Default Visibility.
LeadDefaultVisibilityIntegerTrueNoLead Default Visibility.
OrgDefaultVisibilityIntegerTrueNoOrg Default Visibility.
PersonDefaultVisibilityIntegerTrueNoPerson Default Visibility.
ProductDefaultVisibilityIntegerTrueNoProduct Default Visibility.

Return to Top