Salesforce Docs Portal

Pipedrive Connector Objects (V1 Schema)

note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.

Objects Supported

Name Description
Activities Get all Activities assigned to a particular User.
ActivitiesAttendees Get all Activities attendees assigned to a particular User
ActivitiesParticipants Getdetails of activities participants
ActivityFields Returns all activity fields.
ActivityFieldsOptions Returns all activity fields.
ActivityTypes Get all ActivityTypes.
CallLogs Returns all call logs assigned to a particular user.
Currencies Returns all supported currencies in given account which should be used when saving monetary values with other objects.
CurrentUsers Returns data about an authorized user within the company with bound company data: company ID, company name, and domain.
DealFields Returns data about all deal fields.
DealFieldsOptions Returns data about all deal fields.
Deals Get all deals.
DealsActivities Get all Deals Activities assigned to a particular User.
DealsActivitiesAttendees Get Details of Deals Activities Attendees.
DealsActivitiesParticipants Getdetails of activities participants.
DealsFiles Get details of deals file.
DealsFollowers Get details of deals followers.
DealsMailMessages Get details of Deal mail Messages.
DealsMailMessagesBcc Get details of Deal mail Messages.
DealsMailMessagesCc Get details of Deal mail Messages.
DealsMailMessagesFrom Get details of Deal mail Messages.
DealsMailMessagesTo Get details of Deal mail Messages.
DealsParticipants Get details of deals participants.
DealsParticipantsEmail Get details of deals participants Person Email.
DealsParticipantsPersonEmail Get details of deals participants Person Email.
DealsParticipantsPersonPhone Get details of deals participants Person Phone.
DealsParticipantsPhone Get details of deals participants Person Email.
DealsPermittedUsers Get details of deals Permitted users
DealsPersonEmails Get all emails asscociated with persons in deal
DealsPersonPhone Get all phone asscociated with persons in deal.
DealsPersons Get details of deals persons.
DealsPersonsEmail Get details of deals participants Person Email.
DealsPersonsPhone Get details of deals participants Person Email.
DealsProducts Get details of deals products.
DealsSummary Return detils of deals summary.
DealsTimeline Return details of deals timeline
DealsTimelineDeals Return details of DealsTimeline deals.
DealsUpdates Get details of deals updates.
DealsUpdatesAttachments Get details of deals Updates Attachments.
DealsUpdatesAttendees Get Details of Deals Activities Attendees.
DealsUpdatesBcc Get details of Deal updates Bcc.
DealsUpdatesCc Get details of Deals Updates cc.
DealsUpdatesFrom Get details of Deals Updates From.
DealsUpdatesParticipants Get details of deals updates participants.
DealsUpdatesTo Get details of Deals Updates to.
Files Returns data about all files.
FilterHelpers Returns all supported filter helpers.
Filters Returns data about all filters.
FindUsersByName Finds users by their name.
Goals Goals help your team meet your sales targets.
LeadLabels Returns details of all Lead Labels.
Leads Returns lead data.
LeadSources Returns all Lead Sources.
MailMessages Returns data about a specific mail message.
MailThreadMessages Returns all the mail messages inside a specified mail thread..
MailThreadMessagesFrom Returns all the mail messages inside a specified mail thread.
MailThreadMessagesTo Returns all the mail messages inside a specified mail thread.
MailThreads Get, Update and Delete mail threads in a specified folder ordered by the most recent message within.
MailThreadsFrom Get details of the user who sent the mail.
MailThreadsTo Get details of the user to whom sent the mail.
NoteComments Create, Update, Delete and Get the comments associated with a note.
NoteFields Returns data about all note fields.
NoteFieldsOptions Returns data about all note fields options.
Notes Returns all notes.
OrganizationFields Returns data about all organization fields.
OrganizationFieldsOptions Returns data about all organization fields options.
OrganizationRelationships Gets all of the relationships.
Organizations Get details of organizations
OrganizationsActivities Get details of organizations activities.
OrganizationsActivitiesAttendees Get details of organizations activities attendees.
OrganizationsActivitiesParticipants Get details of organizations activities participants.
OrganizationsDeals Get details of organization deals.
OrganizationsDealsPersonEmail get details of deals person email.
OrganizationsDealsPersonphone get details of deals person phone.
OrganizationsFiles Get details of deals file.
OrganizationsFollowers Get details of organizations followers.
OrganizationsInternal Get details of organizations.
OrganizationsMailMessages Get details of organizations mail Messages.
OrganizationsMailMessagesBcc Get details of organizations mail Messages.
OrganizationsMailMessagesCc Get details of organizations mail Messages.
OrganizationsMailMessagesFrom Get details of organizations mail Messages.
OrganizationsMailMessagesTo Get details of organizations mail Messages.
OrganizationsPermittedUsers Get details of permitted users of organizations.
OrganizationsPersons Get details of organizations persons
OrganizationsPersonsEmail Get details of organizations persons email
OrganizationsPersonsPhone Get details of organizations persons phone
OrganizationsUpdates Get details of organizations updates..
OrganizationsUpdatesAttendees Get details of all attendees of organizations.
OrganizationsUpdatesParticipants Getdetails of activities participants.
PermissionSets Get all permissions.
PermissionSetsAssignments .
PersonFields Returns data about all person fields.
PersonFieldsOptions Returns data about all person fields options.
PersonFollowers Get details of persons followers.
Persons Get all details of persons.
PersonsActivities Get all Persons Activities assigned to a particular Persons.
PersonsActivitiesAttendees Get Details of Persons Activities Attendees.
PersonsActivitiesParticipants Get details of Persons activities participants.
PersonsDeals Get details of Persons deals.
PersonsDealsEmail Get details of Persons deals email.
PersonsDealsPhone Get details of Persons deals phone.
PersonsEmails Get all emails asscociated with persons.
PersonsFiles Get details of Persons file.
PersonsMailMessages Get details of organizations mail Messages.
PersonsMailMessagesBcc Get details of Persons mail Messages.
PersonsMailMessagesCc Get details of persons mail Messages.
PersonsMailMessagesFrom Get details of persons mail Messages.
PersonsMailMessagesTo Get details of Persons mail Messages.
PersonsPermittedUsers Get details of permitted users of persons.
PersonsPhone Get all phone asscociated with persons.
PersonsProducts Get details of Persons Products.
PersonsUpdates Get details of persons updates.
PersonsUpdatesAttendees Get details of Deals Activities Attendees.
PersonsUpdatesParticipants Get details of activities participants
PipelineDeals Lists deals in a specific pipeline across all its stages.
PipelineDealsConversionRates Returns statistics for deals movements for given time period.
PipelineDealsMovements Returns statistics for deals movements for given time period.
PipelineDealsMovementsAverageAgeInDaysByStages Returns statistics for deals movements for given time period average age in days.
PipelineDealsStageConversions Returns statistics for deals movements for given time period
Pipelines Get all Pipelines.
ProductFields Returns data about all product fields.
ProductFieldsOptions Returns data about all product fields options.
Products Get details of Products
ProductsDeals Get details of Products Deals.
ProductsDealsPersonEmail Get details of Products Deals person email.
ProductsDealsPersonphone Get details of deals person phone.
ProductsFiles Get details of Persons file.
ProductsFollowers Get details of products followers.
ProductsPermittedUsers Get details of users permitted to access a Product.
ProductsPrices Get details of Products Prices.
Recents Returns data about all recent changes occurred after given timestamp.
RecentsAttendees Returns data about all recent changes occurred after given timestamp attendees.
RecentsParticipants Returns data about all recent changes occurred after given timestamp participants.
Roles Returns all the role.
RolesAssignments List assignments for a role.
RolesPipelinesVisibility Get the list of either visible or hidden pipeline IDs for a specific role.
RolesSetting Returns all the roles settings.
Stages Returns data about all stages.
StagesDeals Get deals in a specific stage.
SubscriptionPayments Returns all payments of an installment or recurring subscription.
Subscriptions Returns details of an installment or a recurring Subscription
UserConnection The data of user connections.
Users Returns data about all users within the company
UsersAccess Returns data about all users within the company access.
UserSettings List settings of an authorized user.
UsersFollowers Lists the followers of a specific user.
UsersPermissions Lists the followers of a specific user.
UsersRoleAssignments Lists role assignments for a user.
UsersRoleSettings Lists the settings of user assigned role.

Activities

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Activity Id.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
AssignedToUserId Integer True No AssignedToUserId.
Attendees String False No Attendees of the Activity This can be either your existing Pipedrive contacts or an external email address.
BusyFlag Boolean True No Set the Activity as Busy or Free.
CalendarSync String True No CalendarSync.
CompanyId Integer True No CompanyId.
MeetingClient String True No MeetingClient.
MeetingId String True No MeetingId.
MeetingUrl String True No MeetingUrl.
CreatedByUserId Integer True No CreatedByUserId.
DealDropboxBcc String True No DealDropboxBcc.
DealId Integer False Deals.Id No The ID of the Deal this Activity is associated with.
DealTitle String True No DealTitle.
Done Boolean True No Whether the Activity is done or not 0 = Not done 1 = Done If omitted returns both Done and Not done activities.
DueDate Date False No Due date of the Activity Format YYYY-MM-DD
DueTime Time False No Due time of the Activity in UTC Format HH:MM
Duration Time True No Duration of the Activity Format HH:MM
FileCleanName String True No FileCleanName.
FileId String True Files.Id No FileId.
FileUrl String True No FileUrl.
GcalEventId String True No GcalEventId.
GoogleCalendarEtag String True No GoogleCalendarEtag.
GoogleCalendarId String True No GoogleCalendarId.
LastNotificationTime Datetime True No LastNotificationTime.
LastNotificationUserId Integer True No LastNotificationUserId.
LeadId String True Leads.Id No LeadId.
Location String False No The address of the Activity.
AdminAreaLevel1 String True No AdminAreaLevel1.
AdminAreaLevel2 String True No AdminAreaLevel2.
LocationCountry String True No LocationCountry.
FormattedAddress String True No FormattedAddress.
LocationLat Double True No LocationLat.
LocationLocality String True No LocationLocality.
LocationLong Double True No LocationLong.
PostalCode String True No PostalCode.
LocationRoute String True No LocationRoute.
StreetNumber String True No StreetNumber.
Sublocality String True No Sublocality.
Subpremise String True No Subpremise.
MarkedAsDoneTime Datetime True No MarkedAsDoneTime.
Note String False No Note of the Activity HTML format.
NotificationLanguageId Integer True No NotificationLanguageId.
OrgId Integer False No The ID of the Organization this Activity is associated with.
OrgName String True No OrgName.
OwnerName String True No OwnerName.
Participants String False No List of multiple Persons participants this Activity is associated with If omitted single participant from person_id field is used.
PersonDropboxBcc String True No PersonDropboxBcc.
PersonId Integer False Persons.Id No The ID of the Person this Activity is associated with.
PersonName String True No PersonName.
PublicDescription String False No Additional 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.
RecMasterActivityId String True No RecMasterActivityId.
RecRule String True No RecRule.
RecRuleExtension String True No RecRuleExtension.
ReferenceId Integer True No ReferenceId.
ReferenceType String True No ReferenceType.
Series String True No Series.
SourceTimezone String True No SourceTimezone.
Subject String False No Subject of the Activity.
Type String True No Type 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.
UpdateTime Datetime True No UpdateTime.
UpdateUserId Integer True No The 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.
UserId Integer False Users.Id No UserId.
FilterId Integer False Yes The ID of the Filter to use.
StartDate String False Yes Use the Activity due date where you wish to begin fetching Activities from Insert due date in YYYY-MM-DD format.
EndDate String False Yes Use the Activity due date where you wish to stop fetching Activities from Insert due date in YYYY-MM-DD format.

Return to Top

ActivitiesAttendees

Name Type ReadOnly References FilterOnly Description
ActivitiesId [KEY] Integer True Activities.Id No Activities ID.
EmailAddress String False No EmailAddress.
IsOrganizer Integer True No IsOrganizer.
Name String True No Name.
PersonId Integer False Persons.Id No PersonId.
Status String True No Status.
UserId String True Users.Id No UserId.
Type String False Yes Type 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.
Done Boolean False Yes Whether the Activity is done or not. 0 = Not done 1 = Done. If omitted, returns both Done and Not done activities.
FilterId Integer False Yes The ID of the Filter to use.
StartDate String False Yes Use the Activity due date where you wish to begin fetching Activities from Insert due date in YYYY-MM-DD format.
EndDate String False Yes Use the Activity due date where you wish to stop fetching Activities from Insert due date in YYYY-MM-DD format.

Return to Top

ActivitiesParticipants

Name Type ReadOnly References FilterOnly Description
PersonId [KEY] Integer False No PersonId
ActivitiesId Integer True Activities.Id No Activities ID.
PrimaryFlag Boolean False No PrimaryFlag
Type String False Yes Type 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
Done Boolean False Yes Whether the Activity is done or not 0 = Not done 1 = Done If omitted returns both Done and Not done activities
FilterId Integer False Yes The ID of the Filter to use
StartDate String False Yes Use the Activity due date where you wish to begin fetching Activities from Insert due date in YYYY-MM-DD format
EndDate String False Yes Use the Activity due date where you wish to stop fetching Activities from Insert due date in YYYY-MM-DD format
UserId String False Yes UserId

Return to Top

ActivityFields

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
AddVisibleFlag Boolean True No AddVisibleFlag.
BulkEditAllowed Boolean True No BulkEditAllowed.
DetailsVisibleFlag Boolean True No DetailsVisibleFlag.
EditFlag Boolean True No EditFlag.
FieldType String True No FieldType.
FilteringAllowed Boolean True No FilteringAllowed.
ImportantFlag Boolean True No ImportantFlag.
IndexVisibleFlag Boolean True No IndexVisibleFlag.
Key String True No Key.
LastUpdatedByUserId String True No LastUpdatedByUserId.
MandatoryFlag Boolean True No MandatoryFlag.
Name String True No Name.
Options String True No Options.
OrderNr Integer True No OrderNr.
SearchableFlag Boolean True No SearchableFlag.
SortableFlag Boolean True No SortableFlag.
UpdateTime Datetime True No UpdateTime.

Return to Top

ActivityFieldsOptions

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No Id.
Label String True No Label.

Return to Top

ActivityTypes

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No The ID of the ActivityType.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
Color String False No A designated color for the ActivityType in 6-character HEX format.
IconKey String False No Icon graphic to use for representing this activity type.
IsCustomFlag Boolean True No IsCustomFlag.
KeyString String True No KeyString.
Name String False No The name of the ActivityType.
OrderNr Integer False No An order number for this ActivityType. Order numbers should be used to order the types in the ActivityType selections.
UpdateTime Datetime True No UpdateTime.

Return to Top

CallLogs

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No ID.
ActivityId Integer False No ActivityId.
CompanyId Integer True No CompanyId.
DealId Integer False No The ID of the Deal this call is associated with.
Duration String False No Call duration in seconds.
EndTime Datetime False No The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS
FromPhoneNumber String False No The number that made the call.
HasRecording Boolean True No HasRecording.
Note String False No Note for the call log in HTML format.
OrgId Integer False No The ID of the Organization this call is associated with.
Outcome String False No Describes the outcome of the call.
PersonId Integer False No The ID of the Person this call is associated with.
StartTime Datetime False No The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS
Subject String False No Name of the activity this call is attached to.
ToPhoneNumber String False No The number called.
UserId Integer False No The ID of the owner of the call log.
LeadId String False Yes Only used for insert. The ID of the lead the call log is associated with in UUID format (optional).

Return to Top

Currencies

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No ActiveFlag.
Code String True No Code.
DecimalPoints Integer True No DecimalPoints.
IsCustomFlag Boolean True No IsCustomFlag.
Name String True No Name.
Symbol String True No Symbol.
Term String False Yes Optional search term that is searched for from currency's name and/or code.

Return to Top

CurrentUsers

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the user.
Activated Boolean True No Activated.
ActiveFlag Boolean True No Whether the user is active or not.
Created Datetime True No Created.
DefaultCurrency String True No DefaultCurrency.
Email String True No Email of the user.
Hascreatedcompany Boolean True No Hascreatedcompany.
IconUrl String True No IconUrl.
IsAdmin Integer True No IsAdmin.
IsYou Boolean True No IsYou.
Lang Integer True No Lang.
LastLogin Datetime True No LastLogin.
Locale String True No Locale.
Modified Datetime True No Modified.
Name String True No Name of the user.
Phone String True No Phone.
RoleId Integer True No ID of the role.
TimezoneName String True No TimezoneName.
TimezoneOffset String True No TimezoneOffset.
Access String True No The access given to the user.
CompanyId Integer True No Company Id.
CompanyName String True No Company Name.
CompanyDomain String True No Company Domain.
CompanyCountry String True No Company Country.
CompanyIndustry String True No Company Industry.
LanguageCode String True No Language Code.
CountryCode String True No Country Code.

Return to Top

DealFields

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the field.
ActiveFlag Boolean True No Whether the field is available in 'add new' modal or not (both in web and mobile app).
AddTime Datetime True No AddTime.
AddVisibleFlag Boolean False No AddVisibleFlag.
BulkEditAllowed Boolean True No BulkEditAllowed.
DetailsVisibleFlag Boolean True No DetailsVisibleFlag.
EditFlag Boolean True No EditFlag.
FieldType String False No Type of the field.
FilteringAllowed Boolean True No FilteringAllowed.
ImportantFlag Boolean True No ImportantFlag.
IndexVisibleFlag Boolean True No IndexVisibleFlag.
Key String True No Key.
LastUpdatedByUserId String True No LastUpdatedByUserId.
MandatoryFlag Boolean True No MandatoryFlag.
Name String False No Name of the field.
Options String False No Options.
OrderNr Integer True No OrderNr.
SearchableFlag Boolean True No SearchableFlag.
SortableFlag Boolean True No SortableFlag.
UpdateTime Datetime True No UpdateTime.

Return to Top

DealFieldsOptions

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No Id.
Label String False No Label.
Name String False Yes Name of the field.
FieldType String False Yes Type of the field.
AddVisibleFlag Boolean False Yes AddVisibleFlag.

Return to Top

Deals

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Deals id.
Active Boolean True No Active.
ActivitiesCount Integer True No Activities Count.
AddTime Datetime False No AddTime.
CcEmail String True No Cc Email.
CloseTime String True No Close Time.
CreatorActiveFlag Boolean True No Creator ActiveFlag.
CreatorEmail String True No Creator Email.
CreatorHasPic Boolean True No Creator HasPic.
CreatorId Integer True No Creator Id.
CreatorName String True No Creator Name.
CreatorPicHash String True No CreatorPicHash.
Creatorvalue Integer True No Creatorvalue.
Currency String False No Currency.
CustomeField String True No CustomeField you will get the result of this column only when criteria filter title is used.
Deleted Boolean True No Deleted.
DoneActivitiesCount Integer True No Done Activities Count.
EmailMessagesCount Integer True No Email Messages Count.
ExpectedCloseDate Date False No Expected Close Date.
FilesCount Integer True No Files Count.
FirstWonTime Datetime True No First Won Time.
FollowersCount Integer True No Followers Count.
FormattedValue String True No Formatted Value.
FormattedWeightedValue String True No Formatted Weighted Value.
Label String True No Label.
LastActivityDate String True No Last Activity Date.
LastActivityId String True No Last Activity Id.
LastIncomingMailTime Datetime True No Last Incoming MailTime.
LastOutgoingMailTime Datetime True No Last OutgoingMail Time.
LostReason String False No Lost Reason.
LostTime String True No Lost Time.
NextActivityDate Date True No Next Activity Date.
NextActivityDuration Time True No Next Activity Duration.
NextActivityId Integer True No Next Activity Id.
NextActivityNote String True No Next Activity Note.
NextActivitySubject String True No Next Activity Subject.
NextActivityTime Time True No Next Activity Time.
NextActivityType String True No Next Activity Type.
NotesCount Integer True No NotesCount.
Notes String True No Notes.
OrgHidden Boolean True No Org Hidden.
OrgActiveFlag Boolean True No Org ActiveFlag.
OrgAddress String True No Org Address.
OrgCcEmail String True No Org CcEmail.
OrgName String True No Org Name.
OrgOwnerId Integer True No Org OwnerId.
OrgPeopleCount Integer True No Org PeopleCount.
OrgValue Integer True No Org Value.
OwnerName String True No Owner Name.
OwnerId String True No Owner Id you will get the result of this column only when criteria filter title is used.
ParticipantsCount Integer True No Participants Count.
PersonHidden Boolean True No Person Hidden.
PersonActiveFlag Boolean True No Person Active Flag.
PersonEmail String True No Person Email.
PersonName String True No Person Name.
PersonPhone String True No Person Phone.
Personvalue Integer True No Personvalue.
PipelineId Integer True No PipelineId.
Probability String True No Probability.
ProductsCount Integer True No Products Count.
RottenTime String True No RottenTime.
ResultScore String True No Result score you will get the result of this column only when criteria filter title is used.
StageChangeTime Datetime True No Stage Change Time.
StageId Integer True Stages.Id No StageId.
StageName String True No StageName.
StageOrderNr Integer True No Stage OrderNr.
Status String False No Status.
Title String False No Title.
Type String True No Type you will get the result of this column only when criteria filter title is used.
UndoneActivitiesCount Integer True No Undone Activities Count.
UpdateTime Datetime True No Update Time.
UserActiveFlag Boolean True No User ActiveFlag.
UserEmail String True No User Email.
UserHasPic Boolean True No User HasPic.
UserId Integer False No User Id.
UserName String True No User Name.
UserPicHash String True No User PicHash.
Uservalue Integer True No User value.
Value Integer False No Value of the deal.
VisibleTo String False No Visibility of the deal.
WeightedValue Integer True No Visible To.
WeightedValueCurrency String True No Weighted Value Currency.
OrderOfStages Integer True No You will get the result of this column only when criteria filter id is used.
AverageTimeToWonY Integer True No You will get the result of this column only when criteria filter id is used.
AverageTimeToWonM Integer True No You will get the result of this column only when criteria filter id is used.
AverageTimeToWond Integer True No You will get the result of this column only when criteria filter id is used.
AverageTimeToWonh Integer True No You will get the result of this column only when criteria filter id is used.
AverageTimeToWons Integer True No You will get the result of this column only when criteria filter id is used.
AverageTimeToWoni Integer True No You will get the result of this column only when criteria filter id is used.
AverageTotalSeconds Integer True No You will get the result of this column only when criteria filter id is used.
AverageStageProgress Integer True No You will get the result of this column only when criteria filter id is used.
AgeY Integer True No You will get the result of this column only when criteria filter id is used.
AgeM Integer True No You will get the result of this column only when criteria filter id is used.
Aged Integer True No You will get the result of this column only when criteria filter id is used.
Ageh Integer True No You will get the result of this column only when criteria filter id is used.
Ages Integer True No You will get the result of this column only when criteria filter id is used.
Agei Integer True No You will get the result of this column only when criteria filter id is used.
AgeTotalSeconds Integer True No You will get the result of this column only when criteria filter id is used.
WonTime Datetime True No Won time.
FilterId Integer False Yes Filter Id
OwnedByYou Integer False Yes Owned By You
PersonId Integer False Yes Person Id. Only used when performing INSERT or UPDATE operation.
OrgId Integer False Yes Org Id. Only used when performing INSERT or UPDATE operation.

Return to Top

DealsActivities

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No Active Flag.
AddTtime Datetime True No Add Ttime.
AssignedToUserId Integer True No Assigned To UserId.
Attendees String True No Attendees.
BusyFlag Boolean True No BusyFlag.
IncludeContext String True No Include Context.
CompanyId Integer True No Company Id.
MeetingClient String True No Meeting Client.
MeetingId String True No Meeting Id.
MeetingUrl String True No Meeting Url.
CreatedByUserId Integer True No CreatedBy UserId.
DealDropboxBcc String True No Deal Dropbox Bcc.
DealId Integer True No Deal Id.
DealTitle String True No Deal Title.
Done Boolean True No Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
DueDate Date True No Due Date.
DueTime Time True No Due Time.
Duration Time True No Duration.
FileCleanName String True No FileCleanName.
FileId String True No FileId.
FileUrl String True No FileUrl.
EventId String True No eventId.
CalendarEtag String True No CalendarEtag.
CalendarId String True No Calendar Id.
NotificationTime Datetime True No Notification Time.
NotificationUserId Integer True No Notification UserId.
LeadId String True No Lead Id.
Location String True No Location.
AreaLevel1 String True No AreaLevel1.
AreaLevel2 String True No AreaLevel2.
Country String True No Country.
FormattedAddress String True No FormattedAddress.
Lat Double True No Lat.
Locality String True No Locality.
Long Double True No Long.
PostalCode String True No PostalCode.
Route String True No Route.
StreetNumber String True No StreetNumber.
Sublocality String True No Sublocality.
Subpremise String True No Subpremise.
MarkedAsDoneTime Datetime True No MarkedAsDoneTime.
Note String True No Note.
NotificationLanguageId Integer True No NotificationLanguageId.
OrgId Integer True No OrgId.
OrgName String True No OrgName.
OwnerName String True No OwnerName.
Participants String True No Participants.
PersonDropboxBcc String True No Person Dropbox Bcc.
PersonId Integer True No PersonId.
PersonName String True No PersonName.
PublicDescription String True No PublicDescription.
MasterActivityId String True No MasterActivityId.
Rule String True No Rule.
RuleExtension String True No RuleExtension.
ReferenceId Integer True No ReferenceId.
ReferenceType String True No ReferenceType.
Series String True No Series.
SourceTimezone String True No SourceTimezone.
Subject String True No Subject.
Type String True No Type.
UpdateTime Datetime True No UpdateTime.
UpdateUserId Integer True No UpdateUserId.
UserId Integer True No UserId.
Exclude String False Yes A comma-separated string of activity IDs to exclude from result.

Return to Top

DealsActivitiesAttendees

Name Type ReadOnly References FilterOnly Description
DealId Integer True No Deal Id.
EmailAddress String False No EmailAddress.
IsOrganizer Integer True No IsOrganizer.
Name String True No Name.
PersonId Integer False Persons.Id No PersonId.
Status String True No Status.
UserId String True Users.Id No UserId.
Done Boolean False Yes Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
Exclude String False Yes A comma-separated string of activity IDs to exclude from result.

Return to Top

DealsActivitiesParticipants

Name Type ReadOnly References FilterOnly Description
DealId Integer True No Deal Id.
PersonId [KEY] Integer False No PersonId.
PrimaryFlag Boolean False No PrimaryFlag.
Done Boolean False Yes Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
Exclude String False Yes A comma-separated string of activity IDs to exclude from result.

Return to Top

DealsFiles

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the deal.
ActiveFlag Boolean True No Active Flag.
ActivityId String True No Activity Id.
AddTime Datetime True No AddTime.
Cid String True No Cid.
DealId String True No Deal Id.
DealName String True No DealName.
Description String True No Description.
FileName String True No File Name.
FileSize Integer True No File Size.
FileType String True No File Type.
InlineFlag Boolean True No Inline Flag.
LogId String True No Log Id.
MailMessageId String True No MailMessage Id.
MailTemplateId String True No MailTemplate Id.
Name String True No Name.
OrgId Integer True No Org Id.
OrgName String True No Org Name.
PeopleName String True No People Name.
PersonId String True No PersonId.
PersonName String True No Person Name.
ProductId String True No Product Id.
ProductName String True No Product Name.
RemoteId String True No Remote Id.
RemoteLocation String True No Remote Location.
S3Bucket String True No S3Bucket.
UpdateTime Datetime True No Update Time.
Url String True No Url.
UserId Integer True No UserId.
LeadId String True No Lead Id.
LeadName String True No Lead Name.

Return to Top

DealsFollowers

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
AddTime Datetime True No AddTime.
UserId Integer False Users.Id No User Id.
DealId Integer True Deals.Id No Deal Id.

Return to Top

DealsMailMessages

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No id.
AccountId String True No AccountId.
AddTime Datetime True No addTime.
Bcc String True No Bcc.
BodyUrl String True No bodyUrl.
Cc String True No cc.
CompanyId Integer True No companyId.
DeletedFlag Integer True No DeletedFlag.
Draft String True No Draft.
DraftFlag Integer True No DraftFlag.
ExternalDeletedFlag Integer True No ExternalDeletedFlag.
From String True No From.
AttachmentsFlag Integer True No AttachmentsFlag.
BodyFlag Integer True No BodyFlag.
InlineAttachmentsFlag Integer True No InlineAttachmentsFlag.
RealAttachmentsFlag Integer True No RealAttachmentsFlag.
ItemType String True No ItemType.
TrackingEnabledFlag Integer True No TrackingEnabledFlag.
ThreadId Integer True No ThreadId.
TrackingStatus String True No TrackingStatus.
MessageTime String True No MessageTime.
MessageId String True No MessageId.
NylasId String True No NylasId.
ReadFlag Integer True No ReadFlag.
S3Bucket String True No S3Bucket.
S3BucketPath String True No S3BucketPath.
SentFlag Integer True No SentFlag.
SentFromPipedriveFlag Integer True No SentFromPipedriveFlag.
SmartBccFlag Integer True No SmartBccFlag.
Snippet String True No Snippet.
Subject String True No Subject.
SyncedFlag Integer True No SyncedFlag.
TemplateId String True No TemplateId.
Timestamp Datetime True No Timestamp.
To String True No To.
UpdateTime Datetime True No UpdateTime.
UserId Integer True No UserId.
WriteFlag Boolean True No writeFlag.
Object String True No Object.

Return to Top

DealsMailMessagesBcc

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

DealsMailMessagesCc

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

DealsMailMessagesFrom

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

DealsMailMessagesTo

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

DealsParticipants

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
AddedByactiveFlag Boolean True No AddedByactiveFlag.
AddedByemail String True No AddedByemail.
AddedByhasPic Integer True No AddedByhasPic.
AddedByid Integer True No AddedByid.
AddedByname String True No AddedByname.
AddedBypicHash String True No AddedBypicHash.
AddedByvalue Integer True No Added_byvalue.
PersonActiveFlag Boolean True No PersonActiveFlag.
ActivitiesCount Integer True No ActivitiesCount.
PersonAddTime Datetime True No AddTime.
CcEmail String True No CcEmail.
ClosedDealsCount Integer True No ClosedDealsCount.
CompanyId Integer True No CompanyId.
DoneActivitiesCount Integer True No DoneActivitiesCount.
Email String True No Email.
EmailMessagesCount Integer True No EmailMessagesCount.
FilesCount Integer True No FilesCount.
FirstChar String True No FirstChar.
FirstName String True No FirstName.
FollowersCount Integer True No FollowersCount.
Personlabel String True No Personlabel.
LastActivityDate Date True No LastActivityDate.
LastActivityId Integer True No LastActivityId.
LastincomingMailTime String True No LastincomingMailTime.
Lastname String True No Lastname.
LastoutgoingMailTime String True No LastoutgoingMailTime.
LostdealsCount Integer True No LostdealsCount.
Name String True No Name.
NextActivityDate Date True No nextActivityDate.
NextActivityId Integer True No nextActivityId.
NextActivityTime String True No nextActivityTime.
NotesCount Integer True No NotesCount.
OpenDealsCount Integer True No OpenDealsCount.
OrgActiveFlag Boolean True No OrgActiveFlag.
OrgAddress String True No OrgAddress.
OrgCcEmail String True No OrgCcEmail.
OrgName String True No OrgName.
OrgownerId Integer True No OrgownerId.
OrgpeopleCount Integer True No OrgpeopleCount.
OrgId Integer True No OrgId.
OwnerActiveFlag Boolean True No OwnerActiveFlag.
OwnerEmail String True No OwnerEmail.
OwnerHasPic Integer True No OwnerHasPic.
OwnerId Integer True No OwnerId.
OwnerName String True No OwnerName.
OwnerPicHash String True No OwnerPicHash.
OwnerValue Integer True No OwnerValue.
ParticipantClosedDealsCount Integer True No ClosedDealsCount.
ParticipantOpenDealsCount Integer True No OpenDealsCount.
Phone String True No Phone.
PictureId String True No PictureId.
RelatedclosedDealsCount Integer True No RelatedclosedDealsCount.
RelatedlostDealsCount Integer True No RelatedlostDealsCount.
RelatedopenDealsCount Integer True No RelatedopenDealsCount.
RelatedwonDealsCount Integer True No RelatedwonDealsCount.
SyncNeeded Boolean True No SyncNeeded.
UndoneActivitiesCount Integer True No UndoneActivitiesCount.
UpdateTime Datetime True No UpdateTime.
VisibleTo String True No visibleTo.
WonDealsCount Integer True No WonDealsCount.
PersonIdActiveFlag Boolean True No PersonactiveFlag.
Personemail String True No Personemail.
Personname String True No Personname.
Personphone String True No Personphone.
PersonValues Integer False No PersonValues.
ItemDealId Integer True Deals.id No ItemDealId.
ItemTitle String True No ItemTitle.
ItemId Integer True No ItemId.
ItemType String True No ItemType.
PersonId Integer False Persons.Id No Person Id.
PersonOrgName String True No Person OrgName.
PersonOwnerName String True No Person OwnerName.

Return to Top

DealsParticipantsEmail

Name Type ReadOnly References FilterOnly Description
DealsParticipantsId [KEY] Integer True DealsParticipants.Id No Id.
Label String True No Label.
Value String True No Email.
Primary Boolean True No Boolean value Primary.

Return to Top

DealsParticipantsPersonEmail

Name Type ReadOnly References FilterOnly Description
DealsParticipantsId [KEY] Integer True DealsParticipants.Id No Id.
Label String True No Label.
Value String True No Email.
Primary Boolean True No Boolean value Primary.

Return to Top

DealsParticipantsPersonPhone

Name Type ReadOnly References FilterOnly Description
DealsParticipantsId [KEY] Integer True DealsParticipants.Id No Id.
Label String True No Label.
Value String True No Value.
Primary Boolean True No Boolean value Primary.

Return to Top

DealsParticipantsPhone

Name Type ReadOnly References FilterOnly Description
DealsParticipantsId [KEY] Integer True DealsParticipants.Id No Id.
Label String True No Label.
Value String True No Value.
Primary Boolean True No Boolean value Primary.

Return to Top

DealsPermittedUsers

Name Type ReadOnly References FilterOnly Description
Data String True No Data.
Id String False Yes Id.

Return to Top

DealsPersonEmails

Name Type ReadOnly References FilterOnly Description
DealsId [KEY] Integer True Deals.Id No Deals ID.
Label String True No Label.
Value String True No Value.
Primary Boolean True No Primary.

Return to Top

DealsPersonPhone

Name Type ReadOnly References FilterOnly Description
DealsId [KEY] Integer True Deals.Id No Deals ID.
label String True No Label.
Value String True No Value.
Primary Boolean True No Primary.

Return to Top

DealsPersons

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
DealId Integer True No Deal Id.
ActivitiesCount Integer True No ActivitiesCount.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
CcEmail String True No CcEmail.
ClosedDealsCount Integer True No ClosedDealsCount.
CompanyId Integer True No CompanyId.
DoneActivitiesCount Integer True No DoneActivitiesCount.
Email String True No Email.
EmailMessagesCount Integer True No EmailMessagesCount.
FilesCount Integer True No FilesCount.
Label Integer True No label.
LastActivityDate Date True No LastActivityDate.
LastActivityId Integer True No LastActivityId.
LastincomingMailTime String True No LastincomingMailTime.
Lastname String True No Lastname.
LastoutgoingMailTime String True No LastoutgoingMailTime.
LostdealsCount Integer True No LostdealsCount.
Name String True No Name.
NextActivityDate Date True No nextActivityDate.
NextActivityId Integer True No nextActivityId.
NextActivityTime String True No nextActivityTime.
NotesCount Integer True No NotesCount.
OpenDealsCount Integer True No OpenDealsCount.
OrgActiveFlag Boolean True No OrgActiveFlag.
OrgAddress String True No OrgAddress.
OrgCcEmail String True No OrgCcEmail.
OrgName String True No OrgName.
OrgownerId Integer True No OrgownerId.
OrgpeopleCount Integer True No OrgpeopleCount.
OrgId Integer True No OrgId.
OwnerActiveFlag Boolean True No OwnerActiveFlag.
OwnerEmail String True No OwnerEmail.
OwnerHasPic Integer True No OwnerHasPic.
OwnerId Integer True No OwnerId.
OwnerName String True No OwnerName.
OwnerPicHash String True No OwnerPicHash.
OwnerValue Integer True No OwnerValue.
ParticipantClosedDealsCount Integer True No ClosedDealsCount.
ParticipantOpenDealsCount Integer True No OpenDealsCount.
Phone String True No Phone.
PictureActiveFlag Boolean True No PictureActiveFlag.
PictureaddTime Datetime True No PictureaddTime.
PictureaddedByUserId Integer True No PictureaddedByUserId.
PictureItemId Integer True No PictureItemId.
PictureitemType String True No PictureitemType.
Picture128 String True No Picture128.
Picture512 String True No Picture512.
PictureupdateTime String True No PictureupdateTime.
Picturevalue Integer True No Picturevalue.
PictureId String True No PictureId.
RelatedclosedDealsCount Integer True No RelatedclosedDealsCount.
RelatedlostDealsCount Integer True No RelatedlostDealsCount.
RelatedopenDealsCount Integer True No RelatedopenDealsCount.
RelatedwonDealsCount Integer True No RelatedwonDealsCount.
UndoneActivitiesCount Integer True No UndoneActivitiesCount.
UpdateTime Datetime True No UpdateTime.
VisibleTo String True No visibleTo.
WonDealsCount Integer True No WonDealsCount.
FirstName String True No First Name.
FollowersCount Integer True No Followers Count.
PrimaryEmail String True No Primary Email.
FirstChar String True No First Char.
MarketingStatus String True No Marketing Status.

Return to Top

DealsPersonsEmail

Name Type ReadOnly References FilterOnly Description
DealsPersonsId [KEY] Integer True DealsPersons.Id No Id.
Label String True No Label.
Value String True No Email.
Primary Boolean True No Boolean value Primary.

Return to Top

DealsPersonsPhone

Name Type ReadOnly References FilterOnly Description
DealsPersonsId [KEY] Integer True DealsPersons.Id No Id.
Label String True No Label.
Value String True No Value.
Primary Boolean True No Boolean value Primary.

Return to Top

DealsProducts

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
Comments String False No Any textual comment associated with this product-deal attachment.
Currency String True No Currency.
DealId Integer True Deals.Id No Deal id.
DiscountPercentage Double True No Discount %.
Duration Integer True No Duration of the product.
DurationUnit String True No DurationUnit.
EnabledFlag Boolean False No Whether the product is enabled on the deal or not.
ItemPrice Integer False No Price at which this product will be added to the deal.
LastEdit String True No LastEdit.
Name String True No Name.
OrderNr Integer True No OrderNr.
ProductActiveFlag Boolean True No Product ActiveFlag.
ProductAddTime Datetime True No Product AddTime.
Category String True No Category.
code String True No Code.
description String True No Description.
FilesCount String True No FilesCount.
FirstChar String True No FirstChar.
ProductsId Integer True No ProductsId.
ProductName String True No ProductName.
OwnerActiveFlag Boolean True No OwnerActiveFlag.
OwnerEmail String True No OwnerEmail.
OwnerHasPic Boolean True No OwnerHasPic.
OwnerId Integer True No OwnerId.
OwnerName String True No OwnerName.
OwnerPicHash String True No OwnerPicHash.
OwnerValue Integer True No OwnerValue.
EURCost Integer True No EURCost.
EURCurrency String True No EURCurrency.
EURId Integer True No EURId.
EUROverheadCost Integer True No EUROverheadCost.
EURPrice Integer True No EURPrice.
EURProductId Integer True No EURProductId.
Selectable Boolean True No selectable.
ProductTax Integer True No ProductTax.
unit String True No unit.
UpdateTime Datetime True No UpdateTime.
VisibleTo String True No VisibleTo.
ProductId Integer False Products.id No ID of the product that will be attached.
VariationId String False No ID of the product variation.
Quantity Integer False No How many items of this product will be added to the deal.
QuantityFormatted String True No QuantityFormatted.
Sum Double True No Sum.
SumFormatted String True No SumFormatted.
SumNoDiscount Integer True No SumNoDiscount.
Tax Integer False No Tax percentage.

Return to Top

DealsSummary

Name Type ReadOnly References FilterOnly Description
TotalCount Integer True No Total Count.
Totalvalue Double True No Total value.
TotalValueFormatted String True No Total Value Formatted.
TotalWeightedValue Double True No Total Weighted Value.
TotalWeightedValueFormatted String True No Total Weighted Value Formatted.
EURCount Integer True No EUR Count.
EURValue Integer True No EUR Value.
EURConverted Double True No EUR Converted.
EURConvertedFormatted String True No EUR Converted Formatted.
EURFormatted String True No EUR Formatted.
USDCount Integer True No USD Count.
USDValue Integer True No USD Value.
USDConverted Integer True No USD Converted.
USDConvertedFormatted String True No USD Converted Formatted.
USDFormatted String True No USD Formatted.
WeightedEURCount Integer True No Weighted EUR Count.
WeightedEURValue Integer True No Weighted EUR Value.
WeightedEURValueFormatted String True No Weighted EUR Value Formatted.
WeightedUSDCount Integer True No Weighted USD Count.
WeightedUSD Integer True No Weighted USD.
WeightedUSDFormatted String True No Weighted USD Formatted.
FilterId Integer False Yes Filter Id.
UserId Integer False Yes User Id.
StageId Integer False Yes Stage Id.
Status String False Yes Status.

Return to Top

DealsTimeline

Name Type ReadOnly References FilterOnly Description
Deals String True No Deals
PeriodEnd Datetime True No Period End
PeriodStart Date True No Period Start
Count Integer True No Count
OpenCount Integer True No open Count
OpenValuesEUR Integer True No open Values EUR
ValuesEUR Integer True No Values EUR
ValuesUSD Integer True No Values USD
WeightedOpenValuesEUR Integer True No Weighted Open Values EUR
WeightedValuesEUR Integer True No Weighted Values EUR
WeightedValuesUSD Integer True No Weighted Values USD
WonCount Integer True No Won Count
WonValuesUSD Integer True No Won Values USD
StartDate Date False Yes Date where the first interval starts. Format: YYYY-MM-DD.
IntervalType String False Yes Type Of Interval.
Amount Integer False Yes The number of given intervals, starting from start_date, to fetch E.g 3 months.
FieldKey String False Yes The date field key which deals will be retrieved from.
UserId Integer False Yes User id.
FilterId Integer False Yes Type Of Interval.
ExcludeDeals Integer False Yes Whether to exclude deals list 1 or not 0.
ConvertCurrency String False Yes 3-letter currency code of any of the supported currencies.
PipelineId Integer False Yes Pipeline Id.

Return to Top

DealsTimelineDeals

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
Active Boolean True No Active.
ActivitiesCount Integer True No ActivitiesCount.
AddTime Datetime True No AddTime.
CcEmail String True No CcEmail.
CloseTime String True No CloseTime.
CreatorUserId Integer True No CreatorUserId.
Currency String True No Currency.
Deleted Boolean True No Deleted.
DoneActivitiesCount Integer True No DoneActivitiesCount.
EmailMessagesCount Integer True No EmailMessagesCount.
ExpectedCloseDate Date True No ExpectedCloseDate.
FilesCount Integer True No FilesCount.
FirstWonTime Datetime True No FirstWonTime.
FollowersCount Integer True No FollowersCount.
FormattedValue String True No FormattedValue.
FormattedWeightedValue String True No FormattedWeightedValue.
Label String True No Label.
LastActivityDate String True No LastActivityDate.
LastActivityId String True No LastActivityId.
LastncomingMailTime Datetime True No LastncomingMailTime.
LastoutgoingMailTime Datetime True No LastoutgoingMailTime.
Lostreason String True No Lostreason.
LostTime String True No LostTime.
NextActivityDate Date True No NextActivityDate.
NextActivityDuration Time True No NextActivityDuration.
NextActivityId Integer True No NextActivityId.
NextActivityNote String True No NextActivityNote.
NextActivitySubject String True No NextActivitySubject.
NextActivityTime Time True No NextActivityTime.
NextActivityType String True No NextActivityType.
NotesCount Integer True No NotesCount.
OrgHidden Boolean True No OrgHidden.
OrgId Integer True No OrgId.
OrgName String True No OrgName.
OwnerName String True No OwnerName.
ParticipantsCount Integer True No ParticipantsCount.
PersonHidden Boolean True No PersonHidden.
PersonId Integer True No PersonId.
PersonName String True No PersonName.
PipelineId Integer True Pipelines.Id No PipelineId.
Probability String True No Probability.
ProductsCount Integer True No ProductsCount.
RottenTime String True No RottenTime.
StageChangeTime Datetime True No StageChangeTime.
StageId Integer True No StageId.
StageOrderNr Integer True No StageOrderNr.
Status String True No Status.
Title String True No Title.
UndoneActivitiesCount Integer True No UndoneActivitiesCount.
UpdateTime Datetime True No UpdateTime.
UserId Integer True Users.Id No UserId.
Value Integer True No Value.
VisibleTo String True No VisibleTo.
WeightedValue Integer True No WeightedValue.
WeightedValueCurrency String True No WeightedValueCurrency.
WonTime Datetime True No WonTime.
StartDate Date False Yes Date where the first interval starts. Format: YYYY-MM-DD
IntervalType String False Yes Type Of Interval.
Amount Integer False Yes The number of given intervals, starting from start_date, to fetch E.g 3 months.
FieldKey String False Yes The date field key which deals will be retrieved from.
FilterId Integer False Yes Type Of Interval.
ExcludeDeals Integer False Yes Whether to exclude deals list 1 or not 0.
ConvertCurrency String False Yes 3-letter currency code of any of the supported currencies.

Return to Top

DealsUpdates

Name Type ReadOnly References FilterOnly Description
Id Integer True No Id.
AccountId String True No AccountId.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
AdditionalData String True No AdditionalData.
AssignedToUserId Integer True No AssignedToUserId.
Attachments String True No Attachments.
Attendees String True No Attendees.
Bcc String True No Bcc.
BodyUrl String True No BodyUrl.
BusyFlag Boolean True No BusyFlag.
IncludeContext String True No IncludeContext.
Cc String True No Cc.
ChangeSource String True No ChangeSource.
UserAgent String True No UserAgent.
CompanyId Integer True No CompanyId.
MeetingClient String True No MeetingClient.
MeetingId String True No MeetingId.
MeetingUrl String True No MeetingUrl.
CreatedByUserId Integer True No CreatedByUserId.
DealDropboxBcc String True No DealDropboxBcc.
DealId Integer True No DealId.
DealTitle String True No DealTitle.
DeletedFlag Integer True No DeletedFlag.
Done Boolean True No Done.
Draft String True No Draft.
DraftFlag Integer True No DraftFlag.
DueDate Date True No DueDate.
DueTime Time True No DueTime.
Duration Time True No Duration.
ExternalDeletedFlag Integer True No ExternalDeletedFlag.
FieldKey String True No FieldKey.
CleanName String True No CleanName.
FileId String True No FileId.
Url String True No Url.
From String True No From.
GcalEventId String True No GcalEventId.
GoogleCalendarEtag String True No GoogleCalendarEtag.
GoogleCalendarId String True No GoogleCalendarId.
AttachmentsFlag Integer True No AttachmentsFlag.
BodyFlag Integer True No BodyFlag.
InlineAttachmentsFlag Integer True No InlineAttachmentsFlag.
RealAttachmentsFlag Integer True No RealAttachmentsFlag.
IsBulkUpdateFlag String True No IsBulkUpdateFlag.
ItemId Integer True No ItemId.
ItemType String True No ItemType.
NotificationTime Datetime True No NotificationTime.
NotificationUserId Integer True No NotificationUserId.
LeadId String True No LeadId.
Location String True No Location.
AdminAreaLevel1 String True No AdminAreaLevel1.
AdminAreaLevel2 String True No AdminAreaLevel2.
Country String True No Country.
FormattedAddress String True No FormattedAddress.
Lat Double True No Lat.
Locality String True No Locality.
Long Double True No Long.
PostalCode String True No PostalCode.
Route String True No Route.
StreetNumber String True No StreetNumber.
Sublocality String True No Sublocality.
Subpremise String True No Subpremise.
LogTime Datetime True No LogTime.
TrackingEnabledFlag Integer True No TrackingEnabledFlag.
MailThreadId Integer True No MailThreadId.
MailTrackingStatus String True No MailTrackingStatus.
MarkedAsDoneTime Datetime True No MarkedAsDoneTime.
MessageTime String True No MessageTime.
MuaMessageId String True No MuaMessageId.
NewValue String True No NewValue.
Note String True No Note.
LanguageId Integer True No LanguageId.
NylasId String True No NylasId.
OldValue Integer True No OldValue.
OrgId Integer True No OrgId.
OrgName String True No OrgName.
OwnerName String True No OwnerName.
Participants String True No Participants.
PersonDropboxBcc String True No PersonDropboxBcc.
PersonId Integer True No PersonId.
PersonName String True No PersonName.
PublicDescription String True No PublicDescription.
ReadFlag Integer True No ReadFlag.
RecActivityId String True No RecActivityId.
RecRule String True No RecRule.
RecRuleExtension String True No RecRuleExtension.
ReferenceId Integer True No ReferenceId.
ReferenceType String True No ReferenceType.
S3Bucket String True No S3Bucket.
S3BucketPath String True No S3BucketPath.
SentFlag Integer True No SentFlag.
SentFromPipedriveFlag Integer True No SentFromPipedriveFlag.
Series String True No Series.
SmartBccFlag Integer True No SmartBccFlag.
Snippet String True No Snippet.
SourceTimezone String True No SourceTimezone.
Subject String True No Subject.
SyncedFlag Integer True No SyncedFlag.
TemplateId String True No TemplateId.
Timestamp Datetime True No Timestamp.
To String True No To.
Type String True No Type.
UpdateTime Datetime True No UpdateTime.
UpdateUserId Integer True No UpdateUserId.
UserId Integer True No UserId.
WriteFlag Boolean True No WriteFlag.
Object String True No Object.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes Item specific updates.

Return to Top

DealsUpdatesAttachments

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No ActiveFlag.
ActivityId String True No ActivityId.
AddTime Datetime True No AddTime.
Cid String True No Cid.
DealName String True No DealName.
DealId Integer True No dealid.
Description String True No Description.
FileName String True No FileName.
FileSize Integer True No FileSize.
FileType String True No FileType.
InlineFlag Boolean True No InlineFlag.
LogId String True No LogId.
MailMessageId String True No MailMessageId.
MailTemplateId String True No MailTemplateId.
Name String True No Name.
OrgId Integer True No OrgId.
OrgName String True No OrgName.
PeopleName String True No PeopleName.
PersonId String True No PersonId.
PersonName String True No PersonName.
ProductId String True No ProductId.
ProductName String True No ProductName.
RemoteId String True No RemoteId.
RemoteLocation String True No RemoteLocation.
S3Bucket String True No S3Bucket.
UpdateTime Datetime True No UpdateTime.
Url String True No Url.
UserId Integer True No UserId.
LeadId Integer True No Lead Id.
LeadName Integer True No Lead Name.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes Item specific updates.

Return to Top

DealsUpdatesAttendees

Name Type ReadOnly References FilterOnly Description
DealId Integer False No Deal Id.
EmailAddress String False No EmailAddress.
IsOrganizer Integer True No IsOrganizer.
Name String True No Name.
Status String True No Status.
UserId String True Users.Id No UserId.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes Item specific updates.

Return to Top

DealsUpdatesBcc

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
DealId Integer False No Deal Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes item specific updates.

Return to Top

DealsUpdatesCc

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
PersonId String True No PersonId.
DealId Integer False No Deal Id.
EmailAddress String True No EmailAddress.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes item specific updates.

Return to Top

DealsUpdatesFrom

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
DealId Integer False No Deal Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.
AllChanges String False Yes Whether to show custom field updates or not
Items String False Yes item specific updates

Return to Top

DealsUpdatesParticipants

Name Type ReadOnly References FilterOnly Description
PersonId [KEY] Integer False No PersonId.
DealId Integer False No Deal Id.
PrimaryFlag Boolean False No PrimaryFlag.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes Item specific updates.

Return to Top

DealsUpdatesTo

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
DealId Integer False No Deal Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes item specific updates.

Return to Top

Files

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the file.
ActiveFlag Boolean True No ActiveFlag.
ActivityId String True No ID of the activity to associate file.
AddTime Datetime True No AddTime.
Cid String True No Cid.
DealId String True No ID of the deal to associate file.
DealName String True No DealName.
Description String False No Description of the file.
FileName String True No FileName.
FileSize Integer True No FileSize.
FileType String True No FileType.
InlineFlag Boolean True No InlineFlag.
LogId String True No LogId.
MailMessageId String True No MailMessageId.
MailTemplateId String True No MailTemplateId.
Name String False No Visible name of the file.
OrgId String True No ID of the organization to associate file.
OrgName String True No OrgName.
PersonId Integer True No ID of the person to associate file.
PersonName String True No PersonName.
ProductId String True No ID of the product to associate file.
ProductName String True No ProductName.
RemoteId String True No RemoteId.
RemoteLocation String True No RemoteLocation.
S3Bucket String True No S3Bucket.
UpdateTime Datetime True No UpdateTime.
Url String True No Url.
UserId Integer True No UserId.
LeadId String True No LeadId.
LeadName String True No LeadName.

Return to Top

FilterHelpers

Name Type ReadOnly References FilterOnly Description
AdminAreaLevel1 String True No AdminAreaLevel1.
AdminAreaLevel2 String True No AdminAreaLevel2.
Country String True No Country.
FormattedAddress String True No FormattedAddress.
Locality String True No Locality.
PostalCode String True No PostalCode.
Route String True No Route.
StreetNumber String True No StreetNumber.
Sublocality String True No Sublocality.
Subpremise String True No Subpremise.
CurrencyNotEqual String True No CurrencyNotEqual.
CurrencyEqual String True No CurrencyEqual.
DateNotEqual String True No DateNotEqual.
DateLessThan String True No DateLessThan.
DateLessThanOrEqual String True No DateLessThanOrEqual.
DateEqual String True No DateEqual.
DateGreaterThan String True No DateGreaterThan.
DateGreaterThanOrEqual String True No DateGreaterThanOrEqual.
DateISNOTNULL String True No DateISNOTNULL.
DateISNULL String True No DateISNULL.
DateRangeNotEqual String True No DateRangeNotEqual.
DateRangeLessThan String True No DateRangeLessThan.
DateRangeLessThanOrEqual String True No DateRangeLessThanOrEqual.
DateRangeEqual String True No DateRangeEqual.
DateRangeGreaterThan String True No DateRangeGreaterThan.
DateRangeGreaterThanOrEqual String True No DateRangeGreaterThanOrEqual.
DateRangeDoesNotEndAt String True No DateRangeDoesNotEndAt.
DateRangeEndsAfter String True No DateRangeEndsAfter.
DateRangeEndsAt String True No DateRangeEndsAt.
DateRangeEndsBefore String True No DateRangeEndsBefore.
DateRangeEndsEAfter String True No DateRangeEndsEAfter.
DateRangeEndsEBefore String True No DateRangeEndsEBefore.
DateRangeincludes String True No DateRangeincludes.
DateRangeISNOTNULL String True No DateRangeISNOTNULL.
DateRangeISNULL String True No DateRangeISNULL.
DealNotEqual String True No DealNotEqual.
DealEqual String True No DealEqual.
DealISNOTNULL String True No DealISNOTNULL.
DealISNULL String True No DealISNULL.
DoubleNotEqual String True No DoubleNotEqual.
DoubleLessThan String True No DoubleLessThan.
DoubleLessThanOrEqual String True No DoubleLessThanOrEqual.
DoubleEqual String True No DoubleEqual.
DoubleGreaterThan String True No DoubleGreaterThan.
DoubleGreaterThanOrEqual String True No DoubleGreaterThanOrEqual.
DoubleISNOTNULL String True No DoubleISNOTNULL.
DoubleISNULL String True No DoubleISNULL.
EnteredStageNotEqual String True No EnteredStageNotEqual.
EnteredStageLessThan String True No EnteredStageLessThan.
EnteredStageLessThanOrEqual String True No EnteredStageLessThanOrEqual.
EnteredStageEqual String True No EnteredStageEqual.
EnteredStageGreaterThan String True No EnteredStageGreaterThan.
EnteredStageGreaterThanOrEqual String True No EnteredStageGreaterThanOrEqual.
EnumNotEqual String True No EnumNotEqual.
EnumEqual String True No EnumEqual.
EnumISNOTNULL String True No EnumISNOTNULL.
EnumISNULL String True No EnumISNULL.
IntNotEqual String True No IntNotEqual.
IntLessThan String True No IntLessThan.
IntLessThanOrEqual String True No IntLessThanOrEqual.
IntEqual String True No IntEqual.
IntGreaterThan String True No IntGreaterThan.
IntGreaterThanOrEqual String True No IntGreaterThanOrEqual.
IntISNOTNULL String True No IntISNOTNULL.
IntISNULL String True No IntISNULL.
MonetaryNotEqual String True No MonetaryNotEqual.
MonetaryLessThan String True No MonetaryLessThan.
MonetaryLessThanOrEqual String True No MonetaryLessThanOrEqual.
MonetaryEqual String True No MonetaryEqual.
MonetaryGreaterThan String True No MonetaryGreaterThan.
MonetaryGreaterThanOrEqual String True No MonetaryGreaterThanOrEqual.
MonetaryISNOTNULL String True No MonetaryISNOTNULL.
MonetaryISNULL String True No MonetaryISNULL.
OrganizationNotEqual String True No OrganizationNotEqual.
OrganizationEqual String True No OrganizationEqual.
OrganizationISNOTNULL String True No OrganizationISNOTNULL.
OrganizationISNULL String True No OrganizationISNULL.
PersonNotEqual String True No PersonNotEqual.
PersonEqual String True No PersonEqual.
PersonISNOTNULL String True No PersonISNOTNULL.
PersonISNULL String True No PersonISNULL.
PipelineNotEqual String True No PipelineNotEqual.
PipelineEqual String True No PipelineEqual.
ProductNotEqual String True No ProductNotEqual.
ProductEqual String True No ProductEqual.
ProductISNOTNULL String True No ProductISNOTNULL.
ProductISNULL String True No ProductISNULL.
SetNotEqual String True No SetNotEqual.
SetEqual String True No SetEqual.
SetContains String True No SetContains.
SetISNOTNULL String True No SetISNOTNULL.
SetISNULL String True No SetISNULL.
SetNotContains String True No SetNotContains.
StageNotEqual String True No StageNotEqual.
StageEqual String True No StageEqual.
StageHasBeen String True No StageHasBeen.
StatusNotEqual String True No StatusNotEqual.
StatusEqual String True No StatusEqual.
TimeNotEqual String True No TimeNotEqual.
TimeLessThan String True No TimeLessThan.
TimeLessThanOrEqual String True No TimeLessThanOrEqual.
TimeEqual String True No TimeEqual.
TimeGreaterThan String True No TimeGreaterThan.
TimeGreaterThanOrEqual String True No TimeGreaterThanOrEqual.
TimeISNOTNULL String True No TimeISNOTNULL.
TimeISNULL String True No TimeISNULL.
TimerangeNotEqual String True No TimerangeNotEqual.
TimerangeLessThan String True No TimerangeLessThan.
TimerangeLessThanOrEqual String True No TimerangeLessThanOrEqual.
TimerangeEqual String True No TimerangeEqual.
TimerangeGreaterThan String True No TimerangeGreaterThan.
TimerangeGreaterThanOrEqual String True No TimerangeGreaterThanOrEqual.
TimerangedoesNotEndAt String True No TimerangeDoes_not_end_at.
TimerangeEndsAfter String True No TimerangeEndsAfter.
TimerangeEndsAt String True No TimerangeEndsAt.
TimerangeEndsBefore String True No TimerangeEndsBefore.
TimerangeEndsEAfter String True No TimerangeEndsEAfter.
TimerangeEndsEBefore String True No TimerangeEndsEBefore.
TimerangeIncludes String True No TimerangeIncludes.
TimerangeISNOTNULL String True No TimerangeISNOTNULL.
TimerangeISNULL String True No TimerangeISNULL.
TitleEqual String True No TitleEqual.
TitleLIKE'$%' String True No TitleLIKE'$%'.
TitleLIKE'%$' String True No TitleLIKE'%$'.
TitleLIKE'%$%' String True No TitleLIKE'%$%'.
TitleNOTLIKE'$%' String True No TitleNOTLIKE'$%'.
TitleNOTLIKE'%$' String True No TitleNOTLIKE'%$'.
TitleNOTLIKE'%$%' String True No TitleNOTLIKE'%$%'.
UserNotEqual String True No UserNotEqual.
UserEqual String True No UserEqual.
UserBelongsToTeam String True No User.belongs_to_team.
UserISNOTNULL String True No User.IS_NOT_NULL.
UserISNULL String True No User.IS_NULL.
VarcharNotEqual String True No VarcharNotEqual.
VarcharEqual String True No VarcharEqual.
VarcharISNOTNULL String True No VarcharISNOTNULL.
VarcharISNULL String True No VarcharISNULL.
VarcharLIKE'$%' String True No VarcharLIKE'$%'
VarcharLIKE'%$' String True No VarcharLIKE'%$'
VarcharLIKE'%$%' String True No VarcharLIKE'%$%'
VarcharNOTLIKE'$%' String True No VarcharNOTLIKE'$%'
VarcharNOTLIKE'%$' String True No VarcharNOTLIKE'%$'
VarcharNOTLIKE'%$%' String True No VarcharNOTLIKE'%$%'
VisibletoNotEqual String True No VisibletoNotEqual.
VisibletoEqual String True No VisibletoEqual.
RottenTime String True No RottenTime.
LastMonth String True No LastMonth.
LastQuarter String True No LastQuarter.
LastWeek String True No LastWeek.
NextMonth String True No NextMonth.
NextWeek String True No NextWeek.
ThisMonth String True No ThisMonth.
ThisQuarter String True No ThisQuarter.
ThisWeek String True No ThisWeek.
OnemonthsAgo String True No OnemonthsAgo.
OneweekAgo String True No OneweekAgo.
TwoMonthsAgo String True No TwoMonthsAgo.
TwoWeeksAgo String True No TwoWeeksAgo.
ThreeMonthsAgo String True No ThreeMonthsAgo.
ThreeWeeksAgo String True No ThreeWeeksAgo.
FourMonthsAgo String True No FourMonthsAgo.
FiveMonthsAgo String True No FiveMonthsAgo.
SixMonthsAgo String True No SixMonthsAgo.
BeforeToday String True No BeforeToday.
BeforeTomorrow String True No BeforeTomorrow.
InOneMonth String True No InOneMonth.
InOneWeek String True No InOneWeek.
InTwoMonths String True No InTwoMonths.
InTwoWeeks String True No InTwoWeeks.
InThreeMonths String True No InThreeMonths.
InThreeWeeks String True No InThreeWeeks.
InFourMonths String True No InFourMonths.
InFiveMonths String True No InFiveMonths.
InSixMonths String True No InSixMonths.
LaterOrToday String True No LaterOrToday.
LaterOrTomorrow String True No LaterOrTomorrow.
Now String True No Now.
Today String True No Today.
Tomorrow String True No Tomorrow.
Yesterday String True No Yesterday.

Return to Top

Filters

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No The ID of the filter.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
CustomViewId String True No CustomViewId.
Name String False No The name of the filter.
TemporaryFlag String True No TemporaryFlag.
Type String False No The types of filters to fetch.
UpdateTime String True No UpdateTime.
UserId Integer True No UserId.
VisibleTo Integer True No VisibleTo.
Conditions String False Yes The conditions of the filter as a JSON object.

Return to Top

FindUsersByName

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the user.
Activated Boolean True No Activated.
ActiveFlag Boolean True No Whether the user is active or not.
Created Datetime True No Created.
DefaultCurrency String True No DefaultCurrency.
Email String True No Email of the user.
Hascreatedcompany Boolean True No Hascreatedcompany.
IconUrl String True No IconUrl.
IsAdmin Integer True No IsAdmin.
IsYou Boolean True No IsYou.
Lang Integer True No Lang.
LastLogin Datetime True No LastLogin.
Locale String True No Locale.
Modified Datetime True No Modified.
Name String True No Name of the user.
Phone String True No Phone.
RoleId Integer True No ID of the role.
TimezoneName String True No TimezoneName.
TimezoneOffset String True No TimezoneOffset.
Access String True No The access given to the user.
Term String True No The search term to look for.
SearchByEmail Integer True No When enabled, the term will only be matched against email addresses of users.

Return to Top

Goals

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No Id.
AssigneeId Integer False No ID of the user who's goal to fetch.
AssigneeType String False No Type of the goal's assignee. If provided, everyone's goals will be returned.
DurationEnd Date False No End date of the period for which to find goals.
DurationStart Date False No Start date of the period for which to find goals.
Target Integer False No Numeric value of the outcome. If provided, everyone's goals will be returned.
CurrencyId String False No Numeric value of the outcome. If provided, everyone's goals will be returned.
TrackingMetric String False No Tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
Interval String False No Interval of the goal.
IsActive Boolean False No Whether goal is active or not.
OwnerId Integer True No OwnerId.
ReportIds String True No ReportIds.
Title String False No Title of the goal.
TypeName String False No Type of the goal. If provided, everyone's goals will be returned.
PipelineId String False No ID of the pipeline.
ActivityTypeId String False No ID of the activity_type.

Return to Top

LeadLabels

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No The ID of the Lead Label.
AddTime Datetime True No AddTime.
Color String False No The color of the label.
Name String False No The name of the Lead Label.
UpdateTime Datetime True No UpdateTime.

Return to Top

Leads

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No The ID of the Lead.
Addtime Datetime True No Addtime.
CcEmail String True No Ccemail.
CreatorId Integer True No Creatorid.
ExpectedCloseDate String False No The date of when the Deal which will be created from the Lead is expected to be closed.
Isarchived Boolean True No A flag indicating whether the Lead is archived or not.
Labelids String False No The IDs of the Lead Labels which will be associated with the Lead.
NextactivityId Integer True No Nextactivityid.
OrganizationId String False No The ID of an Organization which this Lead will be linked to.
OwnerId Integer False No The ID of the User which will be the owner of the created Lead.
PersonId Integer False No The ID of a Person which this Lead will be linked to.
Sourcename String False No Sourcename.
Title String False No The name of the Lead.
Updatetime Datetime True No UpdateTime.
Amount Integer False No The potential value of the Lead.
Currency String True No The currency value of the Lead.
Visibleto String False No Visibility of the Lead.
Wasseen Boolean False No A flag indicating whether the Lead was seen by someone in the Pipedrive UI.
SearchByEmail Integer False Yes Filtering based on archived status of a Lead. If not provided, All is used.

Return to Top

LeadSources

Name Type ReadOnly References FilterOnly Description
Name String True No Name.

Return to Top

MailMessages

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the Mail Threads.
PartiesTo String True No To.
PartiesFrom String True No From.
DraftParties String True No Draft Parties.
Folders String True No Folders.
AccountId String True No Account Id.
UserId Integer True No User Id.
Version Integer True No Version.
Subject String True No Subject.
Snippet String True No Snippet.
SnippetDraft String True No SnippetDraft.
SnippetSent String True No SnippetSent.
HasAttachmentsFlag Integer True No HasAttachmentsFlag.
HasInlineAttachmentsFlag Integer True No HasInlineAttachmentsFlag.
HasRealAttachmentsFlag Integer True No HasRealAttachmentsFlag.
HasDraftFlag Integer True No HasDraftFlag.
HasSentFlag Integer True No HasSentFlag.
ArchivedFlag Integer True No ArchivedFlag.
DeletedFlag Integer True No DeletedFlag.
SyncedFlag Integer True No SyncedFlag.
ExternalDeletedFlag Integer True No ExternalDeletedFlag.
SmartBccFlag Integer True No SmartBccFlag.
FirstMessageToMeFlag Integer True No FirstMessageToMeFlag.
MailLinkTrackingEnabledFlag Integer True No MailLinkTrackingEnabledFlag.
LastMessageTimestamp String True No LastMessageTimestamp.
FirstMessageTimestamp String True No FirstMessageTimestamp.
LastMessageSentTimestamp String True No LastMessageSentTimestamp.
LastMessageReceivedTimestamp String True No LastMessageReceivedTimestamp.
AddTime String True No AddTime.
UpdateTime String True No UpdateTime.
DealId Integer True No DealId.
DealStatus Integer True No DealStatus.
AllMessagesSentFlag Integer True No AllMessagesSentFlag.
Folder String False Yes The type of folder to fetch.

Return to Top

MailThreadMessages

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the Mail Thread Messages.
MailThreadId Integer True No ID of the Mail Thread.
To String True No To.
From String True No From.
Cc String True No Cc.
Bcc String True No Bcc.
BodyUrl String True No Body url.
AccountId String True No Account Id.
UserId Integer True No User Id.
Subject String True No Subject.
Snippet String True No Snippet.
MailTrackingStatus String True No Mail Tracking status.
MailLinkTrackingEnabledFlag Integer True No MailLinkTrackingEnabledFlag.
ReadFlag Integer True No Readflag.
Draft String True No Draft.
DraftFlag Integer True No Draft flag.
SyncedFlag Integer True No Synced flag.
DeletedFlag Integer True No Deleted flag.
HasBodyFlag Integer True No Has body flag.
SentFlag Integer True No Sent flag.
SentFromPipeDriveFlag Integer True No SentFromPipeDriveFlag.
SmartBccFlag Integer True No SmartBccFlag.
MessageTime String True No MessageTime.
AddTime String True No AddTime.
UpdateTime String True No UpdateTime.
HasAttachmentsFlag Integer True No HasAttachmentsFlag.
HasInlineAttachmentsFlag Integer True No HasInlineAttachmentsFlag.
HasRealAttachmentsFlag Integer True No HasRealAttachmentsFlag.

Return to Top

MailThreadMessagesFrom

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the Mail Thread Messages.
MailThreadId Integer True No ID of the Mail Thread.
EmailAddress String True No Email address.
Name String True No Name.
LinkedPersonId Integer True No Linked Person Id.
LinkedPersonName String True No Linked Person Name.
MailMessagePartyId Integer True No Mail message Party Id.

Return to Top

MailThreadMessagesTo

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the Mail Thread Messages.
MailThreadId Integer True No ID of the Mail Thread.
EmailAddress String True No Email address.
Name String True No Name.
LinkedPersonId Integer True No Linked Person Id.
LinkedPersonName String True No Linked Person Name.
MailMessagePartyId Integer True No Mail message Party Id.

Return to Top

MailThreads

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the Mail Threads.
PartiesTo String True No To.
PartiesFrom String True No From.
DraftParties String True No Draft Parties.
Folders String True No Folders.
AccountId String True No Account Id.
UserId Integer True No User Id.
Version Integer True No Version.
Subject String True No Subject.
Snippet String True No Snippet.
SnippetDraft String True No SnippetDraft.
SnippetSent String True No SnippetSent.
HasAttachmentsFlag Integer True No HasAttachmentsFlag.
HasInlineAttachmentsFlag Integer True No HasInlineAttachmentsFlag.
HasRealAttachmentsFlag Integer True No HasRealAttachmentsFlag.
HasDraftFlag Integer True No HasDraftFlag.
HasSentFlag Integer True No HasSentFlag.
ArchivedFlag Integer True No ArchivedFlag.
DeletedFlag Integer True No DeletedFlag.
SyncedFlag Integer True No SyncedFlag.
ExternalDeletedFlag Integer True No ExternalDeletedFlag.
SmartBccFlag Integer True No SmartBccFlag.
FirstMessageToMeFlag Integer True No FirstMessageToMeFlag.
MailLinkTrackingEnabledFlag Integer True No MailLinkTrackingEnabledFlag.
LastMessageTimestamp String True No LastMessageTimestamp.
FirstMessageTimestamp String True No FirstMessageTimestamp.
LastMessageSentTimestamp String True No LastMessageSentTimestamp.
LastMessageReceivedTimestamp String True No LastMessageReceivedTimestamp.
AddTime String True No AddTime.
UpdateTime String True No UpdateTime.
DealId Integer True No DealId.
DealStatus Integer True No DealStatus.
AllMessagesSentFlag Integer True No AllMessagesSentFlag.
Folder String False Yes The type of folder to fetch.

Return to Top

MailThreadsFrom

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID.
Name String True No Name.
LatestSent Boolean True No LatestSent.
EmailAddress String True No EmailAddress.
MessageTime String True No MessageTime.
LinkedPersonId Integer True No LinkedPersonId.
LinkedPersonName String True No LinkedPersonName.
LinkedOrganizationId String True No LinkedOrganizationId.
MailMessagePartyId Integer True No MailMessagePartyId.
Folder String False Yes The type of folder to fetch.

Return to Top

MailThreadsTo

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID.
Name String True No Name.
LatestSent Boolean True No LatestSent.
EmailAddress String True No EmailAddress.
MessageTime String True No MessageTime.
LinkedPersonId Integer True No LinkedPersonId.
LinkedPersonName String True No LinkedPersonName.
LinkedOrganizationId String True No LinkedOrganizationId.
MailMessagePartyId Integer True No MailMessagePartyId.
Folder String False Yes The type of folder to fetch.

Return to Top

NoteComments

Name Type ReadOnly References FilterOnly Description
NoteId [KEY] Integer True No ID of the note.
UUID String False No Comment Id.
ActiveFlag Boolean False No Active flag.
AddTime String False No Add time of the note comment.
CompanyId Integer True No Company Id.
Content String False No Content of the comment.
ObjectId String True No Object Id.
ObjectType String False No Object type.
UpdateTime String False No Update time of the comment.
UpdaterId Integer True No Updater Id.
UserId Integer True No User Id.

Return to Top

NoteFields

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No ActiveFlag.
BulkEditAllowed Boolean True No BulkEditAllowed.
EditFlag Boolean True No EditFlag.
FieldType String True No FieldType.
Key String True No Key.
MandatoryFlag Boolean True No MandatoryFlag.
Name String True No Name.
Options String True No Options.

Return to Top

NoteFieldsOptions

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
Label String True No Label.

Return to Top

Notes

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the note.
ActiveFlag Boolean False No ActiveFlag.
AddTime Datetime False No AddTime.
Content String False No Content.
DealTitle String True No DealTitle.
DealId Integer False No The ID of the deal which notes to fetch.
LastUpdateUserId Integer True No LastUpdateUserId.
LeadId String False No The ID of the lead which notes to fetch.
OrgId Integer False No The ID of the organization which notes to fetch.
OrganizationName String True No OrganizationName.
PersonName String True No PersonName.
PersonId Integer False No The ID of the person whose notes to fetch.
PinnedToDealFlag Boolean False No If set, then results are filtered by note to deal pinning state.
PinnedToLeadFlag Boolean False No If set, then results are filtered by note to lead pinning state.
PinnedToOrganizationFlag Boolean False No If set, then results are filtered by note to organization pinning state.
PinnedToPersonFlag Boolean False No If set, then results are filtered by note to person pinning state.
UpdateTime Datetime True No UpdateTime.
UserEmail String True No UserEmail.
UserIconUrl String True No UserIconUUserNamerl.
UserIsYou Boolean True No UserIsYouUserName.
UserName String True No UserName.
UserId Integer True No The ID of the user whose notes to fetch.

Return to Top

OrganizationFields

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the field.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
AddVisibleFlag Boolean False No Whether the field is available in 'add new' modal or not.
BulkEditAllowed Boolean True No BulkEditAllowed.
DetailsVisibleFlag Boolean True No DetailsVisibleFlag.
EditFlag Boolean True No EditFlag.
FieldType String False No Type of the field.
FilteringAllowed Boolean True No FilteringAllowed.
ImportantFlag Boolean True No ImportantFlag.
IndexVisibleFlag Boolean True No IndexVisibleFlag.
Key String True No Key.
LastUpdatedByUserId String True No LastUpdatedByUserId.
MandatoryFlag Boolean True No MandatoryFlag.
Name String False No Name of the field.
Options String False No Options.
OrderNr Integer True No OrderNr.
SearchableFlag Boolean True No SearchableFlag.
SortableFlag Boolean True No SortableFlag.
UpdateTime Datetime True No UpdateTime.

Return to Top

OrganizationFieldsOptions

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the field.
Label String True No Label.

Return to Top

OrganizationRelationships

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the organization relationship.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
CalculatedRelatedOrgId Integer False No CalculatedRelatedOrgId.
CalculatedType String False No CalculatedType.
RelLinkedOrgIdActiveFlag Boolean False No RelLinkedOrgIdActiveFlag.
RelLinkedOrgIdAddress String False No RelLinkedOrgIdAddress.
RelLinkedOrgIdCcEmail String False No RelLinkedOrgIdCcEmail.
RelLinkedOrgIdname String False No RelLinkedOrgIdname.
RelLinkedOrgIdownerId Integer False No RelLinkedOrgIdownerId.
RelLinkedOrgIdPeopleCount Integer False No RelLinkedOrgIdPeopleCount.
RelLinkedOrgIdvalue Integer False No RelLinkedOrgIdvalue.
RelOwnerOrgIdActiveFlag Boolean False No RelOwnerOrgIdActiveFlag.
RelOwnerOrgIdAddress String False No RelOwnerOrgIdAddress.
RelOwnerOrgIdCcEmail String False No RelOwnerOrgIdCcEmail.
RelOwnerOrgIdName String False No RelOwnerOrgIdName.
RelOwnerOrgIdOwnerId Integer False No RelOwnerOrgIdOwnerId.
RelOwnerOrgIdPeopleCount Integer False No RelOwnerOrgIdPeopleCount.
OrgId Integer False No RelOwnerOrgIdValue.
RelatedOrganizationName String False No RelatedOrganizationName.
Type String False No The type of organization relationship.
UpdateTime Datetime False No UpdateTime.
RelOwnerOrgId Integer False Yes Real Organization Id.
RelLinkedOrgId Integer False Yes Real Organization Id.

Return to Top

Organizations

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id
ActiveFlag Boolean True No ActiveFlag
ActivitiesCount Integer True No ActivitiesCount
AddTime Datetime False No Optional creation date time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
Address String True No Address
AdminArealevel1 String True No AdminArealevel1
AdminArealevel2 String True No AdminArealevel2
Country String True No Country
FormattedAddress String True No FormattedAddress
Locality String True No Locality
PostalCode String True No PostalCode
Route String True No Route
StreetNumber String True No StreetNumber
Sublocality String True No Sublocality
Subpremise String True No Subpremise
CcEmail String True No CcEmail
CustomeField String True No CustomeField you will get the result of this column only when criteria filter title is used
ClosedDealsCount Integer True No ClosedDealsCount
CompanyId Integer True No CompanyId
CountryCode String True No CountryCode
DoneActivitiesCount Integer True No DoneActivitiesCount
EmailMessagesCount Integer True No EmailMessagesCount
FilesCount Integer True No FilesCount
FirstChar String True No FirstChar
FollowersCount Integer True No FollowersCount
Label Integer True No Label
LastActivityDate Date True No LastActivityDate
LastActivityId Integer True No LastActivityId
LostDealsCount Integer True No LostDealsCount
Name String False No Name
NextActivityDate Date True No NextActivityDate
NextActivityId Integer True No NextActivityId
NextActivityTime Time True No NextActivityTime
NotesCount Integer True No NotesCount
OpenDealsCount Integer True No OpenDealsCount
Owneractive_flag Boolean True No Owneractive_flag
OwnerEmail String True No OwnerEmail
OwnerHasPic Integer True No OwnerHasPic
OwnerId Integer False No OwnerId
OwnerName String True No OwnerName
OwnerPicHash String True No OwnerPicHash
OwnerIdValue Integer True No OwnerIdValue
OwnerName String True No OwnerName
PeopleCount Integer True No PeopleCount
PictureActiveFlag Boolean True No PictureActiveFlag
PictureAddTime Datetime True No PictureAddTime
PictureAddedByUserId Integer True No PictureAddedByUserId
PictureItemId Integer True No PictureItemId
PictureItemType String True No PictureItemType
Picture128 String True No Picture128
Picture512 String True No Picture512
PictureUpdateTime String True No PictureUpdateTime
PictureIid Integer True No PictureIid
RelatedClosedDealsCount Integer True No RelatedClosedDealsCount
RelatedLostDealsCount Integer True No RelatedLostDealsCount
RelatedOpenDealsCount Integer True No RelatedOpenDealsCount
RelatedWonDealsCount Integer True No RelatedWonDealsCount
Type String True No Type you will get the result of this column only when criteria filter title is used
UndoneActivitiesCount Integer True No UndoneActivitiesCount
UpdateTime Datetime True No UpdateTime
VisibleTo Integer False No Visibility of the organization
WonDealsCount Integer True No WonDealsCount
UserId Integer False Yes User Id
FilterId Integer False Yes Filter Id

Return to Top

OrganizationsActivities

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
AssignedTouserId Integer True No AssignedTouserId.
Attendees String True No Attendees.
BusyFlag Boolean True No BusyFlag.
IncludeContext String True No IncludeContext.
CompanyId Integer True No CompanyId.
MeetingClient String True No MeetingClient.
MeetingId String True No MeetingId.
MeetingUrl String True No MeetingUrl.
CreatedByUserId Integer True No CreatedByUserId.
DealDropboxBcc String True No DealDropboxBcc.
DealId Integer True No DealId.
DealTitle String True No DealTitle.
Done Boolean True No Done.
DueDate Date True No DueDate.
DueTime Time True No DueTime.
Duration Time True No Duration.
FileCleanName String True No FileCleanName.
FileId String True No FileId.
FileUrl String True No FileUrl.
GcaleventId String True No GcaleventId.
GoogleCalendarEtag String True No GoogleCalendarEtag.
GoogleCalendarId String True No GoogleCalendarId.
LastNotificationTime Datetime True No LastNotificationTime.
LastNotificationUserId Integer True No LastNotificationUserId.
LeadId String True No LeadId.
Location String True No Location.
AdminAreaLevel1 String True No AdminAreaLevel1.
AdminAreaLevel2 String True No AdminAreaLevel2.
Country String True No Country.
FormattedAddress String True No FormattedAddress.
Lat Double True No Lat.
Locality String True No Locality.
Long Double True No Long.
PostalCode String True No PostalCode.
Route String True No Route.
StreetNumber String True No StreetNumber.
Sublocality String True No Sublocality.
Subpremise String True No Subpremise.
MarkedAsDoneTime Datetime True No MarkedAsDoneTime.
Note String True No Note.
NotificationLanguageId Integer True No NotificationLanguageId.
OrgId Integer True No OrgId.
OrgName String True No OrgName.
OwnerName String True No OwnerName.
Participants String True No Participants.
PersonDropboxBcc String True No PersonDropboxBcc.
PersonId Integer True No PersonId.
PersonName String True No PersonName.
PublicDescription String True No PublicDescription.
MasterActivityId String True No MasterActivityId.
Rule String True No Rule.
RuleExtension String True No RuleExtension.
ReferenceId Integer True No ReferenceId.
ReferenceType String True No ReferenceType.
Series String True No Series.
SourceTimezone String True No SourceTimezone.
Subject String True No Subject.
Type String True No Type.
UpdateTime Datetime True No UpdateTime.
UpdateUserId Integer True No UpdateUserId.
UserId Integer True No UserId.
Exclude String False Yes A comma-separated string of activity IDs to exclude from result.

Return to Top

OrganizationsActivitiesAttendees

Name Type ReadOnly References FilterOnly Description
OrgId Integer True No OrgId.
EmailAddress String True No Email Address.
IsOrganizer Integer True No IsOrganizer.
Name String True No Name.
PersonId Integer True No PersonId.
Status String True No Status.
UserId String True No UserId.
Exclude String False Yes A comma-separated string of activity IDs to exclude from result.

Return to Top

OrganizationsActivitiesParticipants

Name Type ReadOnly References FilterOnly Description
OrgId Integer True No OrgId.
PersonId Integer True No PersonId.
PrimaryFlag Boolean True No Primary Flag.
Exclude String False Yes A comma-separated string of activity IDs to exclude from result.

Return to Top

OrganizationsDeals

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
Active Boolean True No Active.
ActivitiesCount Integer True No ActivitiesCount.
AddTime Datetime True No AddTime.
CcEmail String True No CcEmail.
CloseTime String True No CloseTime.
CreatoractiveFlag Boolean True No CreatoractiveFlag.
Creatoremail String True No Creatoremail.
CreatorhasPic Boolean True No CreatorhasPic.
Creatorid Integer True No Creatorid.
Creatorname String True No Creatorname.
CreatorPicHash String True No CreatorPicHash.
Creatorvalue Integer True No Creatorvalue.
Currency String True No Currency.
Deleted Boolean True No Deleted.
DoneActivitiesCount Integer True No DoneActivitiesCount.
EmailMessagesCount Integer True No EmailMessagesCount.
ExpectedCloseDate Date True No ExpectedCloseDate.
FilesCount Integer True No FilesCount.
FirstWonTime Datetime True No FirstWonTime.
FollowersCount Integer True No FollowersCount.
FormattedValue String True No FormattedValue.
FormattedWeightedValue String True No FormattedWeightedValue.
Label String True No Label.
LastActivityDate String True No LastActivityDate.
LastActivityId String True No LastActivityId.
LastIncomingMailTime Datetime True No LastIncomingMailTime.
LastOutgoingMailTime Datetime True No LastOutgoingMailTime.
LostReason String True No LostReason.
LostTime String True No LostTime.
NextActivityDate Date True No NextActivityDate.
NextActivityDuration Time True No NextActivityDuration.
NextActivityId Integer True No NextActivityId.
NextActivitynote String True No NextActivitynote.
NextActivitysubject String True No NextActivitysubject.
NextActivitytime Time True No NextActivitytime.
NextActivitytype String True No NextActivitytype.
NotesCount Integer True No NotesCount.
OrgHidden Boolean True No OrgHidden.
OrgActive_flag Boolean True No OrgActive_flag.
OrgAddress String True No OrgAddress.
OrgCcEmail String True No OrgCcEmail.
OrgIdName String True No OrgName.
OrgOwnerId Integer True No OrgOwnerId.
OrgPeopleCount Integer True No OrgPeopleCount.
OrgId Integer True No OrgValue.
OwnerName String True No OwnerName.
ParticipantsCount Integer True No ParticipantsCount.
PersonHidden Boolean True No PersonHidden.
PersonActiveFlag Boolean True No PersonActiveFlag.
PersonEmail String True No PersonEmail.
PersonName String True No PersonName.
PersonPhone String True No PersonPhone.
PersonValue Integer True No PersonValue.
PipelineId Integer True No PipelineId.
Probability String True No Probability.
ProductsCount Integer True No ProductsCount.
RottenTime String True No RottenTime.
StageChangeTime Datetime True No StageChangeTime.
StageId Integer True No StageId.
StageOrderNr Integer True No StageOrderNr.
Status String True No Only fetch deals with specific status..
Title String True No Title.
UndoneActivitiesCount Integer True No UndoneActivitiesCount.
UpdateTime Datetime True No UpdateTime.
UserActiveFlag Boolean True No UserActiveFlag.
UserEmail String True No UserEmail.
UserHasPic Boolean True No UserHasPic.
UserId Integer True No UserId.
UserName String True No UserName.
UserPicHash String True No UserPicHash.
UserValue Integer True No UserValue.
Value Integer True No Value.
VisibleTo String True No VisibleTo.
WeightedValue Integer True No WeightedValue.
WeightedValueCurrency String True No WeightedValueCurrency.
WonTime Datetime True No WonTime.
OrgName String True No Org Name.
OnlyPrimaryAssociation Integer False Yes If set, only deals that are directly associated to the organization are fetched.

Return to Top

OrganizationsDealsPersonEmail

Name Type ReadOnly References FilterOnly Description
OrgId [KEY] Integer True Organizations.Id No Org Id.
Label String True No Label.
Primary Boolean True No Primary.
Value String True No Value.
Status String False Yes Only fetch deals with specific status.
OnlyPrimaryAssociation Integer False Yes If set, only deals that are directly associated to the organization are fetched.

Return to Top

OrganizationsDealsPersonphone

Name Type ReadOnly References FilterOnly Description
OrgId [KEY] Integer True Organizations.Id No Org Id.
Label String True No Label.
Primary Boolean True No Primary.
Value String True No Value.
Status String False Yes Only fetch deals with specific status.
OnlyPrimaryAssociation Integer False Yes If set, only deals that are directly associated to the organization are fetched

Return to Top

OrganizationsFiles

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the organizations.
ActiveFlag Boolean True No Active Flag.
ActivityId String True No Activity Id.
AddTime Datetime True No AddTime.
Cid String True No Cid.
DealId String True No Deal Id.
DealName String True No DealName.
Description String True No Description.
FileName String True No File Name.
FileSize Integer True No File Size.
FileType String True No File Type.
InlineFlag Boolean True No Inline Flag.
LogId String True No Log Id.
MailMessageId String True No MailMessage Id.
MailTemplateId String True No MailTemplate Id.
Name String True No Name.
OrgId Integer True No Org Id.
OrgName String True No Org Name.
PeopleName String True No People Name.
PersonId String True No PersonId.
PersonName String True No Person Name.
ProductId String True No Produc tId.
ProductName String True No Product Name.
RemoteId String True No Remote Id.
RemoteLocation String True No Remote Location.
S3Bucket String True No S3Bucket.
UpdateTime Datetime True No Update Time.
Url String True No Url.
UserId Integer True No UserId.
LeadId String True No LeadId.
LeadName String True No LeadName.

Return to Top

OrganizationsFollowers

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
AddTime Datetime True No AddTime.
OrgId Integer True No OrgId.
UserId Integer False No UserId.

Return to Top

OrganizationsInternal

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No ActiveFlag.
ActivitiesCount Integer True No ActivitiesCount.
AddTime Datetime False No Optional creation date time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
Address String True No Address.
AdminArealevel1 String True No AdminArealevel1.
AdminArealevel2 String True No AdminArealevel2.
Country String True No Country.
FormattedAddress String True No FormattedAddress.
Locality String True No Locality.
PostalCode String True No PostalCode.
Route String True No Route.
StreetNumber String True No StreetNumber.
Sublocality String True No Sublocality.
Subpremise String True No Subpremise.
CcEmail String True No CcEmail.
CustomeField String True No CustomeField you will get the result of this column only when criteria filter title is used.
ClosedDealsCount Integer True No ClosedDealsCount.
CompanyId Integer True No CompanyId.
CountryCode String True No CountryCode.
DoneActivitiesCount Integer True No DoneActivitiesCount.
EmailMessagesCount Integer True No EmailMessagesCount.
FilesCount Integer True No FilesCount.
FirstChar String True No FirstChar.
FollowersCount Integer True No FollowersCount.
Label Integer True No Label.
LastActivityDate Date True No LastActivityDate.
LastActivityId Integer True No LastActivityId.
LostDealsCount Integer True No LostDealsCount.
Name String False No Name.
NextActivityDate Date True No NextActivityDate.
NextActivityId Integer True No NextActivityId.
NextActivityTime Time True No NextActivityTime.
NotesCount Integer True No NotesCount.
OpenDealsCount Integer True No OpenDealsCount.
OwneractiveFlag Boolean True No Owneractive_flag.
OwnerEmail String True No OwnerEmail.
OwnerHasPic Boolean True No OwnerHasPic.
OwnerId Integer False No OwnerId.
OwnerIdName String True No OwnerName.
OwnerPicHash String True No OwnerPicHash.
OwnerIdValue Integer True No OwnerIdValue.
PeopleCount Integer True No PeopleCount.
PictureActiveFlag Boolean True No PictureActiveFlag.
PictureAddTime Datetime True No PictureAddTime.
PictureAddedByUserId Integer True No PictureAddedByUserId.
PictureItemId Integer True No PictureItemId.
PictureItemType String True No PictureItemType.
Picture128 String True No Picture128.
Picture512 String True No Picture512.
PictureUpdateTime String True No PictureUpdateTime.
PictureId Integer True No PictureIid.
RelatedClosedDealsCount Integer True No RelatedClosedDealsCount.
RelatedLostDealsCount Integer True No RelatedLostDealsCount.
RelatedOpenDealsCount Integer True No RelatedOpenDealsCount.
RelatedWonDealsCount Integer True No RelatedWonDealsCount.
Type String True No Type you will get the result of this column only when criteria filter title is used.
UndoneActivitiesCount Integer True No UndoneActivitiesCount.
UpdateTime Datetime True No UpdateTime.
VisibleTo Integer False No Visibility of the organization.
WonDealsCount Integer True No WonDealsCount.
OwnerName String True No Owner Name.
UserId Integer False Yes User Id.
FilterId Integer False Yes Filter Id.

Return to Top

OrganizationsMailMessages

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Org id.
OrgId Integer True Organizations.Id No Activities ID.
AccountId String True No AccountId.
AddTime Datetime True No addTime.
Bcc String True No Bcc.
BodyUrl String True No bodyUrl.
Cc String True No cc.
CompanyId Integer True No companyId.
DeletedFlag Boolean True No DeletedFlag.
Draft String True No Draft.
DraftFlag Boolean True No DraftFlag.
ExternalDeletedFlag Boolean True No External DeletedFlag.
From String True No From.
AttachmentsFlag Boolean True No AttachmentsFlag.
BodyFlag Boolean True No BodyFlag.
InlineAttachmentsFlag Boolean True No InlineAttachmentsFlag.
RealAttachmentsFlag Boolean True No RealAttachmentsFlag.
ItemType String True No ItemType.
TrackingEnabledFlag Boolean True No TrackingEnabledFlag.
ThreadId Integer True No ThreadId.
TrackingStatus String True No TrackingStatus.
MessageTime String True No MessageTime.
MessageId String True No MessageId.
NylasId String True No NylasId.
ReadFlag Boolean True No ReadFlag.
S3Bucket String True No S3Bucket.
S3BucketPath String True No S3BucketPath.
SentFlag Boolean True No SentFlag.
SentFromPipedriveFlag Boolean True No SentFromPipedriveFlag.
SmartBccFlag Boolean True No SmartBccFlag.
Snippet String True No Snippet.
Subject String True No Subject.
SyncedFlag Boolean True No SyncedFlag.
TemplateId String True No TemplateId.
Timestamp Datetime True No Timestamp.
To String True No To.
UpdateTime Datetime True No UpdateTime.
UserId Integer True No UserId.
WriteFlag Boolean True No writeFlag.
Object String True No Object.

Return to Top

OrganizationsMailMessagesBcc

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No id.
OrgId Integer True Organizations.Id No Org Id.
EmailAddress String True No EmailAddress.
PersonId Integer True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

OrganizationsMailMessagesCc

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
OrgId Integer True Organizations.Id No Org Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

OrganizationsMailMessagesFrom

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
OrgId Integer True Organizations.Id No Org Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

OrganizationsMailMessagesTo

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
OrgId Integer True Organizations.Id No Org Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

OrganizationsPermittedUsers

Name Type ReadOnly References FilterOnly Description
OrgId Integer True No Organization Id.
UserId Integer True No User Id.

Return to Top

OrganizationsPersons

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id
ActivitiesCount Integer True No ActivitiesCount
ActiveFlag Boolean True No ActiveFlag
AddTime Datetime True No AddTime
CcEmail String True No CcEmail
ClosedDealsCount Integer True No ClosedDealsCount
CompanyId Integer True No CompanyId
DoneActivitiesCount Integer True No DoneActivitiesCount
Email String True No Email
EmailMessagesCount Integer True No EmailMessagesCount
FilesCount Integer True No FilesCount
Label Integer True No label
LastActivityDate Date True No LastActivityDate
LastActivityId Integer True No LastActivityId
LastincomingMailTime String True No LastincomingMailTime
Lastname String True No Lastname
LastoutgoingMailTime String True No LastoutgoingMailTime
LostdealsCount Integer True No LostdealsCount
Name String True No Name
NextActivityDate Date True No nextActivityDate
NextActivityId Integer True No nextActivityId
NextActivityTime String True No nextActivityTime
NotesCount Integer True No NotesCount
OpenDealsCount Integer True No OpenDealsCount
OrgActiveFlag Boolean True No OrgActiveFlag
OrgAddress String True No OrgAddress
OrgCcEmail String True No OrgCcEmail
OrgIdName String True No OrgName
OrgownerId Integer True No OrgownerId
OrgpeopleCount Integer True No OrgpeopleCount
OrgId Integer True No OrgId
OwnerActiveFlag Boolean True No OwnerActiveFlag
OwnerEmail String True No OwnerEmail
OwnerHasPic Boolean True No OwnerHasPic
OwnerId Integer True No OwnerId
OwnerName String True No OwnerName
OwnerPicHash String True No OwnerPicHash
OwnerValue Integer True No OwnerValue
ParticipantClosedDealsCount Integer True No ParticipantClosedDealsCount
ParticipantOpenDealsCount Integer True No ParticipantOpenDealsCount
Phone String True No Phone
PictureActiveFlag Boolean True No PictureActiveFlag
PictureaddTime Datetime True No PictureaddTime
PictureaddedByUserId Integer True No PictureaddedByUserId
PictureItemId Integer True No PictureItemId
PictureitemType String True No PictureitemType
Picture128 String True No Picture128
Picture512 String True No Picture512
PictureupdateTime String True No PictureupdateTime
Picturevalue Integer True No Picturevalue
PictureId String True No PictureId
RelatedclosedDealsCount Integer True No RelatedclosedDealsCount
RelatedlostDealsCount Integer True No RelatedlostDealsCount
RelatedopenDealsCount Integer True No RelatedopenDealsCount
RelatedwonDealsCount Integer True No RelatedwonDealsCount
UndoneActivitiesCount Integer True No UndoneActivitiesCount
UpdateTime Datetime True No UpdateTime
VisibleTo String True No visibleTo
WonDealsCount Integer True No WonDealsCount
FirstName String True No First name.
FollowersCount Integer True No Followes Count.
PrimaryEmail String True No Primary Email.
FirstChar String True No First Char.
MarketingStatus String True No Marketing Status.
OrgName String True No Org name.

Return to Top

OrganizationsPersonsEmail

Name Type ReadOnly References FilterOnly Description
OrgId [KEY] Integer True No OrgId
Value String True No Value.
Primary Boolean True No Primary.
Label String True No Label.

Return to Top

OrganizationsPersonsPhone

Name Type ReadOnly References FilterOnly Description
OrgId [KEY] Integer True No OrgId
Value String True No Value.
Primary Boolean True No Primary.
Label String True No Label.

Return to Top

OrganizationsUpdates

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No ActiveFlag.
ActivityId String True No ActivityId.
AddTime Datetime True No AddTime.
NewValueFormatted String True No NewValueFormatted.
OldValueFormatted String True No OldValueFormatted.
AssignedToUserId Integer True No AssignedToUserId.
Attendees String True No Attendees.
BusyFlag Boolean True No BusyFlag.
IncludeContext String True No IncludeContext.
ChangeSource String True No ChangeSource.
User_agent String True No User_agent.
Cid String True No Cid.
CompanyId Integer True No CompanyId.
ConferenceMeetingClient String True No ConferenceMeetingClient.
ConferenceMeetingId String True No ConferenceMeetingId.
ConferenceMeetingUrl String True No ConferenceMeetingUrl.
CreatedByUserId Integer True No CreatedByUserId.
DealDropboxBcc String True No DealDropboxBcc.
DealId Integer True No DealId.
DealName String True No DealName.
DealTitle String True No DealTitle.
Description String True No Description.
Done Boolean True No Done.
DueDate Date True No DueDate.
DueTime Time True No DueTime.
Duration Time True No Duration.
FieldKey String True No FieldKey.
FileCleanName String True No FileCleanName.
FileId String True No FileId.
FileUrl String True No FileUrl.
FileName String True No FileName.
FileSize Integer True No FileSize.
FileType String True No FileType.
GcalEventId String True No GcalEventId.
GoogleCalendarEtag String True No GoogleCalendarEtag.
GoogleCalendarId String True No GoogleCalendarId.
InlineFlag Boolean True No InlineFlag.
IsBulkUpdateFlag String True No IsBulkUpdateFlag.
ItemId Integer True No ItemId.
LastNotificationTime Datetime True No LastNotificationTime.
LastNotificationUserId Integer True No LastNotificationUserId.
LeadId String True No LeadId.
Location String True No Location.
AdminAreaLevel1 String True No AdminAreaLevel1.
AdminAreaLevel2 String True No AdminAreaLevel2.
Country String True No Country.
FormattedAddress String True No FormattedAddress.
Lat Double True No Lat.
Locality String True No Locality.
Long Double True No Long.
PostalCode String True No PostalCode.
Route String True No Route.
StreetNumber String True No StreetNumber.
Sublocality String True No Sublocality.
Subpremise String True No Subpremise.
LogId String True No LogId.
LogTime Datetime True No LogTime.
MessageId String True No MessageId.
TemplateId String True No TemplateId.
MarkedAsDoneTime Datetime True No MarkedAsDoneTime.
Name String True No Name.
NewValue String True No NewValue.
Note String True No Note.
NotificationLanguageId Integer True No NotificationLanguageId.
OldValue Integer True No OldValue.
OrgId Integer True No OrgId.
OrgName String True No OrgName.
OwnerName String True No OwnerName.
Participants String True No Participants.
PeopleName String True No PeopleName.
PersonDropboxBcc String True No PersonDropboxBcc.
PersonId Integer True No PersonId.
PersonName String True No PersonName.
ProductId String True No ProductId.
ProductName String True No ProductName.
PublicDescription String True No PublicDescription.
RecActivityId String True No RecActivityId.
RecRule String True No RecRule.
RecRuleExtension String True No RecRuleExtension.
ReferenceId Integer True No ReferenceId.
ReferenceType String True No ReferenceType.
RemoteId String True No RemoteId.
RemoteLocation String True No RemoteLocation.
S3Bucket String True No S3Bucket.
Series String True No Series.
Sourcetimezone String True No Sourcetimezone.
Subject String True No Subject.
Type String True No Type.
UpdateTime Datetime True No UpdateTime.
UpdateUserId Integer True No UpdateUserId.
Url String True No Url.
UserId Integer True No UserId.
Object String True No Object.
Timestamp Datetime True No Timestamp.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes item specific updates.

Return to Top

OrganizationsUpdatesAttendees

Name Type ReadOnly References FilterOnly Description
OrgId [KEY] Integer True Organizations.Id No Activities ID.
EmailAddress String False No EmailAddress.
IsOrganizer Boolean True No IsOrganizer.
Name String True No Name.
PersonId Integer False Persons.Id No PersonId.
Status String True No Status.
UserId String True Users.Id No UserId.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes item specific updates.

Return to Top

OrganizationsUpdatesParticipants

Name Type ReadOnly References FilterOnly Description
OrgId [KEY] Integer True Organizations.Id No Activities ID.
PersonId Integer False No PersonId.
PrimaryFlag Boolean False No PrimaryFlag.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes item specific updates.

Return to Top

PermissionSets

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No ID of the permission set.
AssignmentCount Integer True No AssignmentCount.
Name String True No Name.
Type String True No Type.
Description String True No Description.
App String True No App.

Return to Top

PermissionSetsAssignments

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No ID of the permission set Assignments.
Name String True No Name.
PermissionSetId String True No PermissionSetId.
UserId Integer True No UserId.

Return to Top

PersonFields

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the field.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
AddVisibleFlag Boolean False No Whether the field is available in 'add new' modal or not (both in web and mobile app).
BulkEditAllowed Boolean True No BulkEditAllowed.
DetailsVisibleFlag Boolean True No DetailsVisibleFlag.
EditFlag Boolean True No EditFlag.
FieldType String False No Type of the field.
FilteringAllowed Boolean True No FilteringAllowed.
ImportantFlag Boolean True No ImportantFlag.
IndexVisibleFlag Boolean True No IndexVisibleFlag.
Key String True No Key.
LastUpdatedByUserId String True No LastUpdatedByUserId.
MandatoryFlag Boolean True No MandatoryFlag.
Name String False No Name of the field.
Options String False No Options.
OrderNr Integer True No OrderNr.
SearchableFlag Boolean True No SearchableFlag.
SortableFlag Boolean True No SortableFlag.
UpdateTime Datetime True No UpdateTime.

Return to Top

PersonFieldsOptions

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the field.
Label String True No Label.

Return to Top

PersonFollowers

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Followers id.
AddTime Datetime True No Add time.
PersonId Integer True No Person id.
UserId Integer False No User id.
DealId Integer True No Deal id.

Return to Top

Persons

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean False No ActiveFlag.
ActivitiesCount Integer True No ActivitiesCount.
AddTime Datetime False No Optional creation date time of the person Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
CcEmail String True No CcEmail.
ClosedDealsCount Integer True No ClosedDealsCount.
CompanyId Integer True No CompanyId.
CustomeField String True No CustomeField you will get the result of this column only when criteria filter title is used.
DoneActivitiesCount Integer True No DoneActivitiesCount.
Email String False No Email.
EmailMessagesCount Integer True No EmailMessagesCount.
FilesCount Integer True No FilesCount.
FirstChar String True No If supplied, only persons whose name starts with the specified letter will be returned.
FirstName String True No FirstName.
FollowersCount Integer True No FollowersCount.
Label Integer True No Label.
LastActivityDate Date True No LastActivityDate.
LastActivityId Integer True No LastActivityId.
LastIncomingMailTime Datetime True No LastIncomingMailTime.
LastName String True No LastName.
LastOutgoingMailTime Datetime True No LastOutgoingMailTime.
LostDealsCount Integer True No LostDealsCount.
Name String False No Name.
NextActivityDate Date True No NextActivityDate.
NextActivityId Integer True No NextActivityId.
NextActivityTime Time True No NextActivityTime.
Notes String True No Notes.
NotesCount Integer True No NotesCount.
OpenDealsCount Integer True No OpenDealsCount.
OrgActiveFlag Boolean True No OrgActiveFlag.
OrgAddress String True No OrgAddress.
OrgccEmail String True No OrgccEmail.
OrgName String True No OrgName.
OrgownerId Integer True No OrgownerId.
OrgpeopleCount Integer True No OrgpeopleCount.
Orgvalue Integer False No Orgvalue.
OwnerActiveFlag Boolean True No OwnerActiveFlag.
OwnerEmail String True No OwnerEmail.
OwnerHasPic Integer True No OwnerHasPic.
OwnerId Integer False No OwnerId.
OwnerIdName String True No OwnerName.
OwnerPicHash String True No OwnerPicHash.
OwnerValue Integer True No OwnerValue.
ParticipantClosedDealscount Integer True No ParticipantClosedDealscount.
ParticipantOpenDealsCount Integer True No ParticipantOpenDealsCount.
Phone String False No Phone.
PictureActiveFlag Boolean True No PictureActiveFlag.
PictureAddTime Datetime True No PictureAddTime.
PictureAddedByUserId Integer True No PictureAddedByUserId.
PictureItemId Integer True No PictureItemId.
PictureItemType String True No PictureItemType.
Picture128 String True No Picture128.
Picture512 String True No Picture512.
PictureUpdateTime String True No PictureUpdateTime.
Picturevalue Integer True No Picturevalue.
RelatedClosedDealsCount Integer True No RelatedClosedDealsCount.
RelatedLostDealsCount Integer True No RelatedLostDealsCount.
RelatedOpenDealsCount Integer True No RelatedOpenDealsCount.
RelatedWonDealsCount Integer True No RelatedWonDealsCount.
UndoneActivitiesCount Integer True No UndoneActivitiesCount.
UpdateTime Datetime True No UpdateTime.
VisibleTo String False No Visibility of the person.
WonDealsCount Integer True No WonDealsCount.
PrimaryEmail String True No Primary Email.
MarketingStatus String True No Marketing Status.
OwnerName String True No Owner Name.
FilterId Integer False Yes Filter Id.
UserId Integer False Yes User Id.

Return to Top

PersonsActivities

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No Active Flag.
AddTtime Datetime True No Add Ttime.
AssignedToUserId Integer True No Assigned To UserId.
Attendees String True No Attendees.
BusyFlag Boolean True No BusyFlag.
IncludeContext String True No Include Context.
CompanyId Integer True No Company Id.
MeetingClient String True No Meeting Client.
MeetingId String True No Meeting Id.
MeetingUrl String True No Meeting Url.
CreatedByUserId Integer True No CreatedBy UserId.
DealDropboxBcc String True No Deal Dropbox Bcc.
DealId Integer True No Deal Id.
DealTitle String True No Deal Title.
Done Boolean True No Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
DueDate Date True No Due Date.
DueTime Time True No Due Time.
Duration Time True No Duration.
FileCleanName String True No FileCleanName.
FileId String True No FileId.
FileUrl String True No FileUrl.
EventId String True No eventId.
CalendarEtag String True No CalendarEtag.
CalendarId String True No Calendar Id.
NotificationTime Datetime True No Notification Time.
NotificationUserId Integer True No Notification UserId.
LeadId String True No Lead Id.
Location String True No Location.
AreaLevel1 String True No AreaLevel1.
AreaLevel2 String True No AreaLevel2.
Country String True No Country.
FormattedAddress String True No FormattedAddress.
Lat Double True No Lat.
Locality String True No Locality.
Long Double True No Long.
PostalCode String True No PostalCode.
Route String True No Route.
StreetNumber String True No StreetNumber.
Sublocality String True No Sublocality.
Subpremise String True No Subpremise.
MarkedAsDoneTime Datetime True No MarkedAsDoneTime.
Note String True No Note.
NotificationLanguageId Integer True No NotificationLanguageId.
OrgId Integer True No OrgId.
OrgName String True No OrgName.
OwnerName String True No OwnerName.
Participants String True No Participants.
PersonDropboxBcc String True No Person Dropbox Bcc.
PersonId Integer True Persons.Id No PersonId.
PersonName String True No PersonName.
PublicDescription String True No PublicDescription.
MasterActivityId String True No MasterActivityId.
Rule String True No Rule.
RuleExtension String True No RuleExtension.
ReferenceId Integer True No ReferenceId.
ReferenceType String True No ReferenceType.
Series String True No Series.
SourceTimezone String True No SourceTimezone.
Subject String True No Subject.
Type String True No Type.
UpdateTime Datetime True No UpdateTime..
UpdateUserId Integer True No UpdateUserId..
UserId Integer True No UserId..
Exclude String False Yes A comma-separated string of activity IDs to exclude from result..

Return to Top

PersonsActivitiesAttendees

Name Type ReadOnly References FilterOnly Description
PersonId [KEY] Integer False Persons.Id No PersonId.
EmailAddress String False No EmailAddress.
IsOrganizer Integer True No IsOrganizer.
Name String True No Name.
Status String True No Status.
UserId String True Users.Id No UserId.
Done Boolean False Yes Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
Exclude String False Yes A comma-separated string of activity IDs to exclude from result.

Return to Top

PersonsActivitiesParticipants

Name Type ReadOnly References FilterOnly Description
PersonId [KEY] Integer False No PersonId.
PrimaryFlag Boolean False No PrimaryFlag.
Done Boolean False Yes Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
Exclude String False Yes A comma-separated string of activity IDs to exclude from result.

Return to Top

PersonsDeals

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
Active Boolean True No Active.
ActivitiesCount Integer True No ActivitiesCount.
AddTime Datetime True No AddTime.
CcEmail String True No CcEmail.
CloseTime String True No CloseTime.
CreatoractiveFlag Boolean True No CreatoractiveFlag.
Creatoremail String True No Creatoremail.
CreatorhasPic Boolean True No CreatorhasPic.
Creatorid Integer True No Creatorid.
Creatorname String True No Creatorname.
CreatorPicHash String True No CreatorPicHash.
Creatorvalue Integer True No Creatorvalue.
Currency String True No Currency.
Deleted Boolean True No Deleted.
DoneActivitiesCount Integer True No DoneActivitiesCount.
EmailMessagesCount Integer True No EmailMessagesCount.
ExpectedCloseDate Date True No ExpectedCloseDate.
FilesCount Integer True No FilesCount.
FirstWonTime Datetime True No FirstWonTime.
FollowersCount Integer True No FollowersCount.
FormattedValue String True No FormattedValue.
FormattedWeightedValue String True No FormattedWeightedValue.
Label String True No Label.
LastActivityDate String True No LastActivityDate.
LastActivityId String True No LastActivityId.
LastIncomingMailTime Datetime True No LastIncomingMailTime.
LastOutgoingMailTime Datetime True No LastOutgoingMailTime.
LostReason String True No LostReason.
LostTime String True No LostTime.
NextActivityDate Date True No NextActivityDate.
NextActivityDuration Time True No NextActivityDuration.
NextActivityId Integer True No NextActivityId.
NextActivitynote String True No NextActivitynote.
NextActivitysubject String True No NextActivitysubject.
NextActivitytime Time True No NextActivitytime.
NextActivitytype String True No NextActivitytype.
NotesCount Integer True No NotesCount.
OrgHidden Boolean True No OrgHidden.
OrgActive_flag Boolean True No OrgActive_flag.
OrgAddress String True No OrgAddress.
OrgCcEmail String True No OrgCcEmail.
OrgIdName String True No OrgName.
OrgOwnerId Integer True No OrgOwnerId.
OrgPeopleCount Integer True No OrgPeopleCount.
OrgValue Integer True No OrgValue.
OwnerName String True No OwnerName.
ParticipantsCount Integer True No ParticipantsCount.
PersonHidden Boolean True No PersonHidden.
PersonActiveFlag Boolean True No PersonActiveFlag.
PersonEmail String True No PersonEmail.
PersonIdName String True No PersonName.
PersonPhone String True No PersonPhone.
PersonValue Integer True No PersonValue.
PipelineId Integer True No PipelineId.
Probability String True No Probability.
ProductsCount Integer True No ProductsCount.
RottenTime String True No RottenTime.
StageChangeTime Datetime True No StageChangeTime.
StageId Integer True No StageId.
StageOrderNr Integer True No StageOrderNr.
Status String True No Only fetch deals with specific status.
Title String True No Title.
UndoneActivitiesCount Integer True No UndoneActivitiesCount.
UpdateTime Datetime True No UpdateTime.
UserActiveFlag Boolean True No UserActiveFlag.
UserEmail String True No UserEmail.
UserHasPic Boolean True No UserHasPic.
UserId Integer True No UserId.
UserName String True No UserName.
UserPicHash String True No UserPicHash.
UserValue Integer True No UserValue.
Value Integer True No Value.
VisibleTo String True No VisibleTo.
WeightedValue Integer True No WeightedValue.
WeightedValueCurrency String True No WeightedValueCurrency.
WonTime Datetime True No WonTime.
PersonName String True No Person Name.
OrgName String True No Org Name.

Return to Top

PersonsDealsEmail

Name Type ReadOnly References FilterOnly Description
PersonsDealsId [KEY] Integer True No Id.
Label String True No Label.
Value String True No Value.
Primary Boolean True No Primary.

Return to Top

PersonsDealsPhone

Name Type ReadOnly References FilterOnly Description
PersonsDealsId [KEY] Integer True No Id.
Label String True No Label.
Value String True No Value.
Primary Boolean True No Primary.

Return to Top

PersonsEmails

Name Type ReadOnly References FilterOnly Description
PersonId Integer True Persons.Id No Persons Id.
label String False No Label.
Value String False No Value.
Primary Boolean False No Primary.
FirstChar String False Yes If supplied, only persons whose name starts with the specified letter will be returned.
FilterId Integer False Yes Filter Id.
UserId Integer False Yes User Id.

Return to Top

PersonsFiles

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id of the files.
ActiveFlag Boolean True No Active Flag.
ActivityId String True No Activity Id.
AddTime Datetime True No AddTime.
Cid String True No Cid.
DealId String True No Deal Id.
DealName String True No DealName.
Description String True No Description.
FileName String True No File Name.
FileSize Integer True No File Size.
FileType String True No File Type.
InlineFlag Boolean True No Inline Flag.
LogId String True No Log Id.
MailMessageId String True No MailMessage Id.
MailTemplateId String True No MailTemplate Id.
Name String True No Name.
OrgId Integer True No Org Id.
OrgName String True No Org Name.
PeopleName String True No People Name.
PersonId String True Persons.Id No PersonId.
PersonName String True No Person Name.
ProductId String True No Produc tId.
ProductName String True No Product Name.
RemoteId String True No Remote Id.
RemoteLocation String True No Remote Location.
S3Bucket String True No S3Bucket.
UpdateTime Datetime True No Update Time.
Url String True No Url.
UserId Integer True No UserId.
LeadId String True No LeadId.
LeadName String True No LeadName.

Return to Top

PersonsMailMessages

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
PersonId Integer True Persons.Id No Persons Id.
AccountId String True No AccountId.
AddTime Datetime True No addTime.
Bcc String True No Bcc.
BodyUrl String True No bodyUrl.
Cc String True No cc.
CompanyId Integer True No companyId.
DeletedFlag Boolean True No DeletedFlag.
Draft String True No Draft.
DraftFlag Boolean True No DraftFlag.
ExternalDeletedFlag Boolean True No ExternalDeletedFlag.
From String True No From.
AttachmentsFlag Boolean True No AttachmentsFlag.
BodyFlag Boolean True No BodyFlag.
InlineAttachmentsFlag Boolean True No InlineAttachmentsFlag.
RealAttachmentsFlag Boolean True No RealAttachmentsFlag.
ItemType String True No ItemType.
TrackingEnabledFlag Boolean True No TrackingEnabledFlag.
ThreadId Integer True No ThreadId.
TrackingStatus String True No TrackingStatus.
MessageTime String True No MessageTime.
MessageId String True No MessageId.
NylasId String True No NylasId.
ReadFlag Boolean True No ReadFlag.
S3Bucket String True No S3Bucket.
S3BucketPath String True No S3BucketPath.
SentFlag Boolean True No SentFlag.
SentFromPipedriveFlag Boolean True No SentFromPipedriveFlag.
SmartBccFlag Boolean True No SmartBccFlag.
Snippet String True No Snippet.
Subject String True No Subject.
SyncedFlag Boolean True No SyncedFlag.
TemplateId String True No TemplateId.
Timestamp Datetime True No Timestamp.
To String True No To.
UpdateTime Datetime True No UpdateTime.
UserId Integer True No UserId.
WriteFlag Boolean True No writeFlag.
Object String True No Object.

Return to Top

PersonsMailMessagesBcc

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

PersonsMailMessagesCc

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

PersonsMailMessagesFrom

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

PersonsMailMessagesTo

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
EmailAddress String True No EmailAddress.
PersonId String True No PersonId.
PersonName String True No PersonName.
MessagePartyId Integer True No MessagePartyId.
Name String True No Name.

Return to Top

PersonsPermittedUsers

Name Type ReadOnly References FilterOnly Description
PersonId Integer True Persons.Id No Persons Id.
Data String True No Users permitted to access an organization.

Return to Top

PersonsPhone

Name Type ReadOnly References FilterOnly Description
PersonId Integer True Persons.Id No Persons ID.
label String False No Label.
Value String False No Value.
Primary Boolean False No Primary.
FirstChar String False Yes If supplied, only persons whose name starts with the specified letter will be returned.
FilterId Integer False Yes Filter Id.
UserId Integer False Yes User Id.

Return to Top

PersonsProducts

Name Type ReadOnly References FilterOnly Description
ProductId [KEY] Integer True No ProductId.
DealActive Boolean True No DealActive.
DealActivitiesCount Integer True No DealActivitiesCount.
DealAddTime Datetime True No DealAddTime.
DealCloseTime String True No DealCloseTime.
DealCompanyId Integer True No DealCompanyId.
DealCreatorUserId Integer True No DealCreatorUserId.
DealCurrency String True No DealCurrency.
DealDeleted Boolean True No DealDeleted.
DealDoneActivitiesCount Integer True No DealDoneActivitiesCount.
DealEmailMessagesCount Integer True No DealEmailMessagesCount.
DealExpectedCloseDate String True No DealExpectedCloseDate.
DealFilesCount Integer True No DealFilesCount.
DealFirstAddtime Datetime True No DealFirstAddtime.
DealFirstWonTime String True No DealFirstWonTime.
DealFollowersCount Integer True No DealFollowersCount.
DealId Integer True No DealId.
DealLabel String True No DealLabel.
DealLastActivityDate String True No DealLastActivityDate.
DealLastActivityId String True No DealLastActivityId.
DealLastIncomingMailTime Datetime True No DealLastIncomingMailTime.
DealLastOutgoingMailTime Datetime True No DealLastOutgoingMailTime.
DealLostReason String True No DealLostReason.
DealLostTime String True No DealLostTime.
DealNextActivityDate Date True No DealNextActivityDate.
DealNextActivityId Integer True No DealNextActivityId.
DealNextActivityTime String True No DealNextActivityTime.
DealNotesCount Integer True No DealNotesCount.
DealOrgId Integer True No DealOrgId.
DealParticipantsCount Integer True No DealParticipantsCount.
DealPersonId Integer True Persons.Id No persons Id.
DealPipelineId Integer True No DealPipelineId.
DealProbability String True No DealProbability.
DealProductsCount Integer True No DealProductsCount.
DealStageChangetime Datetime True No DealStageChangetime.
DealStageId Integer True No DealStageId.
DealStatus String True No DealStatus.
DealTitle String True No DealTitle.
UndoneActivitiescount Integer True No UndoneActivitiescount.
DealUpdateTime Datetime True No DealUpdateTime.
DealUserId Integer True No DealUserId.
DealValue Double True No DealValue.
DealVisibleTo String True No DealVisibleTo.
DealWonTime String True No DealWonTime.
ProductActiveFlag Boolean True No ProductActiveFlag.
ProductAddTime Datetime True No ProductAddTime.
ProductCategory String True No ProductCategory.
ProductCode String True No ProductCode.
ProductCompanyId Integer True No ProductCompanyId.
ProductDealId Integer True No ProductDealId.
ProductDescription String True No ProductDescription.
ProductFilesCount String True No ProductFilesCount.
ProductFirstChar String True No ProductFirstChar.
ProductFollowersCount Integer True No ProductFollowersCount.
ProductName String True No ProductName.
ProductOwnerId Integer True No ProductOwnerId.
ProductSelectable Boolean True No ProductSelectable.
ProductTax Integer True No ProductTax.
ProductUnit String True No ProductUnit.
ProductUpdateTime Datetime True No ProductUpdateTime.
ProductVisibleTo String True No ProductVisibleTo.

Return to Top

PersonsUpdates

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
NewValueFormatted String True No NewValueFormatted.
AssignedToUserId Integer True No AssignedToUserId.
Attendees String True No Attendees.
BusyFlag Boolean True No BusyFlag.
SyncIncludecontext String True No SyncIncludecontext.
changeSource String True No changeSource.
UserAgent String True No UserAgent.
CompanyId Integer True No CompanyId.
MeetingClient String True No MeetingClient.
MeetingId String True No MeetingId.
MeetingUrl String True No MeetingUrl.
CreatedByUserId Integer True No CreatedByUserId.
DealDropboxBcc String True No DealDropboxBcc.
DealId Integer True No DealId.
DealTitle String True No DealTitle.
Done Boolean True No Done.
DueDate Date True No DueDate.
DueTime Time True No DueTime.
Duration Time True No Duration.
FieldKey String True No FieldKey.
Fileclean_name String True No Fileclean_name.
FileId String True No FileId.
FileUrl String True No FileUrl.
GcaleventId String True No GcaleventId.
GoogleCalendarEtag String True No GoogleCalendarEtag.
GoogleCalendarId String True No GoogleCalendarId.
IsBulkUpdateFlag String True No IsBulkUpdateFlag.
ItemId Integer True No ItemId.
NotificationTime Datetime True No NotificationTime.
NotificationUserId Integer True No NotificationUserId.
LeadId String True No LeadId.
Location String True No Location.
AdminAreaLevel1 String True No AdminAreaLevel1.
AdminAreaLevel2 String True No AdminAreaLevel2.
Country String True No Country.
FormattedAddress String True No FormattedAddress.
Lat Double True No Lat.
Locality String True No Locality.
Long Double True No Long.
PostalCode String True No PostalCode.
Route String True No Route.
StreetNumber String True No StreetNumber.
Sublocality String True No Sublocality.
Subpremise String True No Subpremise.
LogTime Datetime True No LogTime.
MarkedAsDoneTime Datetime True No MarkedAsDoneTime.
NewValue String True No NewValue.
Note String True No Note.
LanguageId Integer True No LanguageId.
OldValue String True No OldValue.
OrgId Integer True organizations.Id No Organizations Id.
OrgName String True No Organizations Name.
OwnerName String True No Owner Name.
Participants String True No Participants.
PersonDropboxBcc String True No Person Dropbox Bcc.
PersonId Integer True Persons.Id No Persons Id.
PersonName String True No PersonName.
Publicdescription String True No Publicdescription.
RecMasterActivityId String True No RecMasterActivityId.
RecRule String True No RecRule.
RecRuleExtension String True No RecRuleExtension.
ReferenceId Integer True No ReferenceId.
ReferenceType String True No ReferenceType.
Series String True No Series.
SourceTimezone String True No SourceTimezone.
Subject String True No Subject.
Type String True No Type.
UpdateTime Datetime True No UpdateTime.
UpdateUserId Integer True No UpdateUserId.
UserId Integer True No UserId.
Object String True No Object.
Timestamp Datetime True No Timestamp.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes item specific updates.

Return to Top

PersonsUpdatesAttendees

Name Type ReadOnly References FilterOnly Description
PersonId [KEY] Integer True Persons.Id No PersonId.
EmailAddress String True No EmailAddress.
IsOrganizer Integer True No IsOrganizer.
Name String True No Name.
Status String True No Status.
UserId String True Users.Id No UserId.
AllChanges String False Yes Whether to show custom field updates or not.
Items String False Yes Item specific updates.

Return to Top

PersonsUpdatesParticipants

Name Type ReadOnly References FilterOnly Description
PersonId [KEY] Integer True No PersonId.
PrimaryFlag Boolean True No PrimaryFlag.
AllChanges String False Yes Whether to show custom field updates or not
Items String False Yes item specific updates

Return to Top

PipelineDeals

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the pipeline.
Active Boolean True No Active.
ActivitiesCount Integer True No ActivitiesCount.
AddTime Datetime True No AddTime.
CcEmail String True No CcEmail.
CloseTime String True No CloseTime.
CreatorUserId Integer True No CreatorUserId.
Currency String True No Currency.
Deleted Boolean True No Deleted.
DoneActivitiesCount Integer True No DoneActivitiesCount.
EmailMessagesCount Integer True No EmailMessagesCount.
ExpectedCloseDate Date True No ExpectedCloseDate.
FilesCount Integer True No FilesCount.
FirstWonTime Datetime True No FirstWonTime.
FollowersCount Integer True No FollowersCount.
FormattedValue String True No FormattedValue.
FormattedWeightedValue String True No FormattedWeightedValue.
Label String True No Label.
LastActivityDate String True No LastActivityDate.
LastActivityId String True No LastActivityId.
LastIncomingMailTime Datetime True No LastIncomingMailTime.
LastOutgoingMailTime Datetime True No LastOutgoingMailTime.
LostReason String True No LostReason.
LostTime String True No LostTime.
NextActivityDate Date True No NextActivityDate.
NextActivityDuration Time True No NextActivityDuration.
NextActivityId Integer True No NextActivityId.
NextActivityNote String True No NextActivityNote.
NextActivitySubject String True No NextActivitySubject.
NextActivityTime Time True No NextActivityTime.
NextActivityType String True No NextActivityType.
NotesCount Integer True No NotesCount.
OrgHidden Boolean True No OrgHidden.
OrgId Integer True No OrgId.
OrgName String True No OrgName.
OwnerName String True No OwnerName.
ParticipantsCount Integer True No ParticipantsCount.
PersonHidden Boolean True No PersonHidden.
PersonId Integer True No PersonId.
PersonName String True No PersonName.
PipelineId Integer True No PipelineId.
Probability String True No Probability.
ProductsCount Integer True No ProductsCount.
RottenTime String True No RottenTime.
StageChangeTime Datetime True No StageChangeTime.
StageId Integer True No If supplied, only deals within the given stage will be returned.
StageOrderNr Integer True No StageOrderNr.
Status String True No Status.
Title String True No Title.
UndoneActivitiesCount Integer True No UndoneActivitiesCount.
UpdateTime Datetime True No UpdateTime.
UserId Integer True No UserId.
Value Integer True No Value.
VisibleTo String True No VisibleTo.
WeightedValue Integer True No WeightedValue.
WeightedValueCurrency String True No WeightedValueCurrency.
WonTime Datetime True No WonTime.
FilterId Integer False Yes If supplied, only deals matching the given filter will be returned.

Return to Top

PipelineDealsConversionRates

Name Type ReadOnly References FilterOnly Description
PipelineId Integer True No ID of the pipeline.
LostConversion Integer True No LostConversion.
StageConversions String True No StageConversions.
WonConversion Integer True No WonConversion.
UserId Integer False Yes ID of the user who's pipeline statistics to fetch.
StartDate Datetime False Yes Start of the period.
EndDate Datetime False Yes End of the period.

Return to Top

PipelineDealsMovements

Name Type ReadOnly References FilterOnly Description
PipelineId Integer True No ID of the pipeline.
AverageAgeInDaysAcrossAllStages Integer True No AverageAgeInDaysAcrossAllStages.
AverageAgeInDaysByStages String True No AverageAgeInDaysByStages.
DealsLeftOpenCount Integer True No DealsLeftOpenCount.
DealsLeftOpenDealsIds String True No DealsLeftOpenDealsIds.
DealsLeftOpenFormattedValuesUSD String True No DealsLeftOpenFormattedValuesUSD.
DealsLeftOpenValuesUSD Integer True No DealsLeftOpenValuesUSD.
LostDealsCount Integer True No LostDealsCount.
LostDealsDealsIds String True No LostDealsDealsIds.
LostDealsFormattedValuesUSD String True No LostDealsFormattedValuesUSD.
LostDealsValuesUSD Integer True No LostDealsValuesUSD.
MovementsBetweenStagesCount Integer True No MovementsBetweenStagesCount.
NewDealsCount Integer True No NewDealsCount.
NewDealsDealsIds String True No NewDealsDealsIds.
NewDealsFormattedValuesUSD String True No NewDealsFormattedValuesUSD.
NewDealsValuesUSD Integer True No NewDealsValuesUSD.
WonDealsCount Integer True No WonDealsCount.
WonDealsDealsIds String True No WonDealsDealsIds.
WonDealsFormattedValuesUSD String True No WonDealsFormattedValuesUSD.
WonDealsValuesUSD Integer True No WonDealsValuesUSD.
UserId Integer False Yes ID of the user who's pipeline statistics to fetch.
StartDate Datetime False Yes Start of the period. Date in format of YYYY-MM-DD
EndDate Datetime False Yes End of the period. Date in format of YYYY-MM-DD

Return to Top

PipelineDealsMovementsAverageAgeInDaysByStages

Name Type ReadOnly References FilterOnly Description
PipelineId Integer True No ID of the pipeline.
StageId Integer True No AverageAgeInDaysAcrossAllStages.
Value Integer True No AverageAgeInDaysAcrossAllStages.
UserId Integer False Yes ID of the user who's pipeline statistics to fetch.
StartDate Datetime False Yes Start of the period. Date in format of YYYY-MM-DD
EndDate Datetime False Yes End of the period. Date in format of YYYY-MM-DD

Return to Top

PipelineDealsStageConversions

Name Type ReadOnly References FilterOnly Description
PipelineId Integer True No ID of the pipeline
ConversionRate Integer True No ConversionRate
FromStageId String True No FromStageId
ToStageId Integer True No ToStageId
UserId Integer False Yes ID of the user who's pipeline statistics to fetch
StartDate Date False Yes Start of the period
EndDate Date False Yes End of the period

Return to Top

Pipelines

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the pipeline.
Name String False No The name of the Pipeline.
Active Boolean False No Whether this Pipeline will be made inactive (hidden) or active.
DealProbability Integer False No Whether Deal probability is disabled or enabled for this Pipeline.
OrderNr Integer False No Defines the order of Pipelines.
Selected Boolean True No Selected.
UpdateTime Datetime True No UpdateTime.
AddTime Datetime True No AddTime.
UrlTitle String False No UrlTitle.

Return to Top

ProductFields

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the Product Field.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
AddVisibleFlag Boolean True No AddVisibleFlag.
BulkEditAllowed Boolean True No BulkEditAllowed.
DetailsVisibleFlag Boolean True No DetailsVisibleFlag.
EditFlag Boolean True No EditFlag.
FieldType String False No Type of the field.
FilteringAllowed Boolean True No FilteringAllowed.
ImportantFlag Boolean True No ImportantFlag.
IndexVisibleFlag Boolean True No IndexVisibleFlag.
Key String True No Key.
LastUpdatedByUserId String True No LastUpdatedByUserId.
MandatoryFlag Boolean True No MandatoryFlag.
Name String False No Name of the field.
Options String False No Options.
OrderNr Integer True No OrderNr.
PicklistData String True No PicklistData.
SearchableFlag Boolean True No SearchableFlag.
SortableFlag Boolean True No SortableFlag.
UpdateTime Datetime True No UpdateTime.

Return to Top

ProductFieldsOptions

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the Product Field Options.
Label String True No Label.

Return to Top

Products

Name Type ReadOnly References FilterOnly Description
Id Integer True No product Id
ActiveFlag Boolean True No Whether this product will be made active or not
AddTime Datetime True No Add Time
Category String True No category
Code String False No Product code.
CustomeField String True No CustomeField you will get the result of this column only when criteria filter title is used
Description String True No description
FilesCount String True No FilesCount
FirstChar String True No If supplied only Products whose name starts with the specified letter will be returned
Name String False No Name of the product
OwnerActiveFlag Boolean True No OwnerActiveFlag
OwnerEmail String True No OwnerEmail
OwnerHasPic Boolean True No OwnerHasPic
OwnerId Integer False No ID of the user who will be marked as the owner of this product
OwnerName String True No OwnerName
OwnerPicHash String True No OwnerPicHas
Ownervalue Integer True No Owner Id
Prices String False No Object containing price objects
Selectable Boolean False No Whether this product can be selected in Deals or not
Tax Integer False No Tax percentage
Type String True No Type you will get the result of this column only when criteria filter title is used
Unit String False No Unit in which this product is sold
UpdateTime Datetime True No Update Time
VisibleTo String False No Visibility of the product
SummaryTotalCount String True No You will get data of this column when Criterial filter is GetSummary is used
UserId Integer False Yes User Id
FilterId Integer False Yes Filter Id
GetSummary Boolean False Yes Get SUmmary
Ids Integer False Yes The Ids of the Products that should be returned in the response

Return to Top

ProductsDeals

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
ProductId Integer True No Products Id.
Active Boolean True No Active.
ActivitiesCount Integer True No ActivitiesCount.
AddTime Datetime True No AddTime.
CcEmail String True No CcEmail.
CloseTime String True No CloseTime.
CreatorActiveFlag Boolean True No CreatorActiveFlag.
CreatorEmail String True No CreatorEmail.
CreatorHasPic Boolean True No CreatorHasPic.
CreatorId Integer True No CreatorId.
CreatorName String True No CreatorName.
CreatorPicHash String True No CreatorPicHash.
CreatorValue Integer True No CreatorValue.
Currency String True No Currency.
Deleted Boolean True No Deleted.
DoneActivitiesCount Integer True No DoneActivitiesCount.
EmailMessagesCount Integer True No EmailMessagesCount.
ExpectedCloseDate String True No ExpectedCloseDate.
FilesCount Integer True No FilesCount.
FirstWonTime String True No FirstWonTime.
FollowersCount Integer True No FollowersCount.
FormattedValue String True No FormattedValue.
FormattedWeightedValue String True No FormattedWeightedValue.
Label String True No Label.
LastActivityDate String True No LastActivityDate.
LastActivityId String True No LastActivityId.
LastIncomingMailTime String True No LastIncomingMailTime.
LastOutgoingMailTime String True No LastOutgoingMailTime.
LostReason String True No LostReason.
LostTime String True No LostTime.
NextActivityDate Date True No NextActivityDate.
NextActivityDuration Time True No NextActivityDuration.
NextActivityId Integer True No NextActivityId.
NextActivityNote String True No NextActivityNote.
NextActivitySubject String True No NextActivitySubject.
NextActivityTime Time True No NextActivityTime.
NextActivityType String True No NextActivityType.
NotesCount Integer True No NotesCount.
OrgHidden Boolean True No OrgHidden.
OrgIdName String True No OrgId Name.
OrgIdPeopleCount Integer True No OrgId People count.
OrgIdOwnerId Integer True No OrgId Owner Id.
OrgIdAddress String True No OrgId Address.
OrgIdActiveFlag Boolean True No OrgId Active flag.
OrgIdCcEmail String True No OrgId CcEmail.
OrgIdValue Integer True No OrgId Value.
OrgName String True No OrgName.
OwnerName String True No OwnerName.
ParticipantsCount Integer True No ParticipantsCount.
PersonHidden Boolean True No PersonHidden.
PersonActiveFlag Boolean True No PersonActiveFlag.
PersonEmail String True No PersonEmail.
PersonIdName String True No PersonName.
PersonPhone String True No PersonPhone.
PersonValue Integer True No PersonValue.
PipelineId Integer True No PipelineId.
Probability String True No Probability.
ProductsCount Integer True No ProductsCount.
RottenTime String True No RottenTime.
StageChangeTime String True No StageChangeTime.
StageId Integer True No StageId.
StageOrderNr Integer True No StageOrderNr.
Status String True No Only fetch deals with specific status.
Title String True No Title.
UndoneActivitiesCount Integer True No UndoneActivitiesCount.
UpdateTime Datetime True No UpdateTime.
UserActiveFlag Boolean True No UserActiveFlag.
UserEmail String True No UserEmail.
UserHasPic Boolean True No UserHasPic.
UserId Integer True No UserId.
UserName String True No UserName.
UserPicHash String True No UserPicHash.
Uservalue Integer True No Uservalue.
Value Double True No Value.
VisibleTo String True No VisibleTo.
WeightedValue Double True No WeightedValue.
WeightedValueCurrency String True No WeightedValueCurrency.
WonTime String True No WonTime.
PersonName String True No Person name.

Return to Top

ProductsDealsPersonEmail

Name Type ReadOnly References FilterOnly Description
ProductId Integer True No Products Id.
Label String True No Label.
Primary Boolean True No Primary.
Value String True No Value.
Status String False Yes Only fetch deals with specific status.

Return to Top

ProductsDealsPersonphone

Name Type ReadOnly References FilterOnly Description
ProductId Integer True No Products Id.
Label String True No Label.
Primary Boolean True No Primary.
Value String True No Value.
Status String False Yes Only fetch deals with specific status.

Return to Top

ProductsFiles

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id of the products.
ActiveFlag Boolean True No Active Flag.
ActivityId String True No Activity Id.
AddTime Datetime True No AddTime.
Cid String True No Cid.
DealId String True No Deal Id.
DealName String True No DealName.
Description String True No Description.
FileName String True No File Name.
FileSize Integer True No File Size.
FileType String True No File Type.
InlineFlag Boolean True No Inline Flag.
LogId String True No Log Id.
MailMessageId String True No MailMessage Id.
MailTemplateId String True No MailTemplate Id.
Name String True No Name.
OrgId Integer True No Org Id.
OrgName String True No Org Name.
PeopleName String True No People Name.
PersonId String True No PersonId.
PersonName String True No Person Name.
ProductId String True Products.id No Product Id.
ProductName String True No Product Name.
RemoteId String True No Remote Id.
RemoteLocation String True No Remote Location.
S3Bucket String True No S3Bucket.
UpdateTime Datetime True No Update Time.
Url String True No Url.
UserId Integer True No UserId.
IncludeDeletedFiles Integer False Yes When enabled, the list of files will also include deleted files.

Return to Top

ProductsFollowers

Name Type ReadOnly References FilterOnly Description
Id Integer True No Id.
AddTime Datetime True No AddTime.
ProductId Integer True No ProductId.
UserId Integer False No UserId.

Return to Top

ProductsPermittedUsers

Name Type ReadOnly References FilterOnly Description
ProductId Integer True Products.Id No Products Id.
Data String True No Data.

Return to Top

ProductsPrices

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Id.
Cost Integer True No Cost.
Currency String True No Currency.
OverheadCost String True No OverheadCost.
Price Integer True No Price.
ProductId Integer True No ProductId.
FirstChar String False Yes If supplied only Products whose name starts with the specified letter will be returned.
UserId Integer False Yes User Id.
FilterId Integer False Yes Filter Id.
GetSummary Boolean False Yes Get Summary.
Ids Integer False Yes The Ids of the Products that should be returned in the response.

Return to Top

Recents

Name Type ReadOnly References FilterOnly Description
Id Integer True No Id.
DataActive Boolean True No DataActive.
DataActiveFlag Boolean True No DataActiveFlag.
DataActivitiesCount Integer True No DataActivitiesCount.
DataAddTime Datetime True No DataAddTime.
DataAssignedToUserId Integer True No DataAssignedToUserId.
DataAttendees String True No DataAttendees.
DataBusyFlag String True No Data BusyFlag.
DataCalendarSyncContext String True No DataCalendarSyncContext.
DataCcEmail String True No DataCcEmail.
DataCloseTime String True No DataCloseTime.
DataCompanyId Integer True No DataCompanyId.
DataConferenceMeetingClient String True No DataConferenceMeetingClient.
DataConferenceMeetingId String True No DataConferenceMeetingId.
DataConferenceMeetingUrl String True No DataConferenceMeetingUrl.
DataCreatedByUserId Integer True No DataCreatedByUserId.
DataCreatorUserId Integer True No DataCreatorUserId.
DataCurrency String True No DataCurrency.
DataDealDropboxBcc String True No DataDealDropboxBcc.
DataDealId String True No DataDealId.
DataDealTitle String True No DataDealTitle.
DataDeleted Boolean True No DataDeleted.
DataDone Boolean True No DataDone.
DataDoneActivitiesCount Integer True No DataDoneActivitiesCount.
DataDueDate Date True No DataDueDate.
DataDueTime Datetime True No DataDueTime.
DataDuration Datetime True No DataDuration.
DataEmailMessagesCount Integer True No DataEmailMessagesCount.
DataExpectedCloseDate Date True No DataExpectedCloseDate.
DataFileId String True No DataFile Id.
DataFileCleanName String True No DataFile clean name.
DataFileUrl String True No DataFile url.
DataFilesCount Integer True No DataFilesCount.
DataFirstWonTime String True No DataFirstWonTime.
DataFollowersCount Integer True No DataFollowersCount.
DataFormattedValue String True No DataFormattedValue.
DataFormattedWeightedValue String True No DataFormattedWeightedValue.
DataGcalEventId String True No DataGcalEventId.
DataGoogleCalendarEtag String True No DataGoogleCalendarEtag.
DataGoogleCalendarId String True No DataGoogleCalendarId.
DataId Integer True No DataId.
DataLabel String True No DataLabel.
ActivityDate String True No ActivityDate.
ActivityId String True No ActivityId.
IncomingMailTime String True No IncomingMailTime.
LastNotificationTime String True No Last_notification_time.
LastNotificationUserId String True No Last_notification_user_id.
LastOutgoingMailTime String True No Last_outgoing_mail_time.
LeadId String True No LeadId.
LeadTitle String True No LeadTitle.
Location String True No Location.
AreaLevel1 String True No AreaLevel1.
AreaLevel2 String True No AreaLevel2.
LocationCountry String True No LocationCountry.
LocationFormattedAddress String True No LocationFormattedAddress.
Locationlocality String True No Locationlocality.
LocationPostalCode String True No LocationPostalCode.
LocationRoute String True No LocationRoute.
LocationStreetNumber String True No LocationStreetNumber.
LocationSublocality String True No LocationSublocality.
LocationSubpremise String True No LocationSubpremise.
LostReason String True No LostReason.
LostTime String True No LostTime.
MarkedAsDoneTime String True No MarkedAsDoneTime.
NextActivityDate String True No NextActivityDate.
NextActivityDuration String True No NextActivityDuration.
NextActivityId String True No NextActivityId.
NextActivityNote String True No NextActivityNote.
NextActivitySubject String True No NextActivitySubject.
NextActivityTime String True No NextActivityTime.
NextActivityType String True No NextActivityType.
Note String True No Note.
NotesCount Integer True No NotesCount.
NotificationLanguageId Integer True No NotificationLanguageId.
OrgHidden Boolean True No OrgHidden.
OrgId Integer True No OrgId.
OrgName String True No OrgName.
OwnerName String True No OwnerName.
Participants String True No Participants.
ParticipantsCount Integer True No ParticipantsCount.
PersonDropboxBcc String True No PersonDropboxBcc.
PersonHidden Boolean True No PersonHidden.
PersonId Integer True No PersonId.
PersonName String True No PersonName.
PipelineId Integer True No PipelineId.
Probability String True No Probability.
ProductsCount Integer True No ProductsCount.
PublicDescription String True No PublicDescription.
RecMasterActivityId String True No RecMasterActivityId.
RecRule String True No RecRule.
RecRuleExtension String True No RecRuleExtension.
ReferenceId String True No ReferenceId.
ReferenceType String True No ReferenceType.
RottenTime String True No RottenTime.
Series String True No Series.
SourceTimezone String True No SourceTimezone.
StageChangeTime String True No StageChangeTime.
StageId Integer True No StageId.
StageOrderNr Integer True No StageOrderNr.
Status String True No Status.
Subject String True No Subject.
DataTitle String True No DataTitle.
DataType String True No DataType.
UndoneActivitiesCount Integer True No UndoneActivitiesCount.
UpdateTime Datetime True No UpdateTime.
UpdateUserId String True No UpdateUserId.
UserId Integer True No UserId.
Value Integer True No Value.
VisibleTo String True No VisibleTo.
WeightedValue Integer True No WeightedValue.
WeightedValueCurrency String True No WeightedValueCurrency.
WonTime String True No WonTime.
Item String True No Item.
SinceTimestamp Datetime False Yes Timestamp in UTC.

Return to Top

RecentsAttendees

Name Type ReadOnly References FilterOnly Description
EmailAddress String True No Email Address.
IsOrganizer Integer True No Is Organizer.
Name String True No Name.
PersonId Integer True No Person Id.
Status String True No Status.
UserId Integer True No UserId.
SinceTimestamp Datetime False Yes Timestamp in UTC.

Return to Top

RecentsParticipants

Name Type ReadOnly References FilterOnly Description
PersonId Integer True No Person Id.
PrimaryFlag Boolean True No Primary Flag.
SinceTimestamp Datetime False Yes Timestamp in UTC.

Return to Top

Roles

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the role.
ActiveFlag Boolean True No ActiveFlag.
AssignmentCount String True No AssignmentCount.
Level Integer True No Level.
Name String False No The name of the Role.
ParentRoleId Integer False No The ID of the parent Role.
SubRoleCount String True No SubRoleCount.

Return to Top

RolesAssignments

Name Type ReadOnly References FilterOnly Description
RoleId Integer False No RoleId.
ActiveFlag Boolean True No ActiveFlag.
Name String True No Name.
ParentRoleId String True No ParentRoleId.
Type String True No Type.
UserId Integer False No ID of the user.

Return to Top

RolesPipelinesVisibility

Name Type ReadOnly References FilterOnly Description
RoleId [KEY] Integer True No ID of the Role.
PipelineIds String False No Ids of the Pipeline.
Visible Boolean True No Visible.

Return to Top

RolesSetting

Name Type ReadOnly References FilterOnly Description
RoleId [KEY] Integer True No Role Id.
DealDefaultVisibility Integer True No DealDefaultVisibility.
LeadDefaultVisibility Integer True No LeadDefaultVisibility.
OrgDefaultVisibility Integer True No OrgDefaultVisibility.
PersonDefaultVisibility Integer True No PersonDefaultVisibility.
ProductDefaultVisibility Integer True No ProductDefaultVisibility.
Value String False Yes Possible values for the default_visibility setting depending on the subscription plan.
SettingKey String False Yes SettingKey.

Return to Top

Stages

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the stage.
ActiveFlag Boolean True No ActiveFlag.
AddTime Datetime True No AddTime.
DealProbability Integer False No Deal success probability percentage.
Name String False No Name of the Stage.
OrderNr Integer False No An order number for this stage.
PipelineDealProbability Integer True No PipelineDealProbability.
PipelineId Integer False No The ID of the Pipeline to add Stage to.
PipelineName String True No PipelineName.
RottenDays String False No The number of days the Deals not updated in this Stage would become rotten. Applies only if the rotten_flag is set.
RottenFlag Boolean False No Whether Deals in this stage can become rotten.
UpdateTime Datetime True No UpdateTime.

Return to Top

StagesDeals

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No Stages Deals Id.
StageId Integer True No Stage Id.
Active Boolean True No Active.
ActivitiesCount Integer True No Activities count.
AddTime String True No Added time of Stage deals.
CcEmail String True No Cc Email.
CloseTime String True No Close time of Stages deals.
CreatorUserId Integer True No Creator user id.
Currency String True No Currency.
Deleted Boolean True No Boolean value that represents stage deals is deleted or not.
DoneActivitiesCount Integer True No Count of done activities.
EmailMessagesCount Integer True No Count of email messages.
ExpectedCloseDate Date True No Expected close date.
FilesCount Integer True No Count of files.
FirstWonTime String True No First won time.
FollowersCount Integer True No Count of followers.
FormattedValue String True No Formatted value.
FormattedWeightedValue String True No Formatted weighted value.
Label String True No Label.
LastActivityDate String True No Last activity date.
LastActivityId String True No Last activity id.
LastIncomingMailTime String True No Last incoming mail time.
LastOutgoingMailTime String True No Last outgoing mail time.
LostReason String True No Lost reason.
LostTime String True No Lost time.
NextAactivityDate Date True No Next activity date.
NextActivityDuration String True No Next activity duration.
NextActivityId Integer True No Next activity id.
NextActivityNote String True No Next activity note.
NextActivitySubject String True No Next activity subject.
NextActivityTime String True No Next activity time.
NextActivityType String True No Next activity type.
NotesCount Integer True No Notes count.
OrgHidden Boolean True No Org hidden.
OrgId Integer True No Org Id.
OrgName String True No Org Name.
OwnerName String True No Owner name.
ParticipantsCount Integer True No Participants count.
PersonHidden Boolean True No Person hidden.
PersonId Integer True No Person id.
PersonName String True No Person name.
PipelineId Integer True No Pipeline id.
Probability Unknown True No Probability.
ProductsCount Integer True No Products count.
RottenTime String True No Rotten time.
StageChangeTime String True No Stage change time.
StageOrderNr Integer True No Stage order nr.
Status String True No Status.
Title String True No Title.
UndoneActivitiesCount Integer True No Count of undone activities.
UpdateTime Datetime True No Updated time.
UserId Integer True No User id.
Value Integer True No Value.
VisibleTo String True No Visible to.
WeightedValue Integer True No Weighted value.
WeightedValueCurrency String True No Weighted value currency.
WonTime String True No Won time.
FilterId Integer False Yes Filter id.
Everyone String False Yes Everyone.

Return to Top

SubscriptionPayments

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the Subscription Payments.
SubscriptionId Integer True No ID of the Subscription.
DealId Integer True No Deal Id.
IsActive Boolean True No Is Active.
Amount Integer True No Amount.
Currency String True No Currency.
ChangeAmount Integer True No Change amount.
DueAt Date True No Due at.
RevenueMovementType String True No Revenue movement type.
PaymentType String True No Payment type.
Description String True No Description.
AddTime String True No Add time.
UpdateTime String True No Update time.

Return to Top

Subscriptions

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the Subscription.
AddTime Datetime True No AddTime.
CadenceType String False No Interval between payments.
Currency String False No The currency of the Installment Subscription. Accepts a 3-character currency code.
CycleAmount Double False No Amount of each payment.
CyclesCount Integer False No Shows how many payments the Subscription has.
DealId Integer False No ID of the Deal this Installment Subscription is associated with.
Description String False No Description of the Recurring Subscription.
EndDate String False No EndDate.
FinalStatus String True No FinalStatus.
Infinite Boolean False No This indicates that the Recurring Subscription will last until it's manually canceled or deleted.
IsActive Boolean True No IsActive.
LifetimeValue Double True No LifetimeValue.
StartDate String False No Start date of the Recurring Subscription. Format: YYYY-MM-DD
UpdateTime Datetime False No UpdateTime.
UserId Integer True No UserId.
SubscriptionType String True No SubscriptionType.
Payments String False Yes Array of payments.
EffectiveDate Date False Yes Array of payments.
UpdateDealValue Boolean False Yes Indicates that the Deal value must be set to Recurring Subscription's MRR value.

Return to Top

UserConnection

Name Type ReadOnly References FilterOnly Description
Google String True No Google.

Return to Top

Users

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No ID of the user.
Activated Boolean False No Activated.
ActiveFlag Boolean False No Whether the user is active or not.
Created Datetime False No Created.
DefaultCurrency String False No DefaultCurrency.
Email String False No Email of the user.
Hascreatedcompany Boolean False No Hascreatedcompany.
IconUrl String False No IconUrl.
IsAdmin Integer False No IsAdmin.
IsYou Boolean False No IsYou.
Lang Integer False No Lang.
LastLogin Datetime False No LastLogin.
Locale String False No Locale.
Modified Datetime False No Modified.
Name String False No Name of the user.
Phone String False No Phone.
RoleId Integer False No ID of the role.
TimezoneName String False No TimezoneName.
TimezoneOffset String False No TimezoneOffset.
Access String False No The access given to the user.

Return to Top

UsersAccess

Name Type ReadOnly References FilterOnly Description
App String False No ID of the user.
Admin Boolean False No Admin.
PermissionSetId String False No Permission Set Id.

Return to Top

UserSettings

Name Type ReadOnly References FilterOnly Description
ExpectedCloseDate String True No ExpectedCloseDate.
BetaApp String True No BetaApp.
CalltoLink String True No CalltoLink.
FileUploadDestination String True No FileUploadDestination.
ListLimit Integer True No ListLimit.
MarketplaceCustomUrl String True No MarketplaceCustomUrl.
MarketplaceExtensionsVendor String True No MarketplaceExtensionsVendor.
MarketplaceTeam String True No MarketplaceTeam.
PersonDuplicateCondition String True No PersonDuplicateCondition.
SalesphoneCalltoOverride String True No SalesphoneCalltoOverride.

Return to Top

UsersFollowers

Name Type ReadOnly References FilterOnly Description
UserId Integer True No ID of the user.
Data Integer True No Data.

Return to Top

UsersPermissions

Name Type ReadOnly References FilterOnly Description
UserId Integer True No ID of the user.
CanAddCustomFields Boolean True No CanAddCustomFields.
CanBulkEditItems Boolean True No CanBulkEditItems.
CanChangeVisibilityOfItems Boolean True No CanChangeVisibilityOfItems.
CanCreateOwnWorkflow Boolean True No CanCreateOwnWorkflow.
CanModifyOwnerForDeals Boolean True No CanModifyOwnerForDeals.
CanDeleteDeals Boolean True No CanDeleteDeals.
CanConvertDealsToLeads Boolean True No CanConvertDealsToLeads.
CanMergeDeals Boolean True No CanMergeDeals.
CanEditDealsClosedDate Boolean True No CanEditDealsClosedDate.
CanModifyOwnerForLeads Boolean True No CanModifyOwnerForLeads.
CanDeleteLeads Boolean True No CanDeleteLeads.
CanMergeLeads Boolean True No CanMergeLeads.
CanSeeDealsListSummary Boolean True No CanSeeDealsListSummary.
CanAddDeals Boolean True No CanAddDeals.
CanEditOtherUsersDeals Boolean True No CanEditOtherUsersDeals.
CanAddLeads Boolean True No CanAddLeads.
CanEditOtherUsersLeads Boolean True No CanEditOtherUsersLeads.
CanEditCustomFields Boolean True No CanEditCustomFields.
CanDeleteCustomFields Boolean True No CanDeleteCustomFields.
CanUseImport Boolean True No CanUseImport.
CanModifyLabels Boolean True No CanModifyLabels.
CanExportDataFromLists Boolean True No CanExportDataFromLists.
CanShareFilters Boolean True No CanShareFilters.
CanEditSharedFilters Boolean True No CanEditSharedFilters.
CanShareInsights Boolean True No CanShareInsights.
CanUseEmailTracking Boolean True No CanUseEmailTracking.
CanSeeOtherUsersStatistics Boolean True No CanSeeOtherUsersStatistics.
CanSeeCompanyWideStatistics Boolean True No CanSeeCompanyWideStatistics.
CanSeeOtherUsers Boolean True No CanSeeOtherUsers.
CanFollowOtherUsers Boolean True No CanFollowOtherUsers.
CanSeeHiddenItemsNames Boolean True No CanSeeHiddenItemsNames.
CanModifyOwnerForActivities Boolean True No CanModifyOwnerForActivities.
CanDeleteActivities Boolean True No CanDeleteActivities.
CanModifyOwnerForPeople Boolean True No CanModifyOwnerForPeople.
CanDeletePeople Boolean True No CanDeletePeople.
CanMergePeople Boolean True No CanMergePeople.
CanModifyOwnerForOrganizations Boolean True No CanModifyOwnerForOrganizations.
CanDeleteOrganizations Boolean True No CanDeleteOrganizations.
CanMergeOrganizations Boolean True No CanMergeOrganizations.
CanAddProducts Boolean True No CanAddProducts.
CanEditOtherUsersProducts Boolean True No CanEditOtherUsersProducts.
CanModifyOwnerForProducts Boolean True No CanModifyOwnerForProducts.
CanDeleteProducts Boolean True No CanDeleteProducts.
CanDeleteProductVariations Boolean True No CanDeleteProductVariations.
CanUseApi Boolean True No CanUseApi.
CanAddPeople Boolean True No CanAddPeople.
CanEditOtherUsersPeople Boolean True No CanEditOtherUsersPeople.
CanAddOrganizations Boolean True No CanAddOrganizations.
CanEditOtherUsersOrganizations Boolean True No CanEditOtherUsersOrganizations.

Return to Top

UsersRoleAssignments

Name Type ReadOnly References FilterOnly Description
UserId Integer True No ID of the user.
RoleId Integer True No Role Id.
ParentRoleId Integer True No Parent Role Id.
Name String True No Name.
ActiveFlag Boolean True No Active flag.
Type String True No Type.

Return to Top

UsersRoleSettings

Name Type ReadOnly References FilterOnly Description
UserId Integer True No ID of the user.
DealDefaultVisibility Integer True No Deal Default Visibility.
LeadDefaultVisibility Integer True No Lead Default Visibility.
OrgDefaultVisibility Integer True No Org Default Visibility.
PersonDefaultVisibility Integer True No Person Default Visibility.
ProductDefaultVisibility Integer True No Product Default Visibility.

Return to Top