The CData Sync App provides a straightforward way to continuously pipeline your Pipedrive data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Pipedrive connector can be used from the CData Sync application to pull data from Pipedrive and move it to any of the supported destinations.
The Sync App leverages the Pipedrive API to enable bidirectional access to Pipedrive.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
The API Token is stored in the Pipedrive portal. To retrieve it, click the company name, then use the drop-down list to navigate to Company Settings > Personal Preferences > API.
The following subsections describe how to authenticate to Pipedrive from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Pipedrive, see Connection.
Automatic refresh of the OAuth access token:
To have the Sync App automatically refresh the OAuth access token:
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAuth access token is the OAuth refresh token.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
See Pipedrive Data Model for the available entities in the Pipedrive Data Model.
See PipedriveV2 Data Model for the available entities in the PipedriveV2 Data Model.
This section shows the available API objects and provides more information on executing SQL to Pipedrive APIs.
Additionally, the Pipedrive API limits the number and combinations of columns that can be projected over the data or used to restrict the results returned.
The Sync App models the data in Pipedrive as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Activities | Get all Activities assigned to a particular User. |
| ActivityTypes | Get all ActivityTypes. |
| CallLogs | Returns all call logs assigned to a particular user. |
| DealFields | Returns data about all deal fields. |
| Deals | Get all deals. |
| DealsFollowers | Get details of deals followers. |
| DealsParticipants | Get details of deals participants. |
| DealsProducts | Get details of deals products. |
| Files | Returns data about all files. |
| Filters | Returns data about all filters. |
| Goals | Goals help your team meet your sales targets. |
| LeadLabels | Returns all lead labels used for organizing and categorizing leads. |
| Leads | Returns lead data. |
| MailThreads | Get, Update and Delete mail threads in a specified folder ordered by the most recent message within. |
| NoteComments | Create, Update, Delete and Get the comments associated with a note. |
| Notes | Returns all notes. |
| OrganizationFields | Returns data about all organization fields. |
| OrganizationRelationships | Returns relationship records between organizations. |
| Organizations | Get details of organizations. |
| OrganizationsFollowers | Get details of organizations followers. |
| PersonFields | Returns data about all person fields. |
| PersonFollowers | Get details of persons followers. |
| Persons | Get all details of persons. |
| Pipelines | Get all Pipelines. |
| ProductFields | Returns data about all product fields. |
| Products | Get details of Products. |
| ProductsFollowers | Get details of products followers. |
| Projects | Get all projects data. |
| Roles | Returns all the role. |
| RolesAssignments | List assignments for a role. |
| RolesSetting | Returns all the roles settings. |
| Stages | Returns data about all stages. |
| Tasks | Get all tasks data. |
| Users | Returns data about all users within the company |
Get all Activities assigned to a particular User.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Activities WHERE Id = 246
SELECT * FROM Activities WHERE Done = 0
SELECT * FROM Activities WHERE Type IN ('deadline', 'call')
SELECT * FROM Activities WHERE EndDate = '2021-12-24'
SELECT * FROM Activities WHERE UserId = 8230170
The columns that are not read-only can be inserted. Following is an example of how to insert into this table.
INSERT INTO ActivitiesAttendees#TEMP (EmailAddress) VALUES ('[email protected]')
INSERT INTO Activities (DueDate, DueTime, Duration, Dealid, Attendees) VALUES ('1994-10-12', '10:20', '02:00', 1, 'ActivitiesAttendees#TEMP')
UPDATE can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Activities SET DealId = 2 WHERE Id = 245
DELETE can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Activities WHERE Id = 246
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Activity Id. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| AddTime | Datetime | True |
AddTime. | |
| AssignedToUserId | Integer | True |
AssignedToUserId. | |
| Attendees | String | False |
Attendees of the Activity This can be either your existing Pipedrive contacts or an external email address. | |
| BusyFlag | Boolean | True |
Set the Activity as Busy or Free. The allowed values are true, false. The default value is true. | |
| CalendarSync | String | True |
CalendarSync. | |
| CompanyId | Integer | True |
CompanyId. | |
| MeetingClient | String | True |
MeetingClient. | |
| MeetingId | String | True |
MeetingId. | |
| MeetingUrl | String | True |
MeetingUrl. | |
| CreatedByUserId | Integer | True |
CreatedByUserId. | |
| DealDropboxBcc | String | True |
DealDropboxBcc. | |
| DealId | Integer | False |
Deals.Id |
The ID of the Deal this Activity is associated with. |
| DealTitle | String | True |
DealTitle. | |
| Done | Boolean | True |
Whether the Activity is done or not 0 = Not done 1 = Done If omitted returns both Done and Not done activities. The allowed values are 0, 1. | |
| DueDate | Date | False |
Due date of the Activity Format YYYY-MM-DD | |
| DueTime | Time | False |
Due time of the Activity in UTC Format HH:MM | |
| Duration | Time | True |
Duration of the Activity Format HH:MM | |
| FileCleanName | String | True |
FileCleanName. | |
| FileId | String | True |
Files.Id |
FileId. |
| FileUrl | String | True |
FileUrl. | |
| GcalEventId | String | True |
GcalEventId. | |
| GoogleCalendarEtag | String | True |
GoogleCalendarEtag. | |
| GoogleCalendarId | String | True |
GoogleCalendarId. | |
| LastNotificationTime | Datetime | True |
LastNotificationTime. | |
| LastNotificationUserId | Integer | True |
LastNotificationUserId. | |
| LeadId | String | True |
Leads.Id |
LeadId. |
| Location | String | False |
The address of the Activity. | |
| AdminAreaLevel1 | String | True |
AdminAreaLevel1. | |
| AdminAreaLevel2 | String | True |
AdminAreaLevel2. | |
| LocationCountry | String | True |
LocationCountry. | |
| FormattedAddress | String | True |
FormattedAddress. | |
| LocationLat | Double | True |
LocationLat. | |
| LocationLocality | String | True |
LocationLocality. | |
| LocationLong | Double | True |
LocationLong. | |
| PostalCode | String | True |
PostalCode. | |
| LocationRoute | String | True |
LocationRoute. | |
| StreetNumber | String | True |
StreetNumber. | |
| Sublocality | String | True |
Sublocality. | |
| Subpremise | String | True |
Subpremise. | |
| MarkedAsDoneTime | Datetime | True |
MarkedAsDoneTime. | |
| Note | String | False |
Note of the Activity HTML format. | |
| NotificationLanguageId | Integer | True |
NotificationLanguageId. | |
| OrgId | Integer | False |
The ID of the Organization this Activity is associated with. | |
| OrgName | String | True |
OrgName. | |
| OwnerName | String | True |
OwnerName. | |
| Participants | String | False |
List of multiple Persons participants this Activity is associated with If omitted single participant from person_id field is used. | |
| PersonDropboxBcc | String | True |
PersonDropboxBcc. | |
| PersonId | Integer | False |
Persons.Id |
The ID of the Person this Activity is associated with. |
| PersonName | String | True |
PersonName. | |
| PublicDescription | String | False |
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 |
RecMasterActivityId. | |
| RecRule | String | True |
RecRule. | |
| RecRuleExtension | String | True |
RecRuleExtension. | |
| ReferenceId | Integer | True |
ReferenceId. | |
| ReferenceType | String | True |
ReferenceType. | |
| Series | String | True |
Series. | |
| SourceTimezone | String | True |
SourceTimezone. | |
| Subject | String | False |
Subject of the Activity. The default value is Call. | |
| Type | String | True |
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. The default value is Call. | |
| UpdateTime | Datetime | True |
UpdateTime. | |
| UpdateUserId | Integer | True |
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 |
UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FilterId | Integer |
The ID of the Filter to use. |
| StartDate | String |
Use the Activity due date where you wish to begin fetching Activities from Insert due date in YYYY-MM-DD format. |
| EndDate | String |
Use the Activity due date where you wish to stop fetching Activities from Insert due date in YYYY-MM-DD format. |
Get all ActivityTypes.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Activities WHERE Id = 9
Insert can be executed by specifying the Name and IconKey columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO ActivityTypes (Color, IconKey, Name) VALUES ('black', 'sound', 'pvnactivity');
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE ActivityTypes SET IconKey = 'email' WHERE id = 7
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM ActivityTypes WHERE Id = 2
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The ID of the ActivityType. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| AddTime | Datetime | True |
AddTime. | |
| Color | String | False |
A designated color for the ActivityType in 6-character HEX format. | |
| IconKey | String | False |
Icon graphic to use for representing this activity type. The allowed values are task, email, meeting, deadline, call, lunch, calendar, downarrow, document, smartphone, camera, scissors, cogs, bubble, uparrow, checkbox, signpost, shuffle, addressbook, linegraph, picture, car, world, search, clip, sound, brush, key, padlock, pricetag, suitcase, finish, plane, loop, wifi, truck, cart, bulb, bell, presentation. | |
| IsCustomFlag | Boolean | True |
IsCustomFlag. | |
| KeyString | String | True |
KeyString. | |
| Name | String | False |
The name of the ActivityType. | |
| OrderNr | Integer | False |
An order number for this ActivityType. Order numbers should be used to order the types in the ActivityType selections. | |
| UpdateTime | Datetime | True |
UpdateTime. |
Returns all call logs assigned to a particular user.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM CallLogs WHERE Id = 'cf75de9e4cbcb4a33658ad40561e3230'
Insert can be executed by specifying the Outcome, ToPhoneNumber, StartTime and EndTime columns. The columns that are not required can be inserted optionally.
INSERT INTO CallLogs (Outcome, StartTime, EndTime, Duration, FromPhoneNumber, ToPhoneNumber, UserId, OrgId) VALUES ('connected', '2021-12-15', '2021-12-16', '140', '984656646', '9846566456', '8230170', '6')
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM CallLogs WHERE Id = '8381cea5da671fa16a1eb63af15e5ec4'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
ID. | |
| ActivityId | Integer | False |
ActivityId. | |
| CompanyId | Integer | True |
CompanyId. | |
| DealId | Integer | False |
The ID of the Deal this call is associated with. | |
| Duration | String | False |
Call duration in seconds. | |
| EndTime | Datetime | False |
The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS | |
| FromPhoneNumber | String | False |
The number that made the call. | |
| HasRecording | Boolean | True |
HasRecording. | |
| Note | String | False |
Note for the call log in HTML format. | |
| OrgId | Integer | False |
The ID of the Organization this call is associated with. | |
| Outcome | String | False |
Describes the outcome of the call. The allowed values are connected, no_answer, left_message, left_voicemail, wrong_number, busy. | |
| PersonId | Integer | False |
The ID of the Person this call is associated with. | |
| StartTime | Datetime | False |
The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS | |
| Subject | String | False |
Name of the activity this call is attached to. | |
| ToPhoneNumber | String | False |
The number called. | |
| UserId | Integer | False |
The ID of the owner of the call log. | |
| LeadId | String | False |
The ID of the lead the call log is associated with in UUID format. |
Returns data about all deal fields.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealFields WHERE Id = 12478
Insert can be executed by specifying the Name and IconKey columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO DealFields (Name, AddVisibleFlag, FieldType) VALUES ('test43', 'false', 'address')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE DealFields SET Name = 'test44' WHERE Id = '12500'
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM DealFields WHERE Id = 12500
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the field. | |
| ActiveFlag | Boolean | True |
Whether the field is available in 'add new' modal or not (both in web and mobile app). The default value is true. | |
| AddTime | Datetime | True |
AddTime. | |
| AddVisibleFlag | Boolean | False |
AddVisibleFlag. | |
| BulkEditAllowed | Boolean | True |
BulkEditAllowed. | |
| DetailsVisibleFlag | Boolean | True |
DetailsVisibleFlag. | |
| EditFlag | Boolean | True |
EditFlag. | |
| FieldType | String | False |
Type of the field. The allowed values are address, date, daterange, double, enum, monetary, org, people, phone, set, text, time, timerange, user, varchar, varchar_auto, visible_to. | |
| FilteringAllowed | Boolean | True |
FilteringAllowed. | |
| ImportantFlag | Boolean | True |
ImportantFlag. | |
| IndexVisibleFlag | Boolean | True |
IndexVisibleFlag. | |
| Key | String | True |
Key. | |
| LastUpdatedByUserId | String | True |
LastUpdatedByUserId. | |
| MandatoryFlag | Boolean | True |
MandatoryFlag. | |
| Name | String | False |
Name of the field. | |
| Options | String | False |
Options. | |
| OrderNr | Integer | True |
OrderNr. | |
| SearchableFlag | Boolean | True |
SearchableFlag. | |
| SortableFlag | Boolean | True |
SortableFlag. | |
| UpdateTime | Datetime | True |
UpdateTime. |
Get all deals.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Deals WHERE Id = 14 SELECT * FROM Deals WHERE StageId = 1 SELECT * FROM Deals WHERE Status = 'Open' SELECT * FROM Deals WHERE FilterId = 1 SELECT * FROM Deals WHERE OwnedByYou = 1
Insert can be executed by specifying the Title columns.The columns that are not read-only can be inserted. Following is an example of how to insert into this table.
INSERT INTO Deals (title, PersonId) VALUES ('tetsptest', 6203)
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Deals SET Title = 'test' WHERE id = 15
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Deals WHERE id = 15
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Deals id. | |
| Active | Boolean | True |
Active. | |
| ActivitiesCount | Integer | True |
Activities Count. | |
| AddTime | Datetime | False |
AddTime. | |
| CcEmail | String | True |
Cc Email. | |
| CloseTime | String | True |
Close Time. | |
| CreatorActiveFlag | Boolean | True |
Creator ActiveFlag. | |
| CreatorEmail | String | True |
Creator Email. | |
| CreatorHasPic | Boolean | True |
Creator HasPic. | |
| CreatorId | Integer | True |
Creator Id. | |
| CreatorName | String | True |
Creator Name. | |
| CreatorPicHash | String | True |
CreatorPicHash. | |
| Creatorvalue | Integer | True |
Creatorvalue. | |
| Currency | String | False |
Currency. | |
| CustomFields | String | True |
CustomeField you will get the result of this column only when criteria filter title is used. | |
| Deleted | Boolean | True |
Deleted. | |
| DoneActivitiesCount | Integer | True |
Done Activities Count. | |
| EmailMessagesCount | Integer | True |
Email Messages Count. | |
| ExpectedCloseDate | Date | False |
Expected Close Date. | |
| FilesCount | Integer | True |
Files Count. | |
| FirstWonTime | Datetime | True |
First Won Time. | |
| FollowersCount | Integer | True |
Followers Count. | |
| FormattedValue | String | True |
Formatted Value. | |
| FormattedWeightedValue | String | True |
Formatted Weighted Value. | |
| Label | String | True |
Label. | |
| LastActivityDate | String | True |
Last Activity Date. | |
| LastActivityId | String | True |
Last Activity Id. | |
| LastIncomingMailTime | Datetime | True |
Last Incoming MailTime. | |
| LastOutgoingMailTime | Datetime | True |
Last OutgoingMail Time. | |
| LostReason | String | False |
Lost Reason. | |
| LostTime | String | True |
Lost Time. | |
| NextActivityDate | Date | True |
Next Activity Date. | |
| NextActivityDuration | Time | True |
Next Activity Duration. | |
| NextActivityId | Integer | True |
Next Activity Id. | |
| NextActivityNote | String | True |
Next Activity Note. | |
| NextActivitySubject | String | True |
Next Activity Subject. | |
| NextActivityTime | Time | True |
Next Activity Time. | |
| NextActivityType | String | True |
Next Activity Type. | |
| NotesCount | Integer | True |
NotesCount. | |
| Notes | String | True |
Notes. | |
| OrgHidden | Boolean | True |
Org Hidden. | |
| OrgActiveFlag | Boolean | True |
Org ActiveFlag. | |
| OrgAddress | String | True |
Org Address. | |
| OrgCcEmail | String | True |
Org CcEmail. | |
| OrgName | String | True |
Org Name. | |
| OrgOwnerId | Integer | True |
Org OwnerId. | |
| OrgPeopleCount | Integer | True |
Org PeopleCount. | |
| OrgValue | Integer | True |
Org Value. | |
| OwnerName | String | True |
Owner Name. | |
| OwnerId | String | True |
Owner Id you will get the result of this column only when criteria filter title is used. | |
| ParticipantsCount | Integer | True |
Participants Count. | |
| PersonHidden | Boolean | True |
Person Hidden. | |
| PersonActiveFlag | Boolean | True |
Person Active Flag. | |
| PersonEmail | String | True |
Person Email. | |
| PersonName | String | True |
Person Name. | |
| PersonPhone | String | True |
Person Phone. | |
| Personvalue | Integer | True |
Personvalue. | |
| PipelineId | Integer | True |
PipelineId. | |
| Probability | String | True |
Probability. | |
| ProductsCount | Integer | True |
Products Count. | |
| RottenTime | String | True |
RottenTime. | |
| ResultScore | String | True |
Result score you will get the result of this column only when criteria filter title is used. | |
| StageChangeTime | Datetime | True |
Stage Change Time. | |
| StageId | Integer | True |
Stages.Id |
StageId. |
| StageName | String | True |
StageName. | |
| StageOrderNr | Integer | True |
Stage OrderNr. | |
| Status | String | False |
Status. The allowed values are open, won, lost, deleted, all_not_deleted. The default value is all_not_deleted. | |
| Title | String | False |
Title. | |
| Type | String | True |
Type you will get the result of this column only when criteria filter title is used. | |
| UndoneActivitiesCount | Integer | True |
Undone Activities Count. | |
| UpdateTime | Datetime | True |
Update Time. | |
| UserActiveFlag | Boolean | True |
User ActiveFlag. | |
| UserEmail | String | True |
User Email. | |
| UserHasPic | Boolean | True |
User HasPic. | |
| UserId | Integer | False |
User Id. | |
| UserName | String | True |
User Name. | |
| UserPicHash | String | True |
User PicHash. | |
| Uservalue | Integer | True |
User value. | |
| Value | Integer | False |
Value of the deal. The default value is 0. | |
| VisibleTo | String | False |
Visibility of the deal. The allowed values are 1, 3, 5, 7. | |
| WeightedValue | Integer | True |
Visible To. | |
| WeightedValueCurrency | String | True |
Weighted Value Currency. | |
| OrderOfStages | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AverageTimeToWonY | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AverageTimeToWonM | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AverageTimeToWond | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AverageTimeToWonh | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AverageTimeToWons | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AverageTimeToWoni | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AverageTotalSeconds | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AverageStageProgress | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AgeY | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AgeM | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| Aged | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| Ageh | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| Ages | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| Agei | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| AgeTotalSeconds | Integer | True |
You will get the result of this column only when criteria filter id is used. | |
| WonTime | Datetime | True |
Won time. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FilterId | Integer |
Filter Id |
| OwnedByYou | Integer |
Owned By You The allowed values are 0, 1. |
| PersonId | Integer |
Person Id. Only used when performing INSERT or UPDATE operation. |
| OrgId | Integer |
Org Id. Only used when performing INSERT or UPDATE operation. |
Get details of deals followers.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsFollowers WHERE Id = 2
Insert can be executed by specifying the Name and IconKey columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO DealsFollowers (userid, id) VALUES (8230170, 8)
Delete can be executed by specifying the Id, DealId in the WHERE Clause.
For example:
DELETE FROM DealsFollowers WHERE Id = 1 AND Dealid = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Id. | |
| AddTime | Datetime | True |
AddTime. | |
| UserId | Integer | False |
Users.Id |
User Id. |
| DealId [KEY] | Integer | True |
Deals.Id |
Deal Id. |
Get details of deals participants.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsParticipants WHERE Id = 9
Insert can be executed by specifying the Content and PersonId columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO DealsParticipants (Id, Personid) VALUES (4, 6)
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM DealsParticipants WHERE id = 14 AND ItemDealId = 17
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Id. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| AddTime | Datetime | True |
AddTime. | |
| AddedByactiveFlag | Boolean | True |
AddedByactiveFlag. | |
| AddedByemail | String | True |
AddedByemail. | |
| AddedByhasPic | Integer | True |
AddedByhasPic. | |
| AddedByid | Integer | True |
AddedByid. | |
| AddedByname | String | True |
AddedByname. | |
| AddedBypicHash | String | True |
AddedBypicHash. | |
| AddedByvalue | Integer | True |
Added_byvalue. | |
| PersonActiveFlag | Boolean | True |
PersonActiveFlag. | |
| ActivitiesCount | Integer | True |
ActivitiesCount. | |
| PersonAddTime | Datetime | True |
AddTime. | |
| CcEmail | String | True |
CcEmail. | |
| ClosedDealsCount | Integer | True |
ClosedDealsCount. | |
| CompanyId | Integer | True |
CompanyId. | |
| DoneActivitiesCount | Integer | True |
DoneActivitiesCount. | |
| String | True |
Email. | ||
| EmailMessagesCount | Integer | True |
EmailMessagesCount. | |
| FilesCount | Integer | True |
FilesCount. | |
| FirstChar | String | True |
FirstChar. | |
| FirstName | String | True |
FirstName. | |
| FollowersCount | Integer | True |
FollowersCount. | |
| Personlabel | String | True |
Personlabel. | |
| LastActivityDate | Date | True |
LastActivityDate. | |
| LastActivityId | Integer | True |
LastActivityId. | |
| LastincomingMailTime | String | True |
LastincomingMailTime. | |
| Lastname | String | True |
Lastname. | |
| LastoutgoingMailTime | String | True |
LastoutgoingMailTime. | |
| LostdealsCount | Integer | True |
LostdealsCount. | |
| Name | String | True |
Name. | |
| NextActivityDate | Date | True |
nextActivityDate. | |
| NextActivityId | Integer | True |
nextActivityId. | |
| NextActivityTime | String | True |
nextActivityTime. | |
| NotesCount | Integer | True |
NotesCount. | |
| OpenDealsCount | Integer | True |
OpenDealsCount. | |
| OrgActiveFlag | Boolean | True |
OrgActiveFlag. | |
| OrgAddress | String | True |
OrgAddress. | |
| OrgCcEmail | String | True |
OrgCcEmail. | |
| OrgName | String | True |
OrgName. | |
| OrgownerId | Integer | True |
OrgownerId. | |
| OrgpeopleCount | Integer | True |
OrgpeopleCount. | |
| OrgId | Integer | True |
OrgId. | |
| OwnerActiveFlag | Boolean | True |
OwnerActiveFlag. | |
| OwnerEmail | String | True |
OwnerEmail. | |
| OwnerHasPic | Integer | True |
OwnerHasPic. | |
| OwnerId | Integer | True |
OwnerId. | |
| OwnerName | String | True |
OwnerName. | |
| OwnerPicHash | String | True |
OwnerPicHash. | |
| OwnerValue | Integer | True |
OwnerValue. | |
| ParticipantClosedDealsCount | Integer | True |
ClosedDealsCount. | |
| ParticipantOpenDealsCount | Integer | True |
OpenDealsCount. | |
| Phone | String | True |
Phone. | |
| PictureId | String | True |
PictureId. | |
| RelatedclosedDealsCount | Integer | True |
RelatedclosedDealsCount. | |
| RelatedlostDealsCount | Integer | True |
RelatedlostDealsCount. | |
| RelatedopenDealsCount | Integer | True |
RelatedopenDealsCount. | |
| RelatedwonDealsCount | Integer | True |
RelatedwonDealsCount. | |
| SyncNeeded | Boolean | True |
SyncNeeded. | |
| UndoneActivitiesCount | Integer | True |
UndoneActivitiesCount. | |
| UpdateTime | Datetime | True |
UpdateTime. | |
| VisibleTo | String | True |
visibleTo. | |
| WonDealsCount | Integer | True |
WonDealsCount. | |
| PersonIdActiveFlag | Boolean | True |
PersonactiveFlag. | |
| Personemail | String | True |
Personemail. | |
| Personname | String | True |
Personname. | |
| Personphone | String | True |
Personphone. | |
| PersonValues | Integer | False |
PersonValues. | |
| ItemDealId [KEY] | Integer | True |
Deals.id |
ItemDealId. |
| ItemTitle | String | True |
ItemTitle. | |
| ItemId | Integer | True |
ItemId. | |
| ItemType | String | True |
ItemType. | |
| PersonId | Integer | False |
Persons.Id |
Person Id. |
| PersonOrgName | String | True |
Person OrgName. | |
| PersonOwnerName | String | True |
Person OwnerName. |
Get details of deals products.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsProducts WHERE DealId = 9
Insert can be executed by specifying the Content and PersonId columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO DealsProducts (DealId, ProductId, ItemPrice, quantity) VALUES (2, 2, 20000, 1)
Update can be executed by specifying the Id and Dealid in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE DealsProducts SET quantity = 20 WHERE id = 15 AND Dealid = 2
Delete can be executed by specifying the Id, DealId in the WHERE Clause.
For example:
DELETE FROM DealsProducts WHERE id = 15 AND Dealid = 2
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Id. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| AddTime | Datetime | True |
AddTime. | |
| Comments | String | False |
Any textual comment associated with this product-deal attachment. | |
| Currency | String | True |
Currency. | |
| DealId [KEY] | Integer | True |
Deals.Id |
Deal id. |
| DiscountPercentage | Double | True |
Discount %. The default value is 0. | |
| Duration | Integer | True |
Duration of the product. The default value is 1. | |
| DurationUnit | String | True |
DurationUnit. | |
| EnabledFlag | Boolean | False |
Whether the product is enabled on the deal or not. The allowed values are 0, 1. | |
| ItemPrice | Integer | False |
Price at which this product will be added to the deal. | |
| LastEdit | String | True |
LastEdit. | |
| Name | String | True |
Name. | |
| OrderNr | Integer | True |
OrderNr. | |
| ProductActiveFlag | Boolean | True |
Product ActiveFlag. | |
| ProductAddTime | Datetime | True |
Product AddTime. | |
| Category | String | True |
Category. | |
| code | String | True |
Code. | |
| description | String | True |
Description. | |
| FilesCount | String | True |
FilesCount. | |
| FirstChar | String | True |
FirstChar. | |
| ProductsId | Integer | True |
ProductsId. | |
| ProductName | String | True |
ProductName. | |
| OwnerActiveFlag | Boolean | True |
OwnerActiveFlag. | |
| OwnerEmail | String | True |
OwnerEmail. | |
| OwnerHasPic | Boolean | True |
OwnerHasPic. | |
| OwnerId | Integer | True |
OwnerId. | |
| OwnerName | String | True |
OwnerName. | |
| OwnerPicHash | String | True |
OwnerPicHash. | |
| OwnerValue | Integer | True |
OwnerValue. | |
| Selectable | Boolean | True |
selectable. | |
| ProductTax | Integer | True |
ProductTax. | |
| unit | String | True |
unit. | |
| UpdateTime | Datetime | True |
UpdateTime. | |
| VisibleTo | String | True |
VisibleTo. | |
| ProductId | Integer | False |
Products.id |
ID of the product that will be attached. |
| VariationId | String | False |
ID of the product variation. | |
| Quantity | Integer | False |
How many items of this product will be added to the deal. | |
| QuantityFormatted | String | True |
QuantityFormatted. | |
| Sum | Double | True |
Sum. | |
| SumFormatted | String | True |
SumFormatted. | |
| SumNoDiscount | Integer | True |
SumNoDiscount. | |
| Tax | Integer | False |
Tax percentage. The default value is 0. | |
| ProductPrices | String | False |
Product Prices |
Returns data about all files.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Files WHERE Id = 400
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Files SET Name = 'Updating PipeDrive Pipelines1' WHERE Id = 405
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Files WHERE Id = 400
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the file. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| ActivityId | String | True |
ID of the activity to associate file. | |
| AddTime | Datetime | True |
AddTime. | |
| Cid | String | True |
Cid. | |
| DealId | String | True |
ID of the deal to associate file. | |
| DealName | String | True |
DealName. | |
| Description | String | False |
Description of the file. | |
| FileName | String | True |
FileName. | |
| FileSize | Integer | True |
FileSize. | |
| FileType | String | True |
FileType. | |
| InlineFlag | Boolean | True |
InlineFlag. | |
| LogId | String | True |
LogId. | |
| MailMessageId | String | True |
MailMessageId. | |
| MailTemplateId | String | True |
MailTemplateId. | |
| Name | String | False |
Visible name of the file. | |
| OrgId | String | True |
ID of the organization to associate file. | |
| OrgName | String | True |
OrgName. | |
| PersonId | Integer | True |
ID of the person to associate file. | |
| PersonName | String | True |
PersonName. | |
| ProductId | String | True |
ID of the product to associate file. | |
| ProductName | String | True |
ProductName. | |
| RemoteId | String | True |
RemoteId. | |
| RemoteLocation | String | True |
RemoteLocation. | |
| S3Bucket | String | True |
S3Bucket. | |
| UpdateTime | Datetime | True |
UpdateTime. | |
| Url | String | True |
Url. | |
| UserId | Integer | True |
UserId. | |
| LeadId | String | True |
LeadId. | |
| LeadName | String | True |
LeadName. |
Returns data about all filters.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Filters WHERE Id = 39
Insert can be executed by specifying the Name, Conditions and Type columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO Filters (Name, Conditions, Type) VALUES ('Indias Filter', '{"glue": "and","conditions": [{"glue": "and","conditions": [{"object": "organization","field_id": "4020"}]}]}', 'deals')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Filters SET Name = 'Updating Pipedrive filters', Conditions = '{"glue": "and","conditions": [{"glue": "or","conditions": [{"object": "organization123","field_id": "4021"}]}]}' WHERE Id = 39
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Filters WHERE Id = 10
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The ID of the filter. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| AddTime | Datetime | True |
AddTime. | |
| CustomViewId | String | True |
CustomViewId. | |
| Name | String | False |
The name of the filter. | |
| TemporaryFlag | String | True |
TemporaryFlag. | |
| Type | String | False |
The types of filters to fetch. The allowed values are deals, org, people, products, activity. | |
| UpdateTime | String | True |
UpdateTime. | |
| UserId | Integer | True |
UserId. | |
| VisibleTo | Integer | True |
VisibleTo. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Conditions | String |
The conditions of the filter as a JSON object. |
Goals help your team meet your sales targets.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Goals WHERE id = 'c924154b747f214228a906d3de079801' AND DurationEnd = '2022-02-03' AND DurationStart = '2022-01-01' SELECT * FROM Goals WHERE Title = 'test' SELECT * FROM Goals WHERE Type = 'test' SELECT * FROM Goals WHERE TypeName = 'test'
Insert can be executed by specifying the columns AssigneeId, AssigneeType, DurationStart, DurationEnd, Target, Interval, TypeName, CurrencyId, TrackingMetric, PipelineId and ActivityTypeId. The columns that are not required can be inserted optionally.
For example:
INSERT INTO Goals (Title, AssigneeId, AssigneeType, DurationStart, DurationEnd, Target, [Interval], TypeName, CurrencyId,TrackingMetric,PipelineId,ActivityTypeId) VALUES ('QA Goal', 27952448, 'person', '2025-01-01', '2025-03-31', 50, 'monthly', 'deals_started', 148, 'sum', '[1]','[7]')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Goals SET title = 'test' WHERE id = 'c924154b747f214228a906d3de079801'
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Goals WHERE id = 'c924154b747f214228a906d3de079801'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Id. | |
| AssigneeId | Integer | False |
ID of the user who's goal to fetch. | |
| AssigneeType | String | False |
Type of the goal's assignee. If provided, everyone's goals will be returned. The allowed values are person, team, company. | |
| DurationEnd | Date | False |
End date of the period for which to find goals. | |
| DurationStart | Date | False |
Start date of the period for which to find goals. | |
| Target | Integer | False |
Numeric value of the outcome. If provided, everyone's goals will be returned. | |
| CurrencyId | String | False |
Numeric value of the outcome. If provided, everyone's goals will be returned. | |
| TrackingMetric | String | False |
Tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned. | |
| Interval | String | False |
Interval of the goal. The allowed values are weekly, monthly, quarterly, yearly. | |
| IsActive | Boolean | False |
Whether goal is active or not. The default value is true. | |
| OwnerId | Integer | True |
OwnerId. | |
| ReportIds | String | True |
ReportIds. | |
| Title | String | False |
Title of the goal. | |
| TypeName | String | False |
Type of the goal. If provided, everyone's goals will be returned. The allowed values are deals_won, deals_progressed, activities_completed, activities_added, deals_started. | |
| PipelineId | String | False |
ID of the pipeline. | |
| ActivityTypeId | String | False |
ID of the activity_type. |
Returns all lead labels used for organizing and categorizing leads.
The Sync App uses the Pipedrive API to process WHERE clause conditions built with the server-side supported columns and operators. It processes all other filters client-side within the Sync App.
For example, since no columns or operators are supported server-side, only the following query runs on the server:
SELECT * FROM LeadLabels
To insert data, specify values for the Name and Color columns. You can include additional, optional columns as needed.
For example:
INSERT INTO LeadLabels (Name, Color) VALUES ('BangaloreCdataIndia123', 'blue')
To update a record, include the Id in the WHERE clause and set new values for any editable (non-read-only) columns.
For example:
UPDATE LeadLabels SET Name = 'I am updating content' WHERE id = '28093520-743a-11ec-96e6-031cfba07e9a'
To delete a record, specify the Id in the WHERE clause.
For example:
DELETE FROM LeadLabels WHERE Id = '28093520-743a-11ec-96e6-031cfba07e9a'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier of the lead label. | |
| AddTime | Datetime | True |
The time when the label was created. | |
| Color | String | False |
The color of the label. The allowed values are green, blue, red, yellow, purple, gray. | |
| Name | String | False |
The name of the label. | |
| UpdateTime | Datetime | True |
The time when the label was last updated. |
Returns lead data.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Leads SELECT * FROM Leads WHERE Id = 'a300ea00-5d6c-11ec-9270-93cbb0be1eed' SELECT * FROM Leads WHERE SearchByEmail = 'all'
Insert can be executed by specifying the Title column. The columns that are not required can be inserted optionally.
For example:
INSERT INTO Leads (Title, Personid, Visibleto, ExpectedCloseDate) VALUES ('CData123', 1, 1, '2022-01-01')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Leads SET Title = 'CdataIndia' WHERE Id = 'bf1bb1e0-6e13-11ec-b981-a127469657bd'
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Leads WHERE Id = 'bf1bb1e0-6e13-11ec-b981-a127469657bd'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The ID of the Lead. | |
| Addtime | Datetime | True |
Addtime. | |
| CcEmail | String | True |
Ccemail. | |
| CreatorId | Integer | True |
Creatorid. | |
| ExpectedCloseDate | String | False |
The date of when the Deal which will be created from the Lead is expected to be closed. | |
| Isarchived | Boolean | True |
A flag indicating whether the Lead is archived or not. | |
| Labelids | String | False |
The IDs of the Lead Labels which will be associated with the Lead. | |
| NextactivityId | Integer | True |
Nextactivityid. | |
| OrganizationId | String | False |
The ID of an Organization which this Lead will be linked to. | |
| OwnerId | Integer | False |
The ID of the User which will be the owner of the created Lead. | |
| PersonId | Integer | False |
The ID of a Person which this Lead will be linked to. | |
| Sourcename | String | True |
Sourcename. | |
| Title | String | False |
The name of the Lead. | |
| Updatetime | Datetime | True |
UpdateTime. | |
| Amount | Integer | False |
The potential value of the Lead. | |
| Currency | String | False |
The currency value of the Lead. | |
| Visibleto | String | False |
Visibility of the Lead. The allowed values are 1, 3, 5, 7. | |
| Wasseen | Boolean | False |
A flag indicating whether the Lead was seen by someone in the Pipedrive UI. | |
| OriginId | String | False |
The optional ID to further distinguish the origin of the lead. | |
| Channel | Integer | False |
The ID of Marketing channel this lead was created from. | |
| ChannelId | String | False |
The optional ID to further distinguish the Marketing channel. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| SearchByEmail | Integer |
Filtering based on archived status of a Lead. If not provided, All is used. The allowed values are archived, not_archived, all. The default value is all. |
Get, Update and Delete mail threads in a specified folder ordered by the most recent message within.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM MailThreads WHERE Folder = 'inbox'
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE MailThreads SET Subject = 'test' WHERE Id = 145
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM MailThreads WHERE Id = 145
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the Mail Threads. | |
| PartiesTo | String | True |
To. | |
| PartiesFrom | String | True |
From. | |
| DraftParties | String | True |
Draft Parties. | |
| Folders | String | True |
Folders. | |
| AccountId | String | True |
Account Id. | |
| UserId | Integer | True |
User Id. | |
| Version | Integer | True |
Version. | |
| Subject | String | True |
Subject. | |
| Snippet | String | True |
Snippet. | |
| SnippetDraft | String | True |
SnippetDraft. | |
| SnippetSent | String | True |
SnippetSent. | |
| HasAttachmentsFlag | Integer | True |
HasAttachmentsFlag. | |
| HasInlineAttachmentsFlag | Integer | True |
HasInlineAttachmentsFlag. | |
| HasRealAttachmentsFlag | Integer | True |
HasRealAttachmentsFlag. | |
| HasDraftFlag | Integer | True |
HasDraftFlag. | |
| HasSentFlag | Integer | True |
HasSentFlag. | |
| ArchivedFlag | Integer | True |
ArchivedFlag. | |
| DeletedFlag | Integer | True |
DeletedFlag. | |
| SyncedFlag | Integer | True |
SyncedFlag. | |
| ExternalDeletedFlag | Integer | True |
ExternalDeletedFlag. | |
| SmartBccFlag | Integer | True |
SmartBccFlag. | |
| FirstMessageToMeFlag | Integer | True |
FirstMessageToMeFlag. | |
| MailLinkTrackingEnabledFlag | Integer | True |
MailLinkTrackingEnabledFlag. | |
| LastMessageTimestamp | String | True |
LastMessageTimestamp. | |
| FirstMessageTimestamp | String | True |
FirstMessageTimestamp. | |
| LastMessageSentTimestamp | String | True |
LastMessageSentTimestamp. | |
| LastMessageReceivedTimestamp | String | True |
LastMessageReceivedTimestamp. | |
| AddTime | String | True |
AddTime. | |
| UpdateTime | String | True |
UpdateTime. | |
| DealId | Integer | True |
DealId. | |
| DealStatus | Integer | True |
DealStatus. | |
| AllMessagesSentFlag | Integer | True |
AllMessagesSentFlag. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Folder | String |
The type of folder to fetch. |
Create, Update, Delete and Get the comments associated with a note.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM NoteComments WHERE NoteId = 14
Insert can be executed by specifying the NoteId and Content columns.The columns that are not read-only can be inserted. Following is an example of how to insert into this table.
INSERT INTO NoteComments (NoteId,Content) VALUES (2, 'Test comment')
Update can be executed by specifying the NoteId and UUID in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE NoteComments SET Content='Test' where NoteId=1 and UUID = '53e0c79fdacf083d9fe1f799fdc0a206'
Delete can be executed by specifying the NoteId and UUID in the WHERE Clause.
For example:
DELETE FROM NoteComments WHERE NoteId=1 and UUID = '53e0c79fdacf083d9fe1f799fdc0a206'
| Name | Type | ReadOnly | References | Description |
| NoteId [KEY] | Integer | True |
ID of the note. | |
| UUID [KEY] | String | True |
Comment Id. | |
| ActiveFlag | Boolean | False |
Active flag. | |
| AddTime | String | False |
Add time of the note comment. | |
| CompanyId | Integer | True |
Company Id. | |
| Content | String | False |
Content of the comment. | |
| ObjectId | String | True |
Object Id. | |
| ObjectType | String | False |
Object type. | |
| UpdateTime | String | False |
Update time of the comment. | |
| UpdaterId | Integer | True |
Updater Id. | |
| UserId | Integer | True |
User Id. |
Returns all notes.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Notes WHERE Id = 9
Insert can be executed by specifying the Content and PersonId columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO Notes (ActiveFlag, Content, PersonId, AddTime) VALUES ('true', 'this is frist notes', '8', '2021-12-31')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Notes SET Content = 'I am updating content' WHERE id = 7
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Notes WHERE Id = 5
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the note. | |
| ActiveFlag | Boolean | False |
ActiveFlag. | |
| AddTime | Datetime | False |
AddTime. | |
| Content | String | False |
Content. | |
| DealTitle | String | True |
DealTitle. | |
| DealId | Integer | False |
The ID of the deal which notes to fetch. | |
| LastUpdateUserId | Integer | True |
LastUpdateUserId. | |
| LeadId | String | False |
The ID of the lead which notes to fetch. | |
| OrgId | Integer | False |
The ID of the organization which notes to fetch. | |
| OrganizationName | String | True |
OrganizationName. | |
| PersonName | String | True |
PersonName. | |
| PersonId | Integer | False |
The ID of the person whose notes to fetch. | |
| PinnedToDealFlag | Boolean | False |
If set, then results are filtered by note to deal pinning state. The allowed values are 0, 1. | |
| PinnedToLeadFlag | Boolean | False |
If set, then results are filtered by note to lead pinning state. The allowed values are 0, 1. | |
| PinnedToOrganizationFlag | Boolean | False |
If set, then results are filtered by note to organization pinning state. The allowed values are 0, 1. | |
| PinnedToPersonFlag | Boolean | False |
If set, then results are filtered by note to person pinning state. The allowed values are 0, 1. | |
| UpdateTime | Datetime | True |
UpdateTime. | |
| UserEmail | String | True |
UserEmail. | |
| UserIconUrl | String | True |
UserIconUUserNamerl. | |
| UserIsYou | Boolean | True |
UserIsYouUserName. | |
| UserName | String | True |
UserName. | |
| UserId | Integer | True |
The ID of the user whose notes to fetch. |
Returns data about all organization fields.
The Sync App uses the Pipedrive API to apply WHERE clause conditions with the supported columns and operators listed below. It processes all other filters client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM OrganizationFields WHERE Id = 2
To insert data, specify values for the Name and FieldType columns. You can include additional, optional columns as needed.
For example:
INSERT INTO OrganizationFields (Name, FieldType) VALUES ('Terex', 'text')
To update a record, include the Id in the WHERE clause and set new values for any editable (non-read-only) columns.
For example:
UPDATE OrganizationFields SET Name = 'Terry' WHERE Id = 2
To delete a record, specify the Id in the WHERE clause.
For example:
DELETE FROM OrganizationFields WHERE Id = 2
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the field. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| AddTime | Datetime | True |
AddTime. | |
| AddVisibleFlag | Boolean | False |
Whether the field is available in 'add new' modal or not. The default value is true. | |
| BulkEditAllowed | Boolean | True |
BulkEditAllowed. | |
| DetailsVisibleFlag | Boolean | True |
DetailsVisibleFlag. | |
| EditFlag | Boolean | True |
EditFlag. | |
| FieldType | String | False |
Type of the field. The allowed values are address, date, daterange, double, enum, monetary, org, people, phone, set, text, time, timerange, user, varchar, varchar_auto, visible_to. | |
| FilteringAllowed | Boolean | True |
FilteringAllowed. | |
| ImportantFlag | Boolean | True |
ImportantFlag. | |
| IndexVisibleFlag | Boolean | True |
IndexVisibleFlag. | |
| Key | String | True |
Key. | |
| LastUpdatedByUserId | String | True |
LastUpdatedByUserId. | |
| MandatoryFlag | Boolean | True |
MandatoryFlag. | |
| Name | String | False |
Name of the field. | |
| Options | String | False |
Options. | |
| OrderNr | Integer | True |
OrderNr. | |
| SearchableFlag | Boolean | True |
SearchableFlag. | |
| SortableFlag | Boolean | True |
SortableFlag. | |
| UpdateTime | Datetime | True |
UpdateTime. |
Returns relationship records between organizations.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationRelationships WHERE Id = 9
Insert can be executed by specifying the Content and PersonId columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO OrganizationRelationships (type, RelOwnerOrgId, RelLinkedOrgId) VALUES ('parent', 2, 3)
Update can be executed by specifying the Id and Dealid in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE OrganizationRelationships SET type = 'parent' WHERE Id = 10
Delete can be executed by specifying the Id, DealId in the WHERE Clause.
For example:
DELETE FROM OrganizationRelationships WHERE Id = 10
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The identifier of the organization relationship. | |
| ActiveFlag | Boolean | True |
Indicates whether the relationship is active. | |
| AddTime | Datetime | True |
The time when the relationship was created. | |
| CalculatedRelatedOrgId | Integer | False |
The related organization's Id. | |
| CalculatedType | String | False |
The relationship type. | |
| RelLinkedOrgIdActiveFlag | Boolean | False |
Indicates whether the linked organization is active. | |
| RelLinkedOrgIdAddress | String | False |
The address of the linked organization. | |
| RelLinkedOrgIdCcEmail | String | False |
The CC email associated with the linked organization. | |
| RelLinkedOrgIdname | String | False |
The name of the linked organization. | |
| RelLinkedOrgIdownerId | Integer | False |
The owner Id of the linked organization. | |
| RelLinkedOrgIdPeopleCount | Integer | False |
The total number of people related to the linked organization.. | |
| RelLinkedOrgIdvalue | Integer | False |
The total deal value associated with the linked organization. | |
| RelOwnerOrgIdActiveFlag | Boolean | False |
Indicates whether the owner organization is active. | |
| RelOwnerOrgIdAddress | String | False |
The address of the owner organization. | |
| RelOwnerOrgIdCcEmail | String | False |
The CC email associated with the owner organization. | |
| RelOwnerOrgIdName | String | False |
The name of the owner organization. | |
| RelOwnerOrgIdOwnerId | Integer | False |
The owner Id of the owner organization. | |
| RelOwnerOrgIdPeopleCount | Integer | False |
The total number of people related to the owner organization. | |
| OrgId | Integer | False |
The total deal value associated with the owner organization. | |
| RelatedOrganizationName | String | False |
The name of the related organization. | |
| Type | String | False |
The type of organization relationship. The allowed values are parent, related. | |
| UpdateTime | Datetime | False |
The time when the relationship was last updated. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| RelOwnerOrgId | Integer |
The identifier of the owner organization. |
| RelLinkedOrgId | Integer |
The identifier of the linked organization. |
Get details of organizations.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Organizations WHERE Id = 14
SELECT * FROM Organizations WHERE FirstChar = 'c'
SELECT * FROM Organizations WHERE FilterId = 1
SELECT * FROM Organizations WHERE UserId = 1
Insert can be executed by specifying the Name columns.The columns that are not read-only can be inserted. Following is an example of how to insert into this table.
INSERT INTO Organizations (name) VALUES ('testpankaj')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Organizations SET Name = 'test123' WHERE Id = 2495
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Organizations WHERE id = 15
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Id. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| ActivitiesCount | Integer | True |
ActivitiesCount. | |
| AddTime | Datetime | False |
Optional creation date time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | |
| Address | String | True |
Address. | |
| AdminArealevel1 | String | True |
AdminArealevel1. | |
| AdminArealevel2 | String | True |
AdminArealevel2. | |
| Country | String | True |
Country. | |
| FormattedAddress | String | True |
FormattedAddress. | |
| Locality | String | True |
Locality. | |
| PostalCode | String | True |
PostalCode. | |
| Route | String | True |
Route. | |
| StreetNumber | String | True |
StreetNumber. | |
| Sublocality | String | True |
Sublocality. | |
| Subpremise | String | True |
Subpremise. | |
| CcEmail | String | True |
CcEmail. | |
| CustomFields | String | True |
CustomFields you will get the result of this column only when criteria filter title is used. | |
| ClosedDealsCount | Integer | True |
ClosedDealsCount. | |
| CompanyId | Integer | True |
CompanyId. | |
| CountryCode | String | True |
CountryCode. | |
| DoneActivitiesCount | Integer | True |
DoneActivitiesCount. | |
| EmailMessagesCount | Integer | True |
EmailMessagesCount. | |
| FilesCount | Integer | True |
FilesCount. | |
| FirstChar | String | True |
FirstChar. | |
| FollowersCount | Integer | True |
FollowersCount. | |
| Label | Integer | True |
Label. | |
| LastActivityDate | Date | True |
LastActivityDate. | |
| LastActivityId | Integer | True |
LastActivityId. | |
| LostDealsCount | Integer | True |
LostDealsCount. | |
| Name | String | False |
Name. | |
| NextActivityDate | Date | True |
NextActivityDate. | |
| NextActivityId | Integer | True |
NextActivityId. | |
| NextActivityTime | Time | True |
NextActivityTime. | |
| NotesCount | Integer | True |
NotesCount. | |
| OpenDealsCount | Integer | True |
OpenDealsCount. | |
| OwneractiveFlag | Boolean | True |
Owneractive_flag. | |
| OwnerEmail | String | True |
OwnerEmail. | |
| OwnerHasPic | Boolean | True |
OwnerHasPic. | |
| OwnerId | Integer | False |
OwnerId. | |
| OwnerIdName | String | True |
OwnerName. | |
| OwnerPicHash | String | True |
OwnerPicHash. | |
| OwnerIdValue | Integer | True |
OwnerIdValue. | |
| PeopleCount | Integer | True |
PeopleCount. | |
| PictureActiveFlag | Boolean | True |
PictureActiveFlag. | |
| PictureAddTime | Datetime | True |
PictureAddTime. | |
| PictureAddedByUserId | Integer | True |
PictureAddedByUserId. | |
| PictureItemId | Integer | True |
PictureItemId. | |
| PictureItemType | String | True |
PictureItemType. | |
| Picture128 | String | True |
Picture128. | |
| Picture512 | String | True |
Picture512. | |
| PictureUpdateTime | String | True |
PictureUpdateTime. | |
| PictureId | Integer | True |
PictureIid. | |
| RelatedClosedDealsCount | Integer | True |
RelatedClosedDealsCount. | |
| RelatedLostDealsCount | Integer | True |
RelatedLostDealsCount. | |
| RelatedOpenDealsCount | Integer | True |
RelatedOpenDealsCount. | |
| RelatedWonDealsCount | Integer | True |
RelatedWonDealsCount. | |
| Type | String | True |
Type you will get the result of this column only when criteria filter title is used. | |
| UndoneActivitiesCount | Integer | True |
UndoneActivitiesCount. | |
| UpdateTime | Datetime | True |
UpdateTime. | |
| VisibleTo | Integer | False |
Visibility of the organization. The allowed values are 1, 3, 5, 7. | |
| WonDealsCount | Integer | True |
WonDealsCount. | |
| OwnerName | String | True |
Owner Name. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| UserId | Integer |
User Id. |
| FilterId | Integer |
Filter Id. |
Get details of organizations followers.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsFollowers WHERE OrgId = 6
Insert can be executed by specifying the UserId, OrgId columns.The columns that are not read-only can be inserted. Following is an example of how to insert into this table.
INSERT INTO OrganizationsFollowers (UserId, OrgId) VALUES (8230170, 1)
Delete can be executed by specifying the Id, OrgId in the WHERE Clause.
For example:
DELETE FROM OrganizationsFollowers WHERE OrgId = 1 AND id = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Id. | |
| AddTime | Datetime | True |
AddTime. | |
| OrgId [KEY] | Integer | True |
OrgId. | |
| UserId | Integer | False |
UserId. |
Returns data about all person fields.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonFields WHERE Id = 9039
Insert can be executed by specifying the Name and FieldType columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO PersonFields (Name, AddVisibleFlag, FieldType) VALUES ('NameCdataIndia', 'true', 'address')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE PersonFields SET Name = 'My name just started here' WHERE Id = '9062'
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM PersonFields WHERE Id = 9040
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the field. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| AddTime | Datetime | True |
AddTime. | |
| AddVisibleFlag | Boolean | False |
Whether the field is available in 'add new' modal or not (both in web and mobile app). The default value is true. | |
| BulkEditAllowed | Boolean | True |
BulkEditAllowed. | |
| DetailsVisibleFlag | Boolean | True |
DetailsVisibleFlag. | |
| EditFlag | Boolean | True |
EditFlag. | |
| FieldType | String | False |
Type of the field. The allowed values are address, date, daterange, double, enum, monetary, org, people, phone, set, text, time, timerange, user, varchar, varchar_auto, visible_to. | |
| FilteringAllowed | Boolean | True |
FilteringAllowed. | |
| ImportantFlag | Boolean | True |
ImportantFlag. | |
| IndexVisibleFlag | Boolean | True |
IndexVisibleFlag. | |
| Key | String | True |
Key. | |
| LastUpdatedByUserId | String | True |
LastUpdatedByUserId. | |
| MandatoryFlag | Boolean | True |
MandatoryFlag. | |
| Name | String | False |
Name of the field. | |
| Options | String | False |
Options. | |
| OrderNr | Integer | True |
OrderNr. | |
| SearchableFlag | Boolean | True |
SearchableFlag. | |
| SortableFlag | Boolean | True |
SortableFlag. | |
| UpdateTime | Datetime | True |
UpdateTime. |
Get details of persons followers.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Followers id. | |
| AddTime | Datetime | True |
Add time. | |
| PersonId [KEY] | Integer | True |
Person id. | |
| UserId | Integer | False |
User id. | |
| DealId | Integer | True |
Deal id. |
Get all details of persons.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Persons WHERE Id = 14 SELECT * FROM Persons WHERE FirstChar = 'c' SELECT * FROM Persons WHERE FilterId = 1 SELECT * FROM Persons WHERE UserId = 1
Insert can be executed by specifying the Name columns.The columns that are not read-only can be inserted. Following is an example of how to insert into this table.
INSERT INTO Persons (name) VALUES ('testpankaj')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Persons SET Name = 'test123' WHERE Id = 2495
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Persons WHERE id = 15
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Id. | |
| ActiveFlag | Boolean | False |
ActiveFlag. | |
| ActivitiesCount | Integer | True |
ActivitiesCount. | |
| AddTime | Datetime | False |
Optional creation date time of the person Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | |
| CcEmail | String | True |
CcEmail. | |
| ClosedDealsCount | Integer | True |
ClosedDealsCount. | |
| CompanyId | Integer | True |
CompanyId. | |
| CustomFields | String | True |
CustomFields you will get the result of this column only when criteria filter title is used. | |
| DoneActivitiesCount | Integer | True |
DoneActivitiesCount. | |
| String | False |
Email. | ||
| EmailMessagesCount | Integer | True |
EmailMessagesCount. | |
| FilesCount | Integer | True |
FilesCount. | |
| FirstChar | String | True |
If supplied, only persons whose name starts with the specified letter will be returned. | |
| FirstName | String | True |
FirstName. | |
| FollowersCount | Integer | True |
FollowersCount. | |
| Label | Integer | True |
Label. | |
| LastActivityDate | Date | True |
LastActivityDate. | |
| LastActivityId | Integer | True |
LastActivityId. | |
| LastIncomingMailTime | Datetime | True |
LastIncomingMailTime. | |
| LastName | String | True |
LastName. | |
| LastOutgoingMailTime | Datetime | True |
LastOutgoingMailTime. | |
| LostDealsCount | Integer | True |
LostDealsCount. | |
| Name | String | False |
Name. | |
| NextActivityDate | Date | True |
NextActivityDate. | |
| NextActivityId | Integer | True |
NextActivityId. | |
| NextActivityTime | Time | True |
NextActivityTime. | |
| Notes | String | True |
Notes. | |
| NotesCount | Integer | True |
NotesCount. | |
| OpenDealsCount | Integer | True |
OpenDealsCount. | |
| OrgActiveFlag | Boolean | True |
OrgActiveFlag. | |
| OrgAddress | String | True |
OrgAddress. | |
| OrgccEmail | String | True |
OrgccEmail. | |
| OrgName | String | True |
OrgName. | |
| OrgownerId | Integer | True |
OrgownerId. | |
| OrgpeopleCount | Integer | True |
OrgpeopleCount. | |
| Orgvalue | Integer | False |
Orgvalue. | |
| OwnerActiveFlag | Boolean | True |
OwnerActiveFlag. | |
| OwnerEmail | String | True |
OwnerEmail. | |
| OwnerHasPic | Integer | True |
OwnerHasPic. | |
| OwnerId | Integer | False |
OwnerId. | |
| OwnerIdName | String | True |
OwnerName. | |
| OwnerPicHash | String | True |
OwnerPicHash. | |
| OwnerValue | Integer | True |
OwnerValue. | |
| ParticipantClosedDealscount | Integer | True |
ParticipantClosedDealscount. | |
| ParticipantOpenDealsCount | Integer | True |
ParticipantOpenDealsCount. | |
| Phone | String | False |
Phone. | |
| PictureActiveFlag | Boolean | True |
PictureActiveFlag. | |
| PictureAddTime | Datetime | True |
PictureAddTime. | |
| PictureAddedByUserId | Integer | True |
PictureAddedByUserId. | |
| PictureItemId | Integer | True |
PictureItemId. | |
| PictureItemType | String | True |
PictureItemType. | |
| Picture128 | String | True |
Picture128. | |
| Picture512 | String | True |
Picture512. | |
| PictureUpdateTime | String | True |
PictureUpdateTime. | |
| Picturevalue | Integer | True |
Picturevalue. | |
| RelatedClosedDealsCount | Integer | True |
RelatedClosedDealsCount. | |
| RelatedLostDealsCount | Integer | True |
RelatedLostDealsCount. | |
| RelatedOpenDealsCount | Integer | True |
RelatedOpenDealsCount. | |
| RelatedWonDealsCount | Integer | True |
RelatedWonDealsCount. | |
| UndoneActivitiesCount | Integer | True |
UndoneActivitiesCount. | |
| UpdateTime | Datetime | True |
UpdateTime. | |
| VisibleTo | String | False |
Visibility of the person. The allowed values are 1, 3. | |
| WonDealsCount | Integer | True |
WonDealsCount. | |
| PrimaryEmail | String | True |
Primary Email. | |
| MarketingStatus | String | True |
Marketing Status. | |
| OwnerName | String | True |
Owner Name. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FilterId | Integer |
Filter Id. |
| UserId | Integer |
User Id. |
Get all Pipelines.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Pipelines WHERE Id = 4
Insert can be executed by specifying the Name, Active, DealProbability, OrderNr and UrlTitle columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO PipeLines (Name, Active, DealProbability, OrderNr, UrlTitle) VALUES ('Indias PipeLines for Pipedrive', 'true', '0', 1, 'indiapipedrivepipeline@com')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE PipeLines SET Name = 'Updating Pipedrive Pipelines1' WHERE Id = 4
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM PipeLines WHERE Id = 5
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the pipeline. | |
| Name | String | False |
The name of the Pipeline. | |
| Active | Boolean | False |
Whether this Pipeline will be made inactive (hidden) or active. | |
| DealProbability | Integer | False |
Whether Deal probability is disabled or enabled for this Pipeline. The allowed values are 0, 1. | |
| OrderNr | Integer | False |
Defines the order of Pipelines. The default value is 0. | |
| Selected | Boolean | True |
Selected. | |
| UpdateTime | Datetime | True |
UpdateTime. | |
| AddTime | Datetime | True |
AddTime. | |
| UrlTitle | String | False |
UrlTitle. |
Returns data about all product fields.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ProductFields WHERE Id = 28
Insert can be executed by specifying the Name and FieldType columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO ProductFields (Name, FieldType) VALUES ('BangaloreCdataIndia123', 'address')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE ProductFields SET Name = 'My name just started here' WHERE Id = 28
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM ProductFields WHERE Id = 9040
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the Product Field. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| AddTime | Datetime | True |
AddTime. | |
| AddVisibleFlag | Boolean | True |
AddVisibleFlag. | |
| BulkEditAllowed | Boolean | True |
BulkEditAllowed. | |
| DetailsVisibleFlag | Boolean | True |
DetailsVisibleFlag. | |
| EditFlag | Boolean | True |
EditFlag. | |
| FieldType | String | False |
Type of the field. The allowed values are address, date, daterange, double, enum, monetary, org, people, phone, set, text, time, timerange, user, varchar, varchar_auto, visible_to. | |
| FilteringAllowed | Boolean | True |
FilteringAllowed. | |
| ImportantFlag | Boolean | True |
ImportantFlag. | |
| IndexVisibleFlag | Boolean | True |
IndexVisibleFlag. | |
| Key | String | True |
Key. | |
| LastUpdatedByUserId | String | True |
LastUpdatedByUserId. | |
| MandatoryFlag | Boolean | True |
MandatoryFlag. | |
| Name | String | False |
Name of the field. | |
| Options | String | False |
Options. | |
| OrderNr | Integer | True |
OrderNr. | |
| PicklistData | String | True |
PicklistData. | |
| SearchableFlag | Boolean | True |
SearchableFlag. | |
| SortableFlag | Boolean | True |
SortableFlag. | |
| UpdateTime | Datetime | True |
UpdateTime. |
Get details of Products.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Products WHERE Id = 14 SELECT * FROM Products WHERE FirstChar = 'c' SELECT * FROM Products WHERE FilterId = 1 SELECT * FROM Products WHERE UserId = 1 SELECT * FROM Products WHERE GetSummary = 1 SELECT * FROM Products WHERE Ids IN (1, 2)
Insert can be executed by specifying the Name columns.The columns that are not read-only can be inserted. Following is an example of how to insert into this table.
INSERT INTO Products (name) VALUES ('tests')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Products SET Name = 'test123' WHERE Id = 2495
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Products WHERE Id = 15
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Product Id. | |
| ActiveFlag | Boolean | True |
Whether this product will be made active or not. The allowed values are 0, 1. The default value is 1. | |
| AddTime | Datetime | True |
Add Time. | |
| Category | String | True |
category. | |
| Code | String | False |
Product code. | |
| CustomFields | String | True |
CustomFields you will get the result of this column only when criteria filter title is used. | |
| Description | String | True |
description. | |
| FilesCount | String | True |
FilesCount. | |
| FirstChar | String | True |
If supplied only Products whose name starts with the specified letter will be returned. | |
| Name | String | False |
Name of the product. | |
| OwnerActiveFlag | Boolean | True |
OwnerActiveFlag. | |
| OwnerEmail | String | True |
OwnerEmail. | |
| OwnerHasPic | Boolean | True |
OwnerHasPic. | |
| OwnerId | Integer | False |
ID of the user who will be marked as the owner of this product. | |
| OwnerName | String | True |
OwnerName. | |
| OwnerPicHash | String | True |
OwnerPicHas. | |
| Ownervalue | Integer | True |
Owner Id. | |
| Prices | String | False |
Object containing price objects. | |
| Selectable | Boolean | False |
Whether this product can be selected in Deals or not. The allowed values are 0, 1. The default value is 1. | |
| Tax | Integer | False |
Tax percentage. The default value is 0. | |
| Type | String | True |
Type you will get the result of this column only when criteria filter title is used. | |
| Unit | String | False |
Unit in which this product is sold. | |
| UpdateTime | Datetime | True |
Update Time. | |
| VisibleTo | String | False |
Visibility of the product. The allowed values are 1, 3, 5, 7. | |
| SummaryTotalCount | String | True |
You will get data of this column when Criterial filter is GetSummary is used. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| UserId | Integer |
User Id. |
| FilterId | Integer |
Filter Id. |
| GetSummary | Boolean |
Get SUmmary. |
| Ids | Integer |
The Ids of the Products that should be returned in the response. |
Get details of products followers.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ProductsFollowers WHERE ProductId = 6
Insert can be executed by specifying the UserId, ProductId columns.The columns that are not read-only can be inserted. Following is an example of how to insert into this table.
INSERT INTO ProductsFollowers (UserId, ProductId) VALUES (8230170, 1)
Delete can be executed by specifying the Id, ProductId in the WHERE Clause.
For example:
DELETE FROM ProductsFollowers WHERE ProductId = 1 AND id = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Id. | |
| AddTime | Datetime | True |
AddTime. | |
| ProductId [KEY] | Integer | True |
ProductId. | |
| UserId | Integer | False |
UserId. |
Get all projects data.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Projects WHERE status = 'open' SELECT * FROM Projects WHERE phaseId = 1
Insert can be executed by specifying the Title, BoardId and PhaseId columns. The columns that are not required can be inserted optionally.
INSERT INTO Projects (Title, BoardId, PhaseId) VALUES ('New Project', 3,1)
UPDATE can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Projects SET Title = 'Updated Project title' WHERE Id = 1
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Projects WHERE Id = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the project. | |
| Title | String | False |
The title of the project. | |
| Description | String | False |
The description of the project. | |
| Status | String | False |
The status of the project. | |
| AddTime | Datetime | True |
The date-time when the project was added. | |
| StartDate | Date | False |
The date when the project was started. | |
| UpdateTime | Datetime | True |
The date-time when the project was updated. | |
| ArchiveTime | Datetime | True |
The date-time when the project was archived. | |
| StatusChangeTime | Datetime | True |
The date-time when the status of the project was changed. | |
| BoardId | Integer | False |
The board id of the project. | |
| DealIds | String | False |
The deal ids linked to the project. | |
| EndDate | Date | False |
The end date for the project. | |
| LabelsAggregate | String | False |
The labels linked to the project. | |
| OrgId | Integer | False |
The org id of the project. | |
| OwnerId | Integer | False |
The id of the owner of the project. | |
| PersonId | Integer | False |
The id of the person linked to the project. | |
| PhaseId | Integer | False |
The phase id of the project. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FilterId | Integer |
The ID of the Filter to use. |
| IncludeArchived | Boolean |
Include archived. |
Returns all the role.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Roles SELECT * FROM Roles WHERE Id = 2
Insert can be executed by specifying the Name and ParentRoleId columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO Roles (Name, ParentRoleId) VALUES ('BangaloreCdataIndia123', '2')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Roles SET Name = 'My name just started here' WHERE Id = 1
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Roles WHERE Id = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the role. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| AssignmentCount | String | True |
AssignmentCount. | |
| Level | Integer | True |
Level. | |
| Name | String | False |
The name of the Role. | |
| ParentRoleId | Integer | False |
The ID of the parent Role. | |
| SubRoleCount | String | True |
SubRoleCount. |
List assignments for a role.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM RolesAssignments SELECT * FROM RolesAssignments WHERE Id = 1
Insert can be executed by specifying the Id and UserId columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO RoleAssignments (Id, UserId, RoleId) VALUES (1, 'NameCdataIndia', '1')
Delete can be executed by specifying the Id and UserId WHERE Clause.
For example:
DELETE FROM RolesAssignments WHERE Id = 1 AND UserId = 1
| Name | Type | ReadOnly | References | Description |
| RoleId | Integer | False |
RoleId. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| Name | String | True |
Name. | |
| ParentRoleId | String | True |
ParentRoleId. | |
| Type | String | True |
Type. | |
| UserId | Integer | False |
ID of the user. |
Returns all the roles settings.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM RolesSetting SELECT * FROM RolesSetting WHERE RoleId = 1
Insert can be executed by specifying the Name and FieldType columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO RolesSetting (RoleId, SettingKey, Value) VALUES (1, 'deal_default_visibility', '1')
Update can be executed by specifying the RoleId in the WHERE Clause and SettingKey and Value in Body Parameter. The columns that are not read-only can be Updated.
For example:
UPDATE RolesSetting SET Value = '3', SettingKey = 'deal_default_visibility' WHERE RoleId = 1
| Name | Type | ReadOnly | References | Description |
| RoleId [KEY] | Integer | True |
Role Id. | |
| DealDefaultVisibility | Integer | True |
DealDefaultVisibility. | |
| LeadDefaultVisibility | Integer | True |
LeadDefaultVisibility. | |
| OrgDefaultVisibility | Integer | True |
OrgDefaultVisibility. | |
| PersonDefaultVisibility | Integer | True |
PersonDefaultVisibility. | |
| ProductDefaultVisibility | Integer | True |
ProductDefaultVisibility. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Value | String |
Possible values for the default_visibility setting depending on the subscription plan. The allowed values are 1, 3, 5, 7. |
| SettingKey | String |
SettingKey. The allowed values are deal_default_visibility, lead_default_visibility, org_default_visibility, person_default_visibility, product_default_visibility. |
Returns data about all stages.
Note: DEPRECATED. To be removed in v26. Use Stages instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Stages WHERE Id = 7
Insert can be executed by specifying the Name, PipelineId, DealProbability and RottenFlag columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO Stages (Name, PipelineId, DealProbability, RottenFlag) VALUES ('BangaloreCdataIndia123', '1', '1', '0')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Stages SET Name = 'My name just started here' WHERE Id = 7
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Stages WHERE Id = 8
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the stage. | |
| ActiveFlag | Boolean | True |
ActiveFlag. | |
| AddTime | Datetime | True |
AddTime. | |
| DealProbability | Integer | False |
Deal success probability percentage. | |
| Name | String | False |
Name of the Stage. | |
| OrderNr | Integer | False |
An order number for this stage. | |
| PipelineDealProbability | Integer | True |
PipelineDealProbability. | |
| PipelineId | Integer | False |
The ID of the Pipeline to add Stage to. | |
| PipelineName | String | True |
PipelineName. | |
| RottenDays | String | False |
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 |
Whether Deals in this stage can become rotten. The allowed values are 0, 1. | |
| UpdateTime | Datetime | True |
UpdateTime. |
Get all tasks data.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Tasks WHERE Id = 1 SELECT * FROM Tasks WHERE done = 0 SELECT * FROM Tasks WHERE ParentTaskId = 3
Insert can be executed by specifying the Title and ProjectId columns. The columns that are not required can be inserted optionally.
INSERT INTO Tasks (Title, ProjectId) VALUES ('New task', 3)
UPDATE can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Tasks SET Title = 'Updated task title' WHERE Id = 1
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Tasks WHERE Id = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the task. | |
| Title | String | False |
The title of the task. | |
| Description | String | False |
The description of the task. | |
| Done | Integer | False |
If the task is done. | |
| DueDate | Date | False |
Due date of the task. | |
| AddTime | Datetime | True |
The date when the task was added. | |
| AssigneeId | Integer | False |
The id of the assignee of the task. | |
| CreatorId | Integer | True |
The id of the creator of the task. | |
| MarkedAsDoneTime | Datetime | True |
The time when the task was marked as done. | |
| ParentTaskId | Integer | False |
The id of the parent task | |
| ProjectId | Integer | False |
The id of the corresponding project. | |
| UpdateTime | Datetime | True |
The date-time when the task was updated. |
Returns data about all users within the company
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Users WHERE Id = 13816635
Insert can be executed by specifying the Name, Email and ActiveFlag columns. The columns that are not required can be inserted optionally.
For example:
INSERT INTO Users (Name, Email, ActiveFlag) VALUES ('CdataIndiaEngineering', '[email protected]', 'true')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Users SET ActiveFlag = 'false' WHERE Id = 13944807
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the user. | |
| Activated | Boolean | False |
Activated. | |
| ActiveFlag | Boolean | False |
Whether the user is active or not. The default value is true. | |
| Created | Datetime | False |
Created. | |
| DefaultCurrency | String | False |
DefaultCurrency. | |
| String | False |
Email of the user. | ||
| Hascreatedcompany | Boolean | False |
Hascreatedcompany. | |
| IconUrl | String | False |
IconUrl. | |
| IsAdmin | Integer | False |
IsAdmin. | |
| IsYou | Boolean | False |
IsYou. | |
| Lang | Integer | False |
Lang. | |
| LastLogin | Datetime | False |
LastLogin. | |
| Locale | String | False |
Locale. | |
| Modified | Datetime | False |
Modified. | |
| Name | String | False |
Name of the user. | |
| Phone | String | False |
Phone. | |
| RoleId | Integer | False |
ID of the role. | |
| TimezoneName | String | False |
TimezoneName. | |
| TimezoneOffset | String | False |
TimezoneOffset. | |
| Access | String | False |
The access given to the user. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| 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. |
| 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. |
| DealFieldsOptions | Returns data about all deal fields. |
| 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. |
| 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. |
| 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. |
| 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. |
| FilterHelpers | Returns all supported filter helpers. |
| FindUsersByName | Finds users by their name. |
| LeadPermittedUsers | Get all permitted users for leads in a single company |
| 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. |
| MailThreadsFrom | Get details of the user who sent the mail. |
| MailThreadsTo | Get details of the user to whom sent the mail. |
| NoteFields | Returns data about all note fields. |
| NoteFieldsOptions | Returns data about all note fields options. |
| OrganizationFieldsOptions | Returns data about all organization fields options. |
| 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. |
| 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 | . |
| PersonFieldsOptions | Returns data about all person fields options. |
| 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 |
| ProductFieldsOptions | Returns data about all product fields options. |
| 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. |
| ProductsPermittedUsers | Get details of users permitted to access a Product. |
| ProductsPrices | Get details of Products Prices. |
| ProjectTemplates | Get the details of a specific project template. |
| 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. |
| RolesPipelinesVisibility | Get the list of either visible or hidden pipeline IDs for a specific role. |
| StagesDeals | Get deals in a specific stage. |
| UserConnection | The data of user connections. |
| UsersAccess | Returns access details for all users in the company. |
| 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. |
Get all Activities attendees assigned to a particular User
Note: DEPRECATED. To be removed in v26. Use ActivitiesAttendees instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ActivitiesAttendees WHERE ActivitiesId = 246
SELECT * FROM ActivitiesAttendees WHERE Done = 0
SELECT * FROM ActivitiesAttendees WHERE Type IN ('deadline', 'call')
SELECT * FROM ActivitiesAttendees WHERE EndDate = '2021-12-24'
SELECT * FROM ActivitiesAttendees WHERE UserId = 8230170
| Name | Type | References | Description |
| ActivitiesId [KEY] | Integer |
Activities.Id | Activities ID. |
| EmailAddress | String | EmailAddress. | |
| IsOrganizer | Integer | IsOrganizer. | |
| Name | String | Name. | |
| PersonId | Integer |
Persons.Id | PersonId. |
| Status | String | Status. | |
| UserId | String |
Users.Id | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Type | String | 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.
The default value is Call. | |
| Done | Boolean | Whether the Activity is done or not. 0 = Not done 1 = Done. If omitted, returns both Done and Not done activities.
The allowed values are 0, 1. | |
| FilterId | Integer | The ID of the Filter to use. | |
| StartDate | String | Use the Activity due date where you wish to begin fetching Activities from Insert due date in YYYY-MM-DD format. | |
| EndDate | String | Use the Activity due date where you wish to stop fetching Activities from Insert due date in YYYY-MM-DD format. |
Getdetails of activities participants
Note: DEPRECATED. To be removed in v26. Use ActivitiesParticipants instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ActivitiesParticipants WHERE ActivitiesId = 246
SELECT * FROM ActivitiesParticipants WHERE Done = 0
SELECT * FROM ActivitiesParticipants WHERE Type IN ('deadline', 'call')
SELECT * FROM ActivitiesParticipants WHERE EndDate = '2021-12-24'
SELECT * FROM ActivitiesParticipants WHERE UserId = 8230170
| Name | Type | References | Description |
| PersonId [KEY] | Integer | PersonId | |
| ActivitiesId | Integer |
Activities.Id | Activities ID. |
| PrimaryFlag | Boolean | PrimaryFlag |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Type | String | 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
The default value is Call. | |
| Done | Boolean | Whether the Activity is done or not 0 = Not done 1 = Done If omitted returns both Done and Not done activities
The allowed values are 0, 1. | |
| FilterId | Integer | The ID of the Filter to use | |
| StartDate | String | Use the Activity due date where you wish to begin fetching Activities from Insert due date in YYYY-MM-DD format | |
| EndDate | String | Use the Activity due date where you wish to stop fetching Activities from Insert due date in YYYY-MM-DD format | |
| UserId | String | UserId |
Returns all activity fields.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ActivityFields
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| ActiveFlag | Boolean | ActiveFlag. | |
| AddTime | Datetime | AddTime. | |
| AddVisibleFlag | Boolean | AddVisibleFlag. | |
| BulkEditAllowed | Boolean | BulkEditAllowed. | |
| DetailsVisibleFlag | Boolean | DetailsVisibleFlag. | |
| EditFlag | Boolean | EditFlag. | |
| FieldType | String | FieldType. | |
| FilteringAllowed | Boolean | FilteringAllowed. | |
| ImportantFlag | Boolean | ImportantFlag. | |
| IndexVisibleFlag | Boolean | IndexVisibleFlag. | |
| Key | String | Key. | |
| LastUpdatedByUserId | String | LastUpdatedByUserId. | |
| MandatoryFlag | Boolean | MandatoryFlag. | |
| Name | String | Name. | |
| Options | String | Options. | |
| OrderNr | Integer | OrderNr. | |
| SearchableFlag | Boolean | SearchableFlag. | |
| SortableFlag | Boolean | SortableFlag. | |
| UpdateTime | Datetime | UpdateTime. |
Returns all activity fields.
| Name | Type | References | Description |
| Id [KEY] | String | Id. | |
| Label | String | Label. |
Returns all supported currencies in given account which should be used when saving monetary values with other objects.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side. Term can be Currencies.Name or/and Currencies.Code:
SELECT * FROM Currencies WHERE Term = 'Armenian Dram' SELECT * FROM Currencies WHERE Term = 'AFN'
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| ActiveFlag | Boolean | ActiveFlag. | |
| Code | String | Code. | |
| DecimalPoints | Integer | DecimalPoints. | |
| IsCustomFlag | Boolean | IsCustomFlag. | |
| Name | String | Name. | |
| Symbol | String | Symbol. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Term | String | Optional search term that is searched for from currency's name and/or code. |
Returns data about an authorized user within the company with bound company data: company ID, company name, and domain.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM CurrentUsers SELECT * FROM CurrentUsers WHERE Id = 2
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the user. | |
| Activated | Boolean | Activated. | |
| ActiveFlag | Boolean | Whether the user is active or not.
The default value is true. | |
| Created | Datetime | Created. | |
| DefaultCurrency | String | DefaultCurrency. | |
| String | Email of the user. | ||
| Hascreatedcompany | Boolean | Hascreatedcompany. | |
| IconUrl | String | IconUrl. | |
| IsAdmin | Integer | IsAdmin. | |
| IsYou | Boolean | IsYou. | |
| Lang | Integer | Lang. | |
| LastLogin | Datetime | LastLogin. | |
| Locale | String | Locale. | |
| Modified | Datetime | Modified. | |
| Name | String | Name of the user. | |
| Phone | String | Phone. | |
| RoleId | Integer | ID of the role. | |
| TimezoneName | String | TimezoneName. | |
| TimezoneOffset | String | TimezoneOffset. | |
| Access | String | The access given to the user. | |
| CompanyId | Integer | Company Id. | |
| CompanyName | String | Company Name. | |
| CompanyDomain | String | Company Domain. | |
| CompanyCountry | String | Company Country. | |
| CompanyIndustry | String | Company Industry. | |
| LanguageCode | String | Language Code. | |
| CountryCode | String | Country Code. |
Returns data about all deal fields.
| Name | Type | References | Description |
| Id [KEY] | String | Id. | |
| Label | String | Label. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Name | String | Name of the field. | |
| FieldType | String | Type of the field.
The allowed values are address, date, daterange, double, enum, monetary, org, people, phone, set, text, time, timerange, user, varchar, varchar_auto, visible_to. | |
| AddVisibleFlag | Boolean | AddVisibleFlag. |
Get all Deals Activities assigned to a particular User.
Note: DEPRECATED. To be removed in v26. Use Activities with DealId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsActivities WHERE DealId = 246
SELECT * FROM DealsActivities WHERE DealId = 246 AND done = 0
SELECT * FROM DealsActivities WHERE DealId = 246 AND Exclude IN ('240', '241')
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| ActiveFlag | Boolean | Active Flag. | |
| AddTtime | Datetime | Add Ttime. | |
| AssignedToUserId | Integer | Assigned To UserId. | |
| Attendees | String | Attendees. | |
| BusyFlag | Boolean | BusyFlag. | |
| IncludeContext | String | Include Context. | |
| CompanyId | Integer | Company Id. | |
| MeetingClient | String | Meeting Client. | |
| MeetingId | String | Meeting Id. | |
| MeetingUrl | String | Meeting Url. | |
| CreatedByUserId | Integer | CreatedBy UserId. | |
| DealDropboxBcc | String | Deal Dropbox Bcc. | |
| DealId | Integer | Deal Id. | |
| DealTitle | String | Deal Title. | |
| Done | Boolean | Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
The allowed values are 0, 1. | |
| DueDate | Date | Due Date. | |
| DueTime | Time | Due Time. | |
| Duration | Time | Duration. | |
| FileCleanName | String | FileCleanName. | |
| FileId | String | FileId. | |
| FileUrl | String | FileUrl. | |
| EventId | String | eventId. | |
| CalendarEtag | String | CalendarEtag. | |
| CalendarId | String | Calendar Id. | |
| NotificationTime | Datetime | Notification Time. | |
| NotificationUserId | Integer | Notification UserId. | |
| LeadId | String | Lead Id. | |
| Location | String | Location. | |
| AreaLevel1 | String | AreaLevel1. | |
| AreaLevel2 | String | AreaLevel2. | |
| Country | String | Country. | |
| FormattedAddress | String | FormattedAddress. | |
| Lat | Double | Lat. | |
| Locality | String | Locality. | |
| Long | Double | Long. | |
| PostalCode | String | PostalCode. | |
| Route | String | Route. | |
| StreetNumber | String | StreetNumber. | |
| Sublocality | String | Sublocality. | |
| Subpremise | String | Subpremise. | |
| MarkedAsDoneTime | Datetime | MarkedAsDoneTime. | |
| Note | String | Note. | |
| NotificationLanguageId | Integer | NotificationLanguageId. | |
| OrgId | Integer | OrgId. | |
| OrgName | String | OrgName. | |
| OwnerName | String | OwnerName. | |
| Participants | String | Participants. | |
| PersonDropboxBcc | String | Person Dropbox Bcc. | |
| PersonId | Integer | PersonId. | |
| PersonName | String | PersonName. | |
| PublicDescription | String | PublicDescription. | |
| MasterActivityId | String | MasterActivityId. | |
| Rule | String | Rule. | |
| RuleExtension | String | RuleExtension. | |
| ReferenceId | Integer | ReferenceId. | |
| ReferenceType | String | ReferenceType. | |
| Series | String | Series. | |
| SourceTimezone | String | SourceTimezone. | |
| Subject | String | Subject. | |
| Type | String | Type. | |
| UpdateTime | Datetime | UpdateTime. | |
| UpdateUserId | Integer | UpdateUserId. | |
| UserId | Integer | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Exclude | String | A comma-separated string of activity IDs to exclude from result. |
Get Details of Deals Activities Attendees.
Note: DEPRECATED. To be removed in v26. Use ActivitiesAttendees with DealId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsActivitiesAttendees WHERE DealId = 246
SELECT * FROM DealsActivitiesAttendees WHERE DealId = 246 AND done = 0
SELECT * FROM DealsActivitiesAttendees WHERE DealId = 246 Exclude IN ('240', '241')
| Name | Type | References | Description |
| DealId | Integer | Deal Id. | |
| EmailAddress | String | EmailAddress. | |
| IsOrganizer | Integer | IsOrganizer. | |
| Name | String | Name. | |
| PersonId | Integer |
Persons.Id | PersonId. |
| Status | String | Status. | |
| UserId | String |
Users.Id | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Done | Boolean | Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
The allowed values are 0, 1. | |
| Exclude | String | A comma-separated string of activity IDs to exclude from result. |
Getdetails of activities participants.
Note: DEPRECATED. To be removed in v26. Use ActivitiesParticipants with DealId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsActivitiesParticipants WHERE DealId = 246
SELECT * FROM DealsActivitiesParticipants WHERE DealId = 246 AND done = 0
SELECT * FROM DealsActivitiesParticipants WHERE DealId = 246 Exclude IN ('240', '241')
| Name | Type | References | Description |
| DealId | Integer | Deal Id. | |
| PersonId [KEY] | Integer | PersonId. | |
| PrimaryFlag | Boolean | PrimaryFlag. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Done | Boolean | Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
The allowed values are 0, 1. | |
| Exclude | String | A comma-separated string of activity IDs to exclude from result. |
Get details of deals file.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsFiles WHERE DealId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the deal. | |
| ActiveFlag | Boolean | Active Flag. | |
| ActivityId | String | Activity Id. | |
| AddTime | Datetime | AddTime. | |
| Cid | String | Cid. | |
| DealId | String | Deal Id. | |
| DealName | String | DealName. | |
| Description | String | Description. | |
| FileName | String | File Name. | |
| FileSize | Integer | File Size. | |
| FileType | String | File Type. | |
| InlineFlag | Boolean | Inline Flag. | |
| LogId | String | Log Id. | |
| MailMessageId | String | MailMessage Id. | |
| MailTemplateId | String | MailTemplate Id. | |
| Name | String | Name. | |
| OrgId | Integer | Org Id. | |
| OrgName | String | Org Name. | |
| PeopleName | String | People Name. | |
| PersonId | String | PersonId. | |
| PersonName | String | Person Name. | |
| ProductId | String | Product Id. | |
| ProductName | String | Product Name. | |
| RemoteId | String | Remote Id. | |
| RemoteLocation | String | Remote Location. | |
| S3Bucket | String | S3Bucket. | |
| UpdateTime | Datetime | Update Time. | |
| Url | String | Url. | |
| UserId | Integer | UserId. | |
| LeadId | String | Lead Id. | |
| LeadName | String | Lead Name. |
Get details of Deal mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsMailMessages WHERE Id = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | id. | |
| AccountId | String | AccountId. | |
| AddTime | Datetime | addTime. | |
| Bcc | String | Bcc. | |
| BodyUrl | String | bodyUrl. | |
| Cc | String | cc. | |
| CompanyId | Integer | companyId. | |
| DeletedFlag | Integer | DeletedFlag. | |
| Draft | String | Draft. | |
| DraftFlag | Integer | DraftFlag. | |
| ExternalDeletedFlag | Integer | ExternalDeletedFlag. | |
| From | String | From. | |
| AttachmentsFlag | Integer | AttachmentsFlag. | |
| BodyFlag | Integer | BodyFlag. | |
| InlineAttachmentsFlag | Integer | InlineAttachmentsFlag. | |
| RealAttachmentsFlag | Integer | RealAttachmentsFlag. | |
| ItemType | String | ItemType. | |
| TrackingEnabledFlag | Integer | TrackingEnabledFlag. | |
| ThreadId | Integer | ThreadId. | |
| TrackingStatus | String | TrackingStatus. | |
| MessageTime | String | MessageTime. | |
| MessageId | String | MessageId. | |
| NylasId | String | NylasId. | |
| ReadFlag | Integer | ReadFlag. | |
| S3Bucket | String | S3Bucket. | |
| S3BucketPath | String | S3BucketPath. | |
| SentFlag | Integer | SentFlag. | |
| SentFromPipedriveFlag | Integer | SentFromPipedriveFlag. | |
| SmartBccFlag | Integer | SmartBccFlag. | |
| Snippet | String | Snippet. | |
| Subject | String | Subject. | |
| SyncedFlag | Integer | SyncedFlag. | |
| TemplateId | String | TemplateId. | |
| Timestamp | Datetime | Timestamp. | |
| To | String | To. | |
| UpdateTime | Datetime | UpdateTime. | |
| UserId | Integer | UserId. | |
| WriteFlag | Boolean | writeFlag. | |
| Object | String | Object. |
Get details of Deal mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsMailMessagesBcc WHERE Id = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of Deal mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsMailMessagesCc WHERE Id = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of Deal mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsMailMessagesFrom WHERE Id = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of Deal mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsMailMessagesTo WHERE Id = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of deals participants Person Email.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsParticipantsEmail SELECT * FROM DealsParticipantsEmail WHERE DealsParticipantsId = 2
| Name | Type | References | Description |
| DealsParticipantsId [KEY] | Integer | Id. | |
| Label | String | Label. | |
| Value | String | Email. | |
| Primary | Boolean | Boolean value Primary. |
Get details of deals participants Person Email.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsParticipantsPersonEmail SELECT * FROM DealsParticipantsPersonEmail WHERE DealsParticipantsId = 2
| Name | Type | References | Description |
| DealsParticipantsId [KEY] | Integer | Id. | |
| Label | String | Label. | |
| Value | String | Email. | |
| Primary | Boolean | Boolean value Primary. |
Get details of deals participants Person Phone.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsParticipantsPersonPhone SELECT * FROM DealsParticipantsPersonPhone WHERE DealsParticipantsId = 2
| Name | Type | References | Description |
| DealsParticipantsId [KEY] | Integer | Id. | |
| Label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Boolean value Primary. |
Get details of deals participants Person Email.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsParticipantsPhone SELECT * FROM DealsParticipantsPhone WHERE DealsParticipantsId = 2
| Name | Type | References | Description |
| DealsParticipantsId [KEY] | Integer | Id. | |
| Label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Boolean value Primary. |
Get details of deals Permitted users
| Name | Type | References | Description |
| Data | String | Data. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Id | String | Id. |
Get all emails asscociated with persons in deal
Note: DEPRECATED. To be removed in v26.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsPersonEmails SELECT * FROM DealsPersonEmails WHERE DealsId = 2
| Name | Type | References | Description |
| DealsId [KEY] | Integer |
Deals.Id | Deals ID. |
| Label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Primary. |
Get all phone asscociated with persons in deal.
Note: DEPRECATED. To be removed in v26.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsPersonPhone SELECT * FROM DealsPersonPhone WHERE DealsId = 2
| Name | Type | References | Description |
| DealsId [KEY] | Integer |
Deals.Id | Deals ID. |
| label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Primary. |
Get details of deals persons.
Note: DEPRECATED. To be removed in v26. Use Persons with DealId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsPersons SELECT * FROM DealsPersons WHERE DealId = 8
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| DealId | Integer | Deal Id. | |
| ActivitiesCount | Integer | ActivitiesCount. | |
| ActiveFlag | Boolean | ActiveFlag. | |
| AddTime | Datetime | AddTime. | |
| CcEmail | String | CcEmail. | |
| ClosedDealsCount | Integer | ClosedDealsCount. | |
| CompanyId | Integer | CompanyId. | |
| DoneActivitiesCount | Integer | DoneActivitiesCount. | |
| String | Email. | ||
| EmailMessagesCount | Integer | EmailMessagesCount. | |
| FilesCount | Integer | FilesCount. | |
| Label | Integer | label. | |
| LastActivityDate | Date | LastActivityDate. | |
| LastActivityId | Integer | LastActivityId. | |
| LastincomingMailTime | String | LastincomingMailTime. | |
| Lastname | String | Lastname. | |
| LastoutgoingMailTime | String | LastoutgoingMailTime. | |
| LostdealsCount | Integer | LostdealsCount. | |
| Name | String | Name. | |
| NextActivityDate | Date | nextActivityDate. | |
| NextActivityId | Integer | nextActivityId. | |
| NextActivityTime | String | nextActivityTime. | |
| NotesCount | Integer | NotesCount. | |
| OpenDealsCount | Integer | OpenDealsCount. | |
| OrgActiveFlag | Boolean | OrgActiveFlag. | |
| OrgAddress | String | OrgAddress. | |
| OrgCcEmail | String | OrgCcEmail. | |
| OrgName | String | OrgName. | |
| OrgownerId | Integer | OrgownerId. | |
| OrgpeopleCount | Integer | OrgpeopleCount. | |
| OrgId | Integer | OrgId. | |
| OwnerActiveFlag | Boolean | OwnerActiveFlag. | |
| OwnerEmail | String | OwnerEmail. | |
| OwnerHasPic | Integer | OwnerHasPic. | |
| OwnerId | Integer | OwnerId. | |
| OwnerName | String | OwnerName. | |
| OwnerPicHash | String | OwnerPicHash. | |
| OwnerValue | Integer | OwnerValue. | |
| ParticipantClosedDealsCount | Integer | ClosedDealsCount. | |
| ParticipantOpenDealsCount | Integer | OpenDealsCount. | |
| Phone | String | Phone. | |
| PictureActiveFlag | Boolean | PictureActiveFlag. | |
| PictureaddTime | Datetime | PictureaddTime. | |
| PictureaddedByUserId | Integer | PictureaddedByUserId. | |
| PictureItemId | Integer | PictureItemId. | |
| PictureitemType | String | PictureitemType. | |
| Picture128 | String | Picture128. | |
| Picture512 | String | Picture512. | |
| PictureupdateTime | String | PictureupdateTime. | |
| Picturevalue | Integer | Picturevalue. | |
| PictureId | String | PictureId. | |
| RelatedclosedDealsCount | Integer | RelatedclosedDealsCount. | |
| RelatedlostDealsCount | Integer | RelatedlostDealsCount. | |
| RelatedopenDealsCount | Integer | RelatedopenDealsCount. | |
| RelatedwonDealsCount | Integer | RelatedwonDealsCount. | |
| UndoneActivitiesCount | Integer | UndoneActivitiesCount. | |
| UpdateTime | Datetime | UpdateTime. | |
| VisibleTo | String | visibleTo. | |
| WonDealsCount | Integer | WonDealsCount. | |
| FirstName | String | First Name. | |
| FollowersCount | Integer | Followers Count. | |
| PrimaryEmail | String | Primary Email. | |
| FirstChar | String | First Char. | |
| MarketingStatus | String | Marketing Status. |
Get details of deals participants Person Email.
| Name | Type | References | Description |
| DealsPersonsId [KEY] | Integer |
DealsPersons.Id | Id. |
| Label | String | Label. | |
| Value | String | Email. | |
| Primary | Boolean | Boolean value Primary. |
Get details of deals participants Person Email.
Note: DEPRECATED. To be removed in v26. Use PersonsPhone with DealId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsPersonsPhone WHERE DealsPersonsId = 2
| Name | Type | References | Description |
| DealsPersonsId [KEY] | Integer |
DealsPersons.Id | Id. |
| Label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Boolean value Primary. |
Return detils of deals summary.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsSummary WHERE UserId = 8230170 SELECT * FROM DealsSummary WHERE Status = 'open' SELECT * FROM DealsSummary WHERE StageId = 1 SELECT * FROM DealsSummary WHERE FilterId = 1
| Name | Type | References | Description |
| TotalCount | Integer | Total Count. | |
| Totalvalue | Double | Total value. | |
| TotalValueFormatted | String | Total Value Formatted. | |
| TotalWeightedValue | Double | Total Weighted Value. | |
| TotalWeightedValueFormatted | String | Total Weighted Value Formatted. | |
| ValuesTotal | String | Values total | |
| WeightedValuesTotal | String | Weighted values total |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FilterId | Integer | Filter Id. | |
| UserId | Integer | User Id. | |
| StageId | Integer | Stage Id. | |
| Status | String | Status. |
Return details of deals timeline
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
Required fields: Amount, StartDate, FieldKey and IntervalType is required
SELECT * FROM DealsTimeline WHERE Amount = '3' AND StartDate = '2021-12-12' AND FieldKey = 'add_time' AND IntervalType = 'month'
| Name | Type | References | Description |
| Deals | String | Deals | |
| PeriodEnd | Datetime | Period End | |
| PeriodStart | Date | Period Start | |
| TotalValues | String | Total Values |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| StartDate | Date | Date where the first interval starts. Format: YYYY-MM-DD. | |
| IntervalType | String | Type Of Interval.
The allowed values are day, week, month, quarter. | |
| Amount | Integer | The number of given intervals, starting from start_date, to fetch E.g 3 months. | |
| FieldKey | String | The date field key which deals will be retrieved from. | |
| UserId | Integer | User id. | |
| FilterId | Integer | Type Of Interval.
The allowed values are day, week, month, quarter. | |
| ExcludeDeals | Integer | Whether to exclude deals list 1 or not 0.
The allowed values are 0, 1. | |
| ConvertCurrency | String | 3-letter currency code of any of the supported currencies. | |
| PipelineId | Integer | Pipeline Id. |
Return details of DealsTimeline deals.
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| Active | Boolean | Active. | |
| ActivitiesCount | Integer | ActivitiesCount. | |
| AddTime | Datetime | AddTime. | |
| CcEmail | String | CcEmail. | |
| CloseTime | String | CloseTime. | |
| CreatorUserId | Integer | CreatorUserId. | |
| Currency | String | Currency. | |
| Deleted | Boolean | Deleted. | |
| DoneActivitiesCount | Integer | DoneActivitiesCount. | |
| EmailMessagesCount | Integer | EmailMessagesCount. | |
| ExpectedCloseDate | Date | ExpectedCloseDate. | |
| FilesCount | Integer | FilesCount. | |
| FirstWonTime | Datetime | FirstWonTime. | |
| FollowersCount | Integer | FollowersCount. | |
| FormattedValue | String | FormattedValue. | |
| FormattedWeightedValue | String | FormattedWeightedValue. | |
| Label | String | Label. | |
| LastActivityDate | String | LastActivityDate. | |
| LastActivityId | String | LastActivityId. | |
| LastncomingMailTime | Datetime | LastncomingMailTime. | |
| LastoutgoingMailTime | Datetime | LastoutgoingMailTime. | |
| Lostreason | String | Lostreason. | |
| LostTime | String | LostTime. | |
| NextActivityDate | Date | NextActivityDate. | |
| NextActivityDuration | Time | NextActivityDuration. | |
| NextActivityId | Integer | NextActivityId. | |
| NextActivityNote | String | NextActivityNote. | |
| NextActivitySubject | String | NextActivitySubject. | |
| NextActivityTime | Time | NextActivityTime. | |
| NextActivityType | String | NextActivityType. | |
| NotesCount | Integer | NotesCount. | |
| OrgHidden | Boolean | OrgHidden. | |
| OrgId | Integer | OrgId. | |
| OrgName | String | OrgName. | |
| OwnerName | String | OwnerName. | |
| ParticipantsCount | Integer | ParticipantsCount. | |
| PersonHidden | Boolean | PersonHidden. | |
| PersonId | Integer | PersonId. | |
| PersonName | String | PersonName. | |
| PipelineId | Integer |
Pipelines.Id | PipelineId. |
| Probability | String | Probability. | |
| ProductsCount | Integer | ProductsCount. | |
| RottenTime | String | RottenTime. | |
| StageChangeTime | Datetime | StageChangeTime. | |
| StageId | Integer | StageId. | |
| StageOrderNr | Integer | StageOrderNr. | |
| Status | String | Status. | |
| Title | String | Title. | |
| UndoneActivitiesCount | Integer | UndoneActivitiesCount. | |
| UpdateTime | Datetime | UpdateTime. | |
| UserId | Integer |
Users.Id | UserId. |
| Value | Integer | Value. | |
| VisibleTo | String | VisibleTo. | |
| WeightedValue | Integer | WeightedValue. | |
| WeightedValueCurrency | String | WeightedValueCurrency. | |
| WonTime | Datetime | WonTime. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| StartDate | Date | Date where the first interval starts. Format: YYYY-MM-DD | |
| IntervalType | String | Type Of Interval.
The allowed values are day, week, month, quarter. | |
| Amount | Integer | The number of given intervals, starting from start_date, to fetch E.g 3 months. | |
| FieldKey | String | The date field key which deals will be retrieved from. | |
| FilterId | Integer | Type Of Interval.
The allowed values are day, week, month, quarter. | |
| ExcludeDeals | Integer | Whether to exclude deals list 1 or not 0.
The allowed values are 0, 1. | |
| ConvertCurrency | String | 3-letter currency code of any of the supported currencies. |
Get details of deals updates.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsUpdates WHERE DealId = 3
SELECT * FROM DealsUpdates WHERE DealId = 246 AND AllChanges = 1
SELECT * FROM DealsUpdates WHERE DealId = 246 AND Items IN ('activity', 'call')
| Name | Type | References | Description |
| Id | Integer | Id. | |
| AccountId | String | AccountId. | |
| ActiveFlag | Boolean | ActiveFlag. | |
| AddTime | Datetime | AddTime. | |
| AdditionalData | String | AdditionalData. | |
| AssignedToUserId | Integer | AssignedToUserId. | |
| Attachments | String | Attachments. | |
| Attendees | String | Attendees. | |
| Bcc | String | Bcc. | |
| BodyUrl | String | BodyUrl. | |
| BusyFlag | Boolean | BusyFlag. | |
| IncludeContext | String | IncludeContext. | |
| Cc | String | Cc. | |
| ChangeSource | String | ChangeSource. | |
| UserAgent | String | UserAgent. | |
| CompanyId | Integer | CompanyId. | |
| MeetingClient | String | MeetingClient. | |
| MeetingId | String | MeetingId. | |
| MeetingUrl | String | MeetingUrl. | |
| CreatedByUserId | Integer | CreatedByUserId. | |
| DealDropboxBcc | String | DealDropboxBcc. | |
| DealId | Integer | DealId. | |
| DealTitle | String | DealTitle. | |
| DeletedFlag | Integer | DeletedFlag. | |
| Done | Boolean | Done. | |
| Draft | String | Draft. | |
| DraftFlag | Integer | DraftFlag. | |
| DueDate | Date | DueDate. | |
| DueTime | Time | DueTime. | |
| Duration | Time | Duration. | |
| ExternalDeletedFlag | Integer | ExternalDeletedFlag. | |
| FieldKey | String | FieldKey. | |
| CleanName | String | CleanName. | |
| FileId | String | FileId. | |
| Url | String | Url. | |
| From | String | From. | |
| GcalEventId | String | GcalEventId. | |
| GoogleCalendarEtag | String | GoogleCalendarEtag. | |
| GoogleCalendarId | String | GoogleCalendarId. | |
| AttachmentsFlag | Integer | AttachmentsFlag. | |
| BodyFlag | Integer | BodyFlag. | |
| InlineAttachmentsFlag | Integer | InlineAttachmentsFlag. | |
| RealAttachmentsFlag | Integer | RealAttachmentsFlag. | |
| IsBulkUpdateFlag | String | IsBulkUpdateFlag. | |
| ItemId | Integer | ItemId. | |
| ItemType | String | ItemType. | |
| NotificationTime | Datetime | NotificationTime. | |
| NotificationUserId | Integer | NotificationUserId. | |
| LeadId | String | LeadId. | |
| Location | String | Location. | |
| AdminAreaLevel1 | String | AdminAreaLevel1. | |
| AdminAreaLevel2 | String | AdminAreaLevel2. | |
| Country | String | Country. | |
| FormattedAddress | String | FormattedAddress. | |
| Lat | Double | Lat. | |
| Locality | String | Locality. | |
| Long | Double | Long. | |
| PostalCode | String | PostalCode. | |
| Route | String | Route. | |
| StreetNumber | String | StreetNumber. | |
| Sublocality | String | Sublocality. | |
| Subpremise | String | Subpremise. | |
| LogTime | Datetime | LogTime. | |
| TrackingEnabledFlag | Integer | TrackingEnabledFlag. | |
| MailThreadId | Integer | MailThreadId. | |
| MailTrackingStatus | String | MailTrackingStatus. | |
| MarkedAsDoneTime | Datetime | MarkedAsDoneTime. | |
| MessageTime | String | MessageTime. | |
| MuaMessageId | String | MuaMessageId. | |
| NewValue | String | NewValue. | |
| Note | String | Note. | |
| LanguageId | Integer | LanguageId. | |
| NylasId | String | NylasId. | |
| OldValue | Integer | OldValue. | |
| OrgId | Integer | OrgId. | |
| OrgName | String | OrgName. | |
| OwnerName | String | OwnerName. | |
| Participants | String | Participants. | |
| PersonDropboxBcc | String | PersonDropboxBcc. | |
| PersonId | Integer | PersonId. | |
| PersonName | String | PersonName. | |
| PublicDescription | String | PublicDescription. | |
| ReadFlag | Integer | ReadFlag. | |
| RecActivityId | String | RecActivityId. | |
| RecRule | String | RecRule. | |
| RecRuleExtension | String | RecRuleExtension. | |
| ReferenceId | Integer | ReferenceId. | |
| ReferenceType | String | ReferenceType. | |
| S3Bucket | String | S3Bucket. | |
| S3BucketPath | String | S3BucketPath. | |
| SentFlag | Integer | SentFlag. | |
| SentFromPipedriveFlag | Integer | SentFromPipedriveFlag. | |
| Series | String | Series. | |
| SmartBccFlag | Integer | SmartBccFlag. | |
| Snippet | String | Snippet. | |
| SourceTimezone | String | SourceTimezone. | |
| Subject | String | Subject. | |
| SyncedFlag | Integer | SyncedFlag. | |
| TemplateId | String | TemplateId. | |
| Timestamp | Datetime | Timestamp. | |
| To | String | To. | |
| Type | String | Type. | |
| UpdateTime | Datetime | UpdateTime. | |
| UpdateUserId | Integer | UpdateUserId. | |
| UserId | Integer | UserId. | |
| WriteFlag | Boolean | WriteFlag. | |
| Object | String | Object. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | Item specific updates.
The allowed values are activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get details of deals Updates Attachments.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsUpdatesAttachments WHERE DealId = 3
SELECT * FROM DealsUpdatesAttachments WHERE DealId = 246 AND AllChanges = 1
SELECT * FROM DealsUpdatesAttachments WHERE DealId = 246 AND Items IN ('activity', 'call')
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| ActiveFlag | Boolean | ActiveFlag. | |
| ActivityId | String | ActivityId. | |
| AddTime | Datetime | AddTime. | |
| Cid | String | Cid. | |
| DealName | String | DealName. | |
| DealId | Integer | dealid. | |
| Description | String | Description. | |
| FileName | String | FileName. | |
| FileSize | Integer | FileSize. | |
| FileType | String | FileType. | |
| InlineFlag | Boolean | InlineFlag. | |
| LogId | String | LogId. | |
| MailMessageId | String | MailMessageId. | |
| MailTemplateId | String | MailTemplateId. | |
| Name | String | Name. | |
| OrgId | Integer | OrgId. | |
| OrgName | String | OrgName. | |
| PeopleName | String | PeopleName. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| ProductId | String | ProductId. | |
| ProductName | String | ProductName. | |
| RemoteId | String | RemoteId. | |
| RemoteLocation | String | RemoteLocation. | |
| S3Bucket | String | S3Bucket. | |
| UpdateTime | Datetime | UpdateTime. | |
| Url | String | Url. | |
| UserId | Integer | UserId. | |
| LeadId | Integer | Lead Id. | |
| LeadName | Integer | Lead Name. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | Item specific updates.
The allowed values are Activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get Details of Deals Activities Attendees.
| Name | Type | References | Description |
| DealId | Integer | Deal Id. | |
| EmailAddress | String | EmailAddress. | |
| IsOrganizer | Integer | IsOrganizer. | |
| Name | String | Name. | |
| Status | String | Status. | |
| UserId | String |
Users.Id | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | Item specific updates.
The allowed values are Activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get details of Deal updates Bcc.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsUpdatesBcc WHERE DealId = 3
SELECT * FROM DealsUpdatesBcc WHERE DealId = 246 AND AllChanges = 1
SELECT * FROM DealsUpdatesBcc WHERE DealId = 246 AND Items IN ('activity', 'call')
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| DealId | Integer | Deal Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | item specific updates.
The allowed values are Activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get details of Deals Updates cc.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsUpdatesCc WHERE DealId = 3
SELECT * FROM DealsUpdatesCc WHERE DealId = 246 AND AllChanges = 1
SELECT * FROM DealsUpdatesCc WHERE DealId = 246 AND Items IN ('activity', 'call')
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| PersonId | String | PersonId. | |
| DealId | Integer | Deal Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | item specific updates.
The allowed values are Activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get details of Deals Updates From.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsUpdatesFrom WHERE DealId = 3
SELECT * FROM DealsUpdatesFrom WHERE DealId = 246 AND AllChanges = 1
SELECT * FROM DealsUpdatesFrom WHERE DealId = 246 AND Items IN ('activity', 'call')
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| DealId | Integer | Deal Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not
The allowed values are 1. | |
| Items | String | item specific updates
The allowed values are Activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get details of deals updates participants.
| Name | Type | References | Description |
| PersonId [KEY] | Integer | PersonId. | |
| DealId | Integer | Deal Id. | |
| PrimaryFlag | Boolean | PrimaryFlag. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | Item specific updates.
The allowed values are Activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get details of Deals Updates to.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsUpdatesTo WHERE DealId = 3
SELECT * FROM DealsUpdatesTo WHERE DealId = 246 AND AllChanges = 1
SELECT * FROM DealsUpdatesTo WHERE DealId = 246 AND Items IN ('activity', 'call')
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| DealId | Integer | Deal Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | item specific updates.
The allowed values are Activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Returns all supported filter helpers.
| Name | Type | References | Description |
| AdminAreaLevel1 | String | AdminAreaLevel1. | |
| AdminAreaLevel2 | String | AdminAreaLevel2. | |
| Country | String | Country. | |
| FormattedAddress | String | FormattedAddress. | |
| Locality | String | Locality. | |
| PostalCode | String | PostalCode. | |
| Route | String | Route. | |
| StreetNumber | String | StreetNumber. | |
| Sublocality | String | Sublocality. | |
| Subpremise | String | Subpremise. | |
| CurrencyNotEqual | String | CurrencyNotEqual. | |
| CurrencyEqual | String | CurrencyEqual. | |
| DateNotEqual | String | DateNotEqual. | |
| DateLessThan | String | DateLessThan. | |
| DateLessThanOrEqual | String | DateLessThanOrEqual. | |
| DateEqual | String | DateEqual. | |
| DateGreaterThan | String | DateGreaterThan. | |
| DateGreaterThanOrEqual | String | DateGreaterThanOrEqual. | |
| DateISNOTNULL | String | DateISNOTNULL. | |
| DateISNULL | String | DateISNULL. | |
| DateRangeNotEqual | String | DateRangeNotEqual. | |
| DateRangeLessThan | String | DateRangeLessThan. | |
| DateRangeLessThanOrEqual | String | DateRangeLessThanOrEqual. | |
| DateRangeEqual | String | DateRangeEqual. | |
| DateRangeGreaterThan | String | DateRangeGreaterThan. | |
| DateRangeGreaterThanOrEqual | String | DateRangeGreaterThanOrEqual. | |
| DateRangeDoesNotEndAt | String | DateRangeDoesNotEndAt. | |
| DateRangeEndsAfter | String | DateRangeEndsAfter. | |
| DateRangeEndsAt | String | DateRangeEndsAt. | |
| DateRangeEndsBefore | String | DateRangeEndsBefore. | |
| DateRangeEndsEAfter | String | DateRangeEndsEAfter. | |
| DateRangeEndsEBefore | String | DateRangeEndsEBefore. | |
| DateRangeincludes | String | DateRangeincludes. | |
| DateRangeISNOTNULL | String | DateRangeISNOTNULL. | |
| DateRangeISNULL | String | DateRangeISNULL. | |
| DealNotEqual | String | DealNotEqual. | |
| DealEqual | String | DealEqual. | |
| DealISNOTNULL | String | DealISNOTNULL. | |
| DealISNULL | String | DealISNULL. | |
| DoubleNotEqual | String | DoubleNotEqual. | |
| DoubleLessThan | String | DoubleLessThan. | |
| DoubleLessThanOrEqual | String | DoubleLessThanOrEqual. | |
| DoubleEqual | String | DoubleEqual. | |
| DoubleGreaterThan | String | DoubleGreaterThan. | |
| DoubleGreaterThanOrEqual | String | DoubleGreaterThanOrEqual. | |
| DoubleISNOTNULL | String | DoubleISNOTNULL. | |
| DoubleISNULL | String | DoubleISNULL. | |
| EnteredStageNotEqual | String | EnteredStageNotEqual. | |
| EnteredStageLessThan | String | EnteredStageLessThan. | |
| EnteredStageLessThanOrEqual | String | EnteredStageLessThanOrEqual. | |
| EnteredStageEqual | String | EnteredStageEqual. | |
| EnteredStageGreaterThan | String | EnteredStageGreaterThan. | |
| EnteredStageGreaterThanOrEqual | String | EnteredStageGreaterThanOrEqual. | |
| EnumNotEqual | String | EnumNotEqual. | |
| EnumEqual | String | EnumEqual. | |
| EnumISNOTNULL | String | EnumISNOTNULL. | |
| EnumISNULL | String | EnumISNULL. | |
| IntNotEqual | String | IntNotEqual. | |
| IntLessThan | String | IntLessThan. | |
| IntLessThanOrEqual | String | IntLessThanOrEqual. | |
| IntEqual | String | IntEqual. | |
| IntGreaterThan | String | IntGreaterThan. | |
| IntGreaterThanOrEqual | String | IntGreaterThanOrEqual. | |
| IntISNOTNULL | String | IntISNOTNULL. | |
| IntISNULL | String | IntISNULL. | |
| MonetaryNotEqual | String | MonetaryNotEqual. | |
| MonetaryLessThan | String | MonetaryLessThan. | |
| MonetaryLessThanOrEqual | String | MonetaryLessThanOrEqual. | |
| MonetaryEqual | String | MonetaryEqual. | |
| MonetaryGreaterThan | String | MonetaryGreaterThan. | |
| MonetaryGreaterThanOrEqual | String | MonetaryGreaterThanOrEqual. | |
| MonetaryISNOTNULL | String | MonetaryISNOTNULL. | |
| MonetaryISNULL | String | MonetaryISNULL. | |
| OrganizationNotEqual | String | OrganizationNotEqual. | |
| OrganizationEqual | String | OrganizationEqual. | |
| OrganizationISNOTNULL | String | OrganizationISNOTNULL. | |
| OrganizationISNULL | String | OrganizationISNULL. | |
| PersonNotEqual | String | PersonNotEqual. | |
| PersonEqual | String | PersonEqual. | |
| PersonISNOTNULL | String | PersonISNOTNULL. | |
| PersonISNULL | String | PersonISNULL. | |
| PipelineNotEqual | String | PipelineNotEqual. | |
| PipelineEqual | String | PipelineEqual. | |
| ProductNotEqual | String | ProductNotEqual. | |
| ProductEqual | String | ProductEqual. | |
| ProductISNOTNULL | String | ProductISNOTNULL. | |
| ProductISNULL | String | ProductISNULL. | |
| SetNotEqual | String | SetNotEqual. | |
| SetEqual | String | SetEqual. | |
| SetContains | String | SetContains. | |
| SetISNOTNULL | String | SetISNOTNULL. | |
| SetISNULL | String | SetISNULL. | |
| SetNotContains | String | SetNotContains. | |
| StageNotEqual | String | StageNotEqual. | |
| StageEqual | String | StageEqual. | |
| StageHasBeen | String | StageHasBeen. | |
| StatusNotEqual | String | StatusNotEqual. | |
| StatusEqual | String | StatusEqual. | |
| TimeNotEqual | String | TimeNotEqual. | |
| TimeLessThan | String | TimeLessThan. | |
| TimeLessThanOrEqual | String | TimeLessThanOrEqual. | |
| TimeEqual | String | TimeEqual. | |
| TimeGreaterThan | String | TimeGreaterThan. | |
| TimeGreaterThanOrEqual | String | TimeGreaterThanOrEqual. | |
| TimeISNOTNULL | String | TimeISNOTNULL. | |
| TimeISNULL | String | TimeISNULL. | |
| TimerangeNotEqual | String | TimerangeNotEqual. | |
| TimerangeLessThan | String | TimerangeLessThan. | |
| TimerangeLessThanOrEqual | String | TimerangeLessThanOrEqual. | |
| TimerangeEqual | String | TimerangeEqual. | |
| TimerangeGreaterThan | String | TimerangeGreaterThan. | |
| TimerangeGreaterThanOrEqual | String | TimerangeGreaterThanOrEqual. | |
| TimerangedoesNotEndAt | String | TimerangeDoes_not_end_at. | |
| TimerangeEndsAfter | String | TimerangeEndsAfter. | |
| TimerangeEndsAt | String | TimerangeEndsAt. | |
| TimerangeEndsBefore | String | TimerangeEndsBefore. | |
| TimerangeEndsEAfter | String | TimerangeEndsEAfter. | |
| TimerangeEndsEBefore | String | TimerangeEndsEBefore. | |
| TimerangeIncludes | String | TimerangeIncludes. | |
| TimerangeISNOTNULL | String | TimerangeISNOTNULL. | |
| TimerangeISNULL | String | TimerangeISNULL. | |
| TitleEqual | String | TitleEqual. | |
| TitleLIKE'$%' | String | TitleLIKE'$%'. | |
| TitleLIKE'%$' | String | TitleLIKE'%$'. | |
| TitleLIKE'%$%' | String | TitleLIKE'%$%'. | |
| TitleNOTLIKE'$%' | String | TitleNOTLIKE'$%'. | |
| TitleNOTLIKE'%$' | String | TitleNOTLIKE'%$'. | |
| TitleNOTLIKE'%$%' | String | TitleNOTLIKE'%$%'. | |
| UserNotEqual | String | UserNotEqual. | |
| UserEqual | String | UserEqual. | |
| UserBelongsToTeam | String | User.belongs_to_team. | |
| UserISNOTNULL | String | User.IS_NOT_NULL. | |
| UserISNULL | String | User.IS_NULL. | |
| VarcharNotEqual | String | VarcharNotEqual. | |
| VarcharEqual | String | VarcharEqual. | |
| VarcharISNOTNULL | String | VarcharISNOTNULL. | |
| VarcharISNULL | String | VarcharISNULL. | |
| VarcharLIKE'$%' | String | VarcharLIKE'$%' | |
| VarcharLIKE'%$' | String | VarcharLIKE'%$' | |
| VarcharLIKE'%$%' | String | VarcharLIKE'%$%' | |
| VarcharNOTLIKE'$%' | String | VarcharNOTLIKE'$%' | |
| VarcharNOTLIKE'%$' | String | VarcharNOTLIKE'%$' | |
| VarcharNOTLIKE'%$%' | String | VarcharNOTLIKE'%$%' | |
| VisibletoNotEqual | String | VisibletoNotEqual. | |
| VisibletoEqual | String | VisibletoEqual. | |
| RottenTime | String | RottenTime. | |
| LastMonth | String | LastMonth. | |
| LastQuarter | String | LastQuarter. | |
| LastWeek | String | LastWeek. | |
| NextMonth | String | NextMonth. | |
| NextWeek | String | NextWeek. | |
| ThisMonth | String | ThisMonth. | |
| ThisQuarter | String | ThisQuarter. | |
| ThisWeek | String | ThisWeek. | |
| OnemonthsAgo | String | OnemonthsAgo. | |
| OneweekAgo | String | OneweekAgo. | |
| TwoMonthsAgo | String | TwoMonthsAgo. | |
| TwoWeeksAgo | String | TwoWeeksAgo. | |
| ThreeMonthsAgo | String | ThreeMonthsAgo. | |
| ThreeWeeksAgo | String | ThreeWeeksAgo. | |
| FourMonthsAgo | String | FourMonthsAgo. | |
| FiveMonthsAgo | String | FiveMonthsAgo. | |
| SixMonthsAgo | String | SixMonthsAgo. | |
| BeforeToday | String | BeforeToday. | |
| BeforeTomorrow | String | BeforeTomorrow. | |
| InOneMonth | String | InOneMonth. | |
| InOneWeek | String | InOneWeek. | |
| InTwoMonths | String | InTwoMonths. | |
| InTwoWeeks | String | InTwoWeeks. | |
| InThreeMonths | String | InThreeMonths. | |
| InThreeWeeks | String | InThreeWeeks. | |
| InFourMonths | String | InFourMonths. | |
| InFiveMonths | String | InFiveMonths. | |
| InSixMonths | String | InSixMonths. | |
| LaterOrToday | String | LaterOrToday. | |
| LaterOrTomorrow | String | LaterOrTomorrow. | |
| Now | String | Now. | |
| Today | String | Today. | |
| Tomorrow | String | Tomorrow. | |
| Yesterday | String | Yesterday. |
Finds users by their name.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM FindUsersByName WHERE Term = 'name'
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the user. | |
| Activated | Boolean | Activated. | |
| ActiveFlag | Boolean | Whether the user is active or not.
The default value is true. | |
| Created | Datetime | Created. | |
| DefaultCurrency | String | DefaultCurrency. | |
| String | Email of the user. | ||
| Hascreatedcompany | Boolean | Hascreatedcompany. | |
| IconUrl | String | IconUrl. | |
| IsAdmin | Integer | IsAdmin. | |
| IsYou | Boolean | IsYou. | |
| Lang | Integer | Lang. | |
| LastLogin | Datetime | LastLogin. | |
| Locale | String | Locale. | |
| Modified | Datetime | Modified. | |
| Name | String | Name of the user. | |
| Phone | String | Phone. | |
| RoleId | Integer | ID of the role. | |
| TimezoneName | String | TimezoneName. | |
| TimezoneOffset | String | TimezoneOffset. | |
| Access | String | The access given to the user. | |
| Term | String | The search term to look for. | |
| SearchByEmail | Integer | When enabled, the term will only be matched against email addresses of users.
The default value is false. |
Get all permitted users for leads in a single company
The Sync App will use the Pipedrive The filter is executed client side within the Sync App.
SELECT * FROM LeadPermittedUsers
| Name | Type | References | Description |
| PermittedUsersAggregate | String | A list of permitted users for a lead. | |
| LeadId | String |
Leads.Id | The ID of the Lead. |
Returns all Lead Sources.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM LeadSources
| Name | Type | References | Description |
| Name | String | Name. |
Returns data about a specific mail message.
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the Mail Threads. | |
| PartiesTo | String | To. | |
| PartiesFrom | String | From. | |
| DraftParties | String | Draft Parties. | |
| Folders | String | Folders. | |
| AccountId | String | Account Id. | |
| UserId | Integer | User Id. | |
| Version | Integer | Version. | |
| Subject | String | Subject. | |
| Snippet | String | Snippet. | |
| SnippetDraft | String | SnippetDraft. | |
| SnippetSent | String | SnippetSent. | |
| HasAttachmentsFlag | Integer | HasAttachmentsFlag. | |
| HasInlineAttachmentsFlag | Integer | HasInlineAttachmentsFlag. | |
| HasRealAttachmentsFlag | Integer | HasRealAttachmentsFlag. | |
| HasDraftFlag | Integer | HasDraftFlag. | |
| HasSentFlag | Integer | HasSentFlag. | |
| ArchivedFlag | Integer | ArchivedFlag. | |
| DeletedFlag | Integer | DeletedFlag. | |
| SyncedFlag | Integer | SyncedFlag. | |
| ExternalDeletedFlag | Integer | ExternalDeletedFlag. | |
| SmartBccFlag | Integer | SmartBccFlag. | |
| FirstMessageToMeFlag | Integer | FirstMessageToMeFlag. | |
| MailLinkTrackingEnabledFlag | Integer | MailLinkTrackingEnabledFlag. | |
| LastMessageTimestamp | String | LastMessageTimestamp. | |
| FirstMessageTimestamp | String | FirstMessageTimestamp. | |
| LastMessageSentTimestamp | String | LastMessageSentTimestamp. | |
| LastMessageReceivedTimestamp | String | LastMessageReceivedTimestamp. | |
| AddTime | String | AddTime. | |
| UpdateTime | String | UpdateTime. | |
| DealId | Integer | DealId. | |
| DealStatus | Integer | DealStatus. | |
| AllMessagesSentFlag | Integer | AllMessagesSentFlag. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Folder | String | The type of folder to fetch. |
Returns all the mail messages inside a specified mail thread..
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM MailThreadMessages WHERE MailThreadId = 145
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the Mail Thread Messages. | |
| MailThreadId | Integer | ID of the Mail Thread. | |
| To | String | To. | |
| From | String | From. | |
| Cc | String | Cc. | |
| Bcc | String | Bcc. | |
| BodyUrl | String | Body url. | |
| AccountId | String | Account Id. | |
| UserId | Integer | User Id. | |
| Subject | String | Subject. | |
| Snippet | String | Snippet. | |
| MailTrackingStatus | String | Mail Tracking status. | |
| MailLinkTrackingEnabledFlag | Integer | MailLinkTrackingEnabledFlag. | |
| ReadFlag | Integer | Readflag. | |
| Draft | String | Draft. | |
| DraftFlag | Integer | Draft flag. | |
| SyncedFlag | Integer | Synced flag. | |
| DeletedFlag | Integer | Deleted flag. | |
| HasBodyFlag | Integer | Has body flag. | |
| SentFlag | Integer | Sent flag. | |
| SentFromPipeDriveFlag | Integer | SentFromPipeDriveFlag. | |
| SmartBccFlag | Integer | SmartBccFlag. | |
| MessageTime | String | MessageTime. | |
| AddTime | String | AddTime. | |
| UpdateTime | String | UpdateTime. | |
| HasAttachmentsFlag | Integer | HasAttachmentsFlag. | |
| HasInlineAttachmentsFlag | Integer | HasInlineAttachmentsFlag. | |
| HasRealAttachmentsFlag | Integer | HasRealAttachmentsFlag. |
Returns all the mail messages inside a specified mail thread.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM MailThreadMessagesFrom WHERE MailThreadId = 2
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the Mail Thread Messages. | |
| MailThreadId | Integer | ID of the Mail Thread. | |
| EmailAddress | String | Email address. | |
| Name | String | Name. | |
| LinkedPersonId | Integer | Linked Person Id. | |
| LinkedPersonName | String | Linked Person Name. | |
| MailMessagePartyId | Integer | Mail message Party Id. |
Returns all the mail messages inside a specified mail thread.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM MailThreadMessagesTo WHERE MailThreadId = 2
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the Mail Thread Messages. | |
| MailThreadId | Integer | ID of the Mail Thread. | |
| EmailAddress | String | Email address. | |
| Name | String | Name. | |
| LinkedPersonId | Integer | Linked Person Id. | |
| LinkedPersonName | String | Linked Person Name. | |
| MailMessagePartyId | Integer | Mail message Party Id. |
Get details of the user who sent the mail.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM MailThreadsFrom WHERE Folder = 'inbox'
| Name | Type | References | Description |
| Id [KEY] | Integer | ID. | |
| Name | String | Name. | |
| LatestSent | Boolean | LatestSent. | |
| EmailAddress | String | EmailAddress. | |
| MessageTime | String | MessageTime. | |
| LinkedPersonId | Integer | LinkedPersonId. | |
| LinkedPersonName | String | LinkedPersonName. | |
| LinkedOrganizationId | String | LinkedOrganizationId. | |
| MailMessagePartyId | Integer | MailMessagePartyId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Folder | String | The type of folder to fetch. |
Get details of the user to whom sent the mail.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM MailThreadsTo WHERE Folder = 'inbox'
| Name | Type | References | Description |
| Id [KEY] | Integer | ID. | |
| Name | String | Name. | |
| LatestSent | Boolean | LatestSent. | |
| EmailAddress | String | EmailAddress. | |
| MessageTime | String | MessageTime. | |
| LinkedPersonId | Integer | LinkedPersonId. | |
| LinkedPersonName | String | LinkedPersonName. | |
| LinkedOrganizationId | String | LinkedOrganizationId. | |
| MailMessagePartyId | Integer | MailMessagePartyId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Folder | String | The type of folder to fetch. |
Returns data about all note fields.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM NoteFields
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| ActiveFlag | Boolean | ActiveFlag. | |
| BulkEditAllowed | Boolean | BulkEditAllowed. | |
| EditFlag | Boolean | EditFlag. | |
| FieldType | String | FieldType. | |
| Key | String | Key. | |
| MandatoryFlag | Boolean | MandatoryFlag. | |
| Name | String | Name. | |
| Options | String | Options. |
Returns data about all note fields options.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM NoteFieldsOptions
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| Label | String | Label. |
Returns data about all organization fields options.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationFieldsOptions
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the field. | |
| Label | String | Label. |
Get details of organizations activities.
Note: DEPRECATED. To be removed in v26. Use Activities with OrgId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsActivities WHERE Id = 246
SELECT * FROM OrganizationsActivities WHERE Id = 246 AND done = 0
SELECT * FROM OrganizationsActivities WHERE Id = 246 AND Exclude IN ('240', '241')
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| ActiveFlag | Boolean | ActiveFlag. | |
| AddTime | Datetime | AddTime. | |
| AssignedTouserId | Integer | AssignedTouserId. | |
| Attendees | String | Attendees. | |
| BusyFlag | Boolean | BusyFlag. | |
| IncludeContext | String | IncludeContext. | |
| CompanyId | Integer | CompanyId. | |
| MeetingClient | String | MeetingClient. | |
| MeetingId | String | MeetingId. | |
| MeetingUrl | String | MeetingUrl. | |
| CreatedByUserId | Integer | CreatedByUserId. | |
| DealDropboxBcc | String | DealDropboxBcc. | |
| DealId | Integer | DealId. | |
| DealTitle | String | DealTitle. | |
| Done | Boolean | Done. | |
| DueDate | Date | DueDate. | |
| DueTime | Time | DueTime. | |
| Duration | Time | Duration. | |
| FileCleanName | String | FileCleanName. | |
| FileId | String | FileId. | |
| FileUrl | String | FileUrl. | |
| GcaleventId | String | GcaleventId. | |
| GoogleCalendarEtag | String | GoogleCalendarEtag. | |
| GoogleCalendarId | String | GoogleCalendarId. | |
| LastNotificationTime | Datetime | LastNotificationTime. | |
| LastNotificationUserId | Integer | LastNotificationUserId. | |
| LeadId | String | LeadId. | |
| Location | String | Location. | |
| AdminAreaLevel1 | String | AdminAreaLevel1. | |
| AdminAreaLevel2 | String | AdminAreaLevel2. | |
| Country | String | Country. | |
| FormattedAddress | String | FormattedAddress. | |
| Lat | Double | Lat. | |
| Locality | String | Locality. | |
| Long | Double | Long. | |
| PostalCode | String | PostalCode. | |
| Route | String | Route. | |
| StreetNumber | String | StreetNumber. | |
| Sublocality | String | Sublocality. | |
| Subpremise | String | Subpremise. | |
| MarkedAsDoneTime | Datetime | MarkedAsDoneTime. | |
| Note | String | Note. | |
| NotificationLanguageId | Integer | NotificationLanguageId. | |
| OrgId | Integer | OrgId. | |
| OrgName | String | OrgName. | |
| OwnerName | String | OwnerName. | |
| Participants | String | Participants. | |
| PersonDropboxBcc | String | PersonDropboxBcc. | |
| PersonId | Integer | PersonId. | |
| PersonName | String | PersonName. | |
| PublicDescription | String | PublicDescription. | |
| MasterActivityId | String | MasterActivityId. | |
| Rule | String | Rule. | |
| RuleExtension | String | RuleExtension. | |
| ReferenceId | Integer | ReferenceId. | |
| ReferenceType | String | ReferenceType. | |
| Series | String | Series. | |
| SourceTimezone | String | SourceTimezone. | |
| Subject | String | Subject. | |
| Type | String | Type. | |
| UpdateTime | Datetime | UpdateTime. | |
| UpdateUserId | Integer | UpdateUserId. | |
| UserId | Integer | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Exclude | String | A comma-separated string of activity IDs to exclude from result. |
Get details of organizations activities attendees.
Note: DEPRECATED. To be removed in v26. Use ActivitiesAttendees with OrgId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsActivitiesAttendees SELECT * FROM OrganizationsActivitiesAttendees WHERE OrgId = 2
| Name | Type | References | Description |
| OrgId | Integer | OrgId. | |
| EmailAddress | String | Email Address. | |
| IsOrganizer | Integer | IsOrganizer. | |
| Name | String | Name. | |
| PersonId | Integer | PersonId. | |
| Status | String | Status. | |
| UserId | String | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Exclude | String | A comma-separated string of activity IDs to exclude from result. |
Get details of organizations activities participants.
Note: DEPRECATED. To be removed in v26. Use ActivitiesParticipants with OrgId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsActivitiesParticipants SELECT * FROM OrganizationsActivitiesParticipants WHERE OrgId = 2
| Name | Type | References | Description |
| OrgId | Integer | OrgId. | |
| PersonId | Integer | PersonId. | |
| PrimaryFlag | Boolean | Primary Flag. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Exclude | String | A comma-separated string of activity IDs to exclude from result. |
Get details of organization deals.
Note: DEPRECATED. To be removed in v26. Use Deals with OrgId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsDeals WHERE Id = 246 SELECT * FROM OrganizationsDeals WHERE Id = 246 AND Status = 'open' SELECT * FROM OrganizationsDeals WHERE Id = 246 AND OnlyPrimaryAssociation = 1
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| Active | Boolean | Active. | |
| ActivitiesCount | Integer | ActivitiesCount. | |
| AddTime | Datetime | AddTime. | |
| CcEmail | String | CcEmail. | |
| CloseTime | String | CloseTime. | |
| CreatoractiveFlag | Boolean | CreatoractiveFlag. | |
| Creatoremail | String | Creatoremail. | |
| CreatorhasPic | Boolean | CreatorhasPic. | |
| Creatorid | Integer | Creatorid. | |
| Creatorname | String | Creatorname. | |
| CreatorPicHash | String | CreatorPicHash. | |
| Creatorvalue | Integer | Creatorvalue. | |
| Currency | String | Currency. | |
| Deleted | Boolean | Deleted. | |
| DoneActivitiesCount | Integer | DoneActivitiesCount. | |
| EmailMessagesCount | Integer | EmailMessagesCount. | |
| ExpectedCloseDate | Date | ExpectedCloseDate. | |
| FilesCount | Integer | FilesCount. | |
| FirstWonTime | Datetime | FirstWonTime. | |
| FollowersCount | Integer | FollowersCount. | |
| FormattedValue | String | FormattedValue. | |
| FormattedWeightedValue | String | FormattedWeightedValue. | |
| Label | String | Label. | |
| LastActivityDate | String | LastActivityDate. | |
| LastActivityId | String | LastActivityId. | |
| LastIncomingMailTime | Datetime | LastIncomingMailTime. | |
| LastOutgoingMailTime | Datetime | LastOutgoingMailTime. | |
| LostReason | String | LostReason. | |
| LostTime | String | LostTime. | |
| NextActivityDate | Date | NextActivityDate. | |
| NextActivityDuration | Time | NextActivityDuration. | |
| NextActivityId | Integer | NextActivityId. | |
| NextActivitynote | String | NextActivitynote. | |
| NextActivitysubject | String | NextActivitysubject. | |
| NextActivitytime | Time | NextActivitytime. | |
| NextActivitytype | String | NextActivitytype. | |
| NotesCount | Integer | NotesCount. | |
| OrgHidden | Boolean | OrgHidden. | |
| OrgActive_flag | Boolean | OrgActive_flag. | |
| OrgAddress | String | OrgAddress. | |
| OrgCcEmail | String | OrgCcEmail. | |
| OrgIdName | String | OrgName. | |
| OrgOwnerId | Integer | OrgOwnerId. | |
| OrgPeopleCount | Integer | OrgPeopleCount. | |
| OrgId | Integer | OrgValue. | |
| OwnerName | String | OwnerName. | |
| ParticipantsCount | Integer | ParticipantsCount. | |
| PersonHidden | Boolean | PersonHidden. | |
| PersonActiveFlag | Boolean | PersonActiveFlag. | |
| PersonEmail | String | PersonEmail. | |
| PersonName | String | PersonName. | |
| PersonPhone | String | PersonPhone. | |
| PersonValue | Integer | PersonValue. | |
| PipelineId | Integer | PipelineId. | |
| Probability | String | Probability. | |
| ProductsCount | Integer | ProductsCount. | |
| RottenTime | String | RottenTime. | |
| StageChangeTime | Datetime | StageChangeTime. | |
| StageId | Integer | StageId. | |
| StageOrderNr | Integer | StageOrderNr. | |
| Status | String | Only fetch deals with specific status..
The allowed values are open, won, lost, deleted, all_not_deleted. | |
| Title | String | Title. | |
| UndoneActivitiesCount | Integer | UndoneActivitiesCount. | |
| UpdateTime | Datetime | UpdateTime. | |
| UserActiveFlag | Boolean | UserActiveFlag. | |
| UserEmail | String | UserEmail. | |
| UserHasPic | Boolean | UserHasPic. | |
| UserId | Integer | UserId. | |
| UserName | String | UserName. | |
| UserPicHash | String | UserPicHash. | |
| UserValue | Integer | UserValue. | |
| Value | Integer | Value. | |
| VisibleTo | String | VisibleTo. | |
| WeightedValue | Integer | WeightedValue. | |
| WeightedValueCurrency | String | WeightedValueCurrency. | |
| WonTime | Datetime | WonTime. | |
| OrgName | String | Org Name. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| OnlyPrimaryAssociation | Integer | If set, only deals that are directly associated to the organization are fetched.
The allowed values are 0, 1. |
get details of deals person email.
Note: DEPRECATED. To be removed in v26.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsDealsPersonEmail WHERE OrgId = 246 SELECT * FROM OrganizationsDealsPersonEmail WHERE OrgId = 246 AND Status = 'open' SELECT * FROM OrganizationsDealsPersonEmail WHERE OrgId = 246 AND OnlyPrimaryAssociation = 1
| Name | Type | References | Description |
| OrgId [KEY] | Integer | Org Id. | |
| Label | String | Label. | |
| Primary | Boolean | Primary. | |
| Value | String | Value. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Status | String | Only fetch deals with specific status.
The allowed values are open, won, lost, deleted, all_not_deleted. The default value is all_not_deleted. | |
| OnlyPrimaryAssociation | Integer | If set, only deals that are directly associated to the organization are fetched.
The allowed values are 0, 1. |
get details of deals person phone.
Note: DEPRECATED. To be removed in v26.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsDealsPersonphone WHERE OrgId = 246 SELECT * FROM OrganizationsDealsPersonphone WHERE OrgId = 246 AND Status = open SELECT * FROM OrganizationsDealsPersonphone WHERE OrgId = 246 AND OnlyPrimaryAssociation = 1
| Name | Type | References | Description |
| OrgId [KEY] | Integer | Org Id. | |
| Label | String | Label. | |
| Primary | Boolean | Primary. | |
| Value | String | Value. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Status | String | Only fetch deals with specific status.
The allowed values are open, won, lost, deleted, all_not_deleted. The default value is all_not_deleted. | |
| OnlyPrimaryAssociation | Integer | If set, only deals that are directly associated to the organization are fetched
The allowed values are 0, 1. |
Get details of deals file.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsFiles WHERE OrgId = 6
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the organizations. | |
| ActiveFlag | Boolean | Active Flag. | |
| ActivityId | String | Activity Id. | |
| AddTime | Datetime | AddTime. | |
| Cid | String | Cid. | |
| DealId | String | Deal Id. | |
| DealName | String | DealName. | |
| Description | String | Description. | |
| FileName | String | File Name. | |
| FileSize | Integer | File Size. | |
| FileType | String | File Type. | |
| InlineFlag | Boolean | Inline Flag. | |
| LogId | String | Log Id. | |
| MailMessageId | String | MailMessage Id. | |
| MailTemplateId | String | MailTemplate Id. | |
| Name | String | Name. | |
| OrgId | Integer | Org Id. | |
| OrgName | String | Org Name. | |
| PeopleName | String | People Name. | |
| PersonId | String | PersonId. | |
| PersonName | String | Person Name. | |
| ProductId | String | Produc tId. | |
| ProductName | String | Product Name. | |
| RemoteId | String | Remote Id. | |
| RemoteLocation | String | Remote Location. | |
| S3Bucket | String | S3Bucket. | |
| UpdateTime | Datetime | Update Time. | |
| Url | String | Url. | |
| UserId | Integer | UserId. | |
| LeadId | String | LeadId. | |
| LeadName | String | LeadName. |
Get details of organizations mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsMailMessages WHERE OrgId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Org id. | |
| OrgId | Integer | Activities ID. | |
| AccountId | String | AccountId. | |
| AddTime | Datetime | addTime. | |
| Bcc | String | Bcc. | |
| BodyUrl | String | bodyUrl. | |
| Cc | String | cc. | |
| CompanyId | Integer | companyId. | |
| DeletedFlag | Boolean | DeletedFlag. | |
| Draft | String | Draft. | |
| DraftFlag | Boolean | DraftFlag. | |
| ExternalDeletedFlag | Boolean | External DeletedFlag. | |
| From | String | From. | |
| AttachmentsFlag | Boolean | AttachmentsFlag. | |
| BodyFlag | Boolean | BodyFlag. | |
| InlineAttachmentsFlag | Boolean | InlineAttachmentsFlag. | |
| RealAttachmentsFlag | Boolean | RealAttachmentsFlag. | |
| ItemType | String | ItemType. | |
| TrackingEnabledFlag | Boolean | TrackingEnabledFlag. | |
| ThreadId | Integer | ThreadId. | |
| TrackingStatus | String | TrackingStatus. | |
| MessageTime | String | MessageTime. | |
| MessageId | String | MessageId. | |
| NylasId | String | NylasId. | |
| ReadFlag | Boolean | ReadFlag. | |
| S3Bucket | String | S3Bucket. | |
| S3BucketPath | String | S3BucketPath. | |
| SentFlag | Boolean | SentFlag. | |
| SentFromPipedriveFlag | Boolean | SentFromPipedriveFlag. | |
| SmartBccFlag | Boolean | SmartBccFlag. | |
| Snippet | String | Snippet. | |
| Subject | String | Subject. | |
| SyncedFlag | Boolean | SyncedFlag. | |
| TemplateId | String | TemplateId. | |
| Timestamp | Datetime | Timestamp. | |
| To | String | To. | |
| UpdateTime | Datetime | UpdateTime. | |
| UserId | Integer | UserId. | |
| WriteFlag | Boolean | writeFlag. | |
| Object | String | Object. |
Get details of organizations mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsMailMessagesBcc WHERE OrgId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | id. | |
| OrgId | Integer | Org Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | Integer | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of organizations mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsMailMessagesCc WHERE OrgId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| OrgId | Integer | Org Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of organizations mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsMailMessagesFrom WHERE OrgId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| OrgId | Integer | Org Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of organizations mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsMailMessagesTo WHERE OrgId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| OrgId | Integer | Org Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of permitted users of organizations.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsPermittedUsers WHERE OrgId = 10
| Name | Type | References | Description |
| OrgId | Integer | Organization Id. | |
| UserId | Integer | User Id. |
Get details of organizations persons
Note: DEPRECATED. To be removed in v26. Use Persons with OrgId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsPersons WHERE OrgId = 10
| Name | Type | References | Description |
| Id [KEY] | Integer | Id | |
| ActivitiesCount | Integer | ActivitiesCount | |
| ActiveFlag | Boolean | ActiveFlag | |
| AddTime | Datetime | AddTime | |
| CcEmail | String | CcEmail | |
| ClosedDealsCount | Integer | ClosedDealsCount | |
| CompanyId | Integer | CompanyId | |
| DoneActivitiesCount | Integer | DoneActivitiesCount | |
| String | |||
| EmailMessagesCount | Integer | EmailMessagesCount | |
| FilesCount | Integer | FilesCount | |
| Label | Integer | label | |
| LastActivityDate | Date | LastActivityDate | |
| LastActivityId | Integer | LastActivityId | |
| LastincomingMailTime | String | LastincomingMailTime | |
| Lastname | String | Lastname | |
| LastoutgoingMailTime | String | LastoutgoingMailTime | |
| LostdealsCount | Integer | LostdealsCount | |
| Name | String | Name | |
| NextActivityDate | Date | nextActivityDate | |
| NextActivityId | Integer | nextActivityId | |
| NextActivityTime | String | nextActivityTime | |
| NotesCount | Integer | NotesCount | |
| OpenDealsCount | Integer | OpenDealsCount | |
| OrgActiveFlag | Boolean | OrgActiveFlag | |
| OrgAddress | String | OrgAddress | |
| OrgCcEmail | String | OrgCcEmail | |
| OrgIdName | String | OrgName | |
| OrgownerId | Integer | OrgownerId | |
| OrgpeopleCount | Integer | OrgpeopleCount | |
| OrgId | Integer | OrgId | |
| OwnerActiveFlag | Boolean | OwnerActiveFlag | |
| OwnerEmail | String | OwnerEmail | |
| OwnerHasPic | Boolean | OwnerHasPic | |
| OwnerId | Integer | OwnerId | |
| OwnerName | String | OwnerName | |
| OwnerPicHash | String | OwnerPicHash | |
| OwnerValue | Integer | OwnerValue | |
| ParticipantClosedDealsCount | Integer | ParticipantClosedDealsCount | |
| ParticipantOpenDealsCount | Integer | ParticipantOpenDealsCount | |
| Phone | String | Phone | |
| PictureActiveFlag | Boolean | PictureActiveFlag | |
| PictureaddTime | Datetime | PictureaddTime | |
| PictureaddedByUserId | Integer | PictureaddedByUserId | |
| PictureItemId | Integer | PictureItemId | |
| PictureitemType | String | PictureitemType | |
| Picture128 | String | Picture128 | |
| Picture512 | String | Picture512 | |
| PictureupdateTime | String | PictureupdateTime | |
| Picturevalue | Integer | Picturevalue | |
| PictureId | String | PictureId | |
| RelatedclosedDealsCount | Integer | RelatedclosedDealsCount | |
| RelatedlostDealsCount | Integer | RelatedlostDealsCount | |
| RelatedopenDealsCount | Integer | RelatedopenDealsCount | |
| RelatedwonDealsCount | Integer | RelatedwonDealsCount | |
| UndoneActivitiesCount | Integer | UndoneActivitiesCount | |
| UpdateTime | Datetime | UpdateTime | |
| VisibleTo | String | visibleTo | |
| WonDealsCount | Integer | WonDealsCount | |
| FirstName | String | First name. | |
| FollowersCount | Integer | Followes Count. | |
| PrimaryEmail | String | Primary Email. | |
| FirstChar | String | First Char. | |
| MarketingStatus | String | Marketing Status. | |
| OrgName | String | Org name. |
Get details of organizations persons email
Note: DEPRECATED. To be removed in v26. Use PersonsEmails with OrgId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsPersonsEmail WHERE OrgId = 10
| Name | Type | References | Description |
| OrgId [KEY] | Integer | OrgId | |
| Value | String | Value. | |
| Primary | Boolean | Primary. | |
| Label | String | Label. |
Get details of organizations persons phone
Note: DEPRECATED. To be removed in v26. Use PersonsPhone with OrgId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsPersonsPhone WHERE OrgId = 10
| Name | Type | References | Description |
| OrgId [KEY] | Integer | OrgId | |
| Value | String | Value. | |
| Primary | Boolean | Primary. | |
| Label | String | Label. |
Get details of organizations updates..
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsUpdates WHERE OrgId = 246
SELECT * FROM OrganizationsUpdates WHERE OrgId = 10 AND AllChanges = 1
SELECT * FROM OrganizationsUpdates WHERE OrgId = 10 AND Items IN ('activity', 'plannedActivity')
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| ActiveFlag | Boolean | ActiveFlag. | |
| ActivityId | String | ActivityId. | |
| AddTime | Datetime | AddTime. | |
| NewValueFormatted | String | NewValueFormatted. | |
| OldValueFormatted | String | OldValueFormatted. | |
| AssignedToUserId | Integer | AssignedToUserId. | |
| Attendees | String | Attendees. | |
| BusyFlag | Boolean | BusyFlag. | |
| IncludeContext | String | IncludeContext. | |
| ChangeSource | String | ChangeSource. | |
| User_agent | String | User_agent. | |
| Cid | String | Cid. | |
| CompanyId | Integer | CompanyId. | |
| ConferenceMeetingClient | String | ConferenceMeetingClient. | |
| ConferenceMeetingId | String | ConferenceMeetingId. | |
| ConferenceMeetingUrl | String | ConferenceMeetingUrl. | |
| CreatedByUserId | Integer | CreatedByUserId. | |
| DealDropboxBcc | String | DealDropboxBcc. | |
| DealId | Integer | DealId. | |
| DealName | String | DealName. | |
| DealTitle | String | DealTitle. | |
| Description | String | Description. | |
| Done | Boolean | Done. | |
| DueDate | Date | DueDate. | |
| DueTime | Time | DueTime. | |
| Duration | Time | Duration. | |
| FieldKey | String | FieldKey. | |
| FileCleanName | String | FileCleanName. | |
| FileId | String | FileId. | |
| FileUrl | String | FileUrl. | |
| FileName | String | FileName. | |
| FileSize | Integer | FileSize. | |
| FileType | String | FileType. | |
| GcalEventId | String | GcalEventId. | |
| GoogleCalendarEtag | String | GoogleCalendarEtag. | |
| GoogleCalendarId | String | GoogleCalendarId. | |
| InlineFlag | Boolean | InlineFlag. | |
| IsBulkUpdateFlag | String | IsBulkUpdateFlag. | |
| ItemId | Integer | ItemId. | |
| LastNotificationTime | Datetime | LastNotificationTime. | |
| LastNotificationUserId | Integer | LastNotificationUserId. | |
| LeadId | String | LeadId. | |
| Location | String | Location. | |
| AdminAreaLevel1 | String | AdminAreaLevel1. | |
| AdminAreaLevel2 | String | AdminAreaLevel2. | |
| Country | String | Country. | |
| FormattedAddress | String | FormattedAddress. | |
| Lat | Double | Lat. | |
| Locality | String | Locality. | |
| Long | Double | Long. | |
| PostalCode | String | PostalCode. | |
| Route | String | Route. | |
| StreetNumber | String | StreetNumber. | |
| Sublocality | String | Sublocality. | |
| Subpremise | String | Subpremise. | |
| LogId | String | LogId. | |
| LogTime | Datetime | LogTime. | |
| MessageId | String | MessageId. | |
| TemplateId | String | TemplateId. | |
| MarkedAsDoneTime | Datetime | MarkedAsDoneTime. | |
| Name | String | Name. | |
| NewValue | String | NewValue. | |
| Note | String | Note. | |
| NotificationLanguageId | Integer | NotificationLanguageId. | |
| OldValue | Integer | OldValue. | |
| OrgId | Integer | OrgId. | |
| OrgName | String | OrgName. | |
| OwnerName | String | OwnerName. | |
| Participants | String | Participants. | |
| PeopleName | String | PeopleName. | |
| PersonDropboxBcc | String | PersonDropboxBcc. | |
| PersonId | Integer | PersonId. | |
| PersonName | String | PersonName. | |
| ProductId | String | ProductId. | |
| ProductName | String | ProductName. | |
| PublicDescription | String | PublicDescription. | |
| RecActivityId | String | RecActivityId. | |
| RecRule | String | RecRule. | |
| RecRuleExtension | String | RecRuleExtension. | |
| ReferenceId | Integer | ReferenceId. | |
| ReferenceType | String | ReferenceType. | |
| RemoteId | String | RemoteId. | |
| RemoteLocation | String | RemoteLocation. | |
| S3Bucket | String | S3Bucket. | |
| Series | String | Series. | |
| Sourcetimezone | String | Sourcetimezone. | |
| Subject | String | Subject. | |
| Type | String | Type. | |
| UpdateTime | Datetime | UpdateTime. | |
| UpdateUserId | Integer | UpdateUserId. | |
| Url | String | Url. | |
| UserId | Integer | UserId. | |
| Object | String | Object. | |
| Timestamp | Datetime | Timestamp. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | item specific updates.
The allowed values are activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get details of all attendees of organizations.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsUpdatesAttendees WHERE OrgId = 246
SELECT * FROM OrganizationsUpdatesAttendees WHERE OrgId = 10 AND AllChanges = 1
SELECT * FROM OrganizationsUpdatesAttendees WHERE OrgId = 10 AND Items IN ('activity', 'plannedActivity')
| Name | Type | References | Description |
| OrgId [KEY] | Integer | Activities ID. | |
| EmailAddress | String | EmailAddress. | |
| IsOrganizer | Boolean | IsOrganizer. | |
| Name | String | Name. | |
| PersonId | Integer |
Persons.Id | PersonId. |
| Status | String | Status. | |
| UserId | String |
Users.Id | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | item specific updates.
The allowed values are activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Getdetails of activities participants.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM OrganizationsUpdatesParticipants WHERE OrgId = 246
SELECT * FROM OrganizationsUpdatesParticipants WHERE OrgId = 10 AND AllChanges = 1
SELECT * FROM OrganizationsUpdatesParticipants WHERE OrgId = 10 AND Items IN ('activity', 'plannedActivity')
| Name | Type | References | Description |
| OrgId [KEY] | Integer | Activities ID. | |
| PersonId | Integer | PersonId. | |
| PrimaryFlag | Boolean | PrimaryFlag. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | item specific updates.
The allowed values are activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get all permissions.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PermissionSets WHERE Id = 'a3d3f720-154f-11ec-905b-d96b2abf3c60'
| Name | Type | References | Description |
| Id [KEY] | String | ID of the permission set. | |
| AssignmentCount | Integer | AssignmentCount. | |
| Name | String | Name. | |
| Type | String | Type. | |
| Description | String | Description. | |
| App | String | App. |
.
| Name | Type | References | Description |
| Name | String | Name. | |
| PermissionSetId [KEY] | String | PermissionSetId. | |
| UserId [KEY] | Integer |
Users.Id | UserId. |
Returns data about all person fields options.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonFieldsOptions
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the field. | |
| Label | String | Label. |
Get all Persons Activities assigned to a particular Persons.
Note: DEPRECATED. To be removed in v26. Use Activities with PersonId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsActivities WHERE PersonId = 113
SELECT * FROM PersonsActivities WHERE PersonId = 113 AND Done = 0
SELECT * FROM PersonsActivities WHERE PersonId = 113 AND Exclude IN ('240', '241')
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| ActiveFlag | Boolean | Active Flag. | |
| AddTtime | Datetime | Add Ttime. | |
| AssignedToUserId | Integer | Assigned To UserId. | |
| Attendees | String | Attendees. | |
| BusyFlag | Boolean | BusyFlag. | |
| IncludeContext | String | Include Context. | |
| CompanyId | Integer | Company Id. | |
| MeetingClient | String | Meeting Client. | |
| MeetingId | String | Meeting Id. | |
| MeetingUrl | String | Meeting Url. | |
| CreatedByUserId | Integer | CreatedBy UserId. | |
| DealDropboxBcc | String | Deal Dropbox Bcc. | |
| DealId | Integer | Deal Id. | |
| DealTitle | String | Deal Title. | |
| Done | Boolean | Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
The allowed values are 0, 1. | |
| DueDate | Date | Due Date. | |
| DueTime | Time | Due Time. | |
| Duration | Time | Duration. | |
| FileCleanName | String | FileCleanName. | |
| FileId | String | FileId. | |
| FileUrl | String | FileUrl. | |
| EventId | String | eventId. | |
| CalendarEtag | String | CalendarEtag. | |
| CalendarId | String | Calendar Id. | |
| NotificationTime | Datetime | Notification Time. | |
| NotificationUserId | Integer | Notification UserId. | |
| LeadId | String | Lead Id. | |
| Location | String | Location. | |
| AreaLevel1 | String | AreaLevel1. | |
| AreaLevel2 | String | AreaLevel2. | |
| Country | String | Country. | |
| FormattedAddress | String | FormattedAddress. | |
| Lat | Double | Lat. | |
| Locality | String | Locality. | |
| Long | Double | Long. | |
| PostalCode | String | PostalCode. | |
| Route | String | Route. | |
| StreetNumber | String | StreetNumber. | |
| Sublocality | String | Sublocality. | |
| Subpremise | String | Subpremise. | |
| MarkedAsDoneTime | Datetime | MarkedAsDoneTime. | |
| Note | String | Note. | |
| NotificationLanguageId | Integer | NotificationLanguageId. | |
| OrgId | Integer | OrgId. | |
| OrgName | String | OrgName. | |
| OwnerName | String | OwnerName. | |
| Participants | String | Participants. | |
| PersonDropboxBcc | String | Person Dropbox Bcc. | |
| PersonId | Integer |
Persons.Id | PersonId. |
| PersonName | String | PersonName. | |
| PublicDescription | String | PublicDescription. | |
| MasterActivityId | String | MasterActivityId. | |
| Rule | String | Rule. | |
| RuleExtension | String | RuleExtension. | |
| ReferenceId | Integer | ReferenceId. | |
| ReferenceType | String | ReferenceType. | |
| Series | String | Series. | |
| SourceTimezone | String | SourceTimezone. | |
| Subject | String | Subject. | |
| Type | String | Type. | |
| UpdateTime | Datetime | UpdateTime.. | |
| UpdateUserId | Integer | UpdateUserId.. | |
| UserId | Integer | UserId.. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Exclude | String | A comma-separated string of activity IDs to exclude from result.. |
Get Details of Persons Activities Attendees.
Note: DEPRECATED. To be removed in v26. Use ActivitiesAttendees with PersonId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsActivitiesAttendees WHERE PersonId = 113
SELECT * FROM PersonsActivitiesAttendees WHERE PersonId = 113 AND Done = 0
SELECT * FROM PersonsActivitiesAttendees WHERE PersonId = 113 AND Exclude IN ('240', '241')
| Name | Type | References | Description |
| PersonId [KEY] | Integer |
Persons.Id | PersonId. |
| EmailAddress | String | EmailAddress. | |
| IsOrganizer | Integer | IsOrganizer. | |
| Name | String | Name. | |
| Status | String | Status. | |
| UserId | String |
Users.Id | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Done | Boolean | Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
The allowed values are 0, 1. | |
| Exclude | String | A comma-separated string of activity IDs to exclude from result. |
Get details of Persons activities participants.
Note: DEPRECATED. To be removed in v26. Use ActivitiesParticipants with PersonId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsActivitiesParticipants WHERE PersonId = 113
SELECT * FROM PersonsActivitiesParticipants WHERE PersonId = 113 AND Done = 0
SELECT * FROM PersonsActivitiesParticipants WHERE PersonId = 113 AND Exclude IN ('240', '241')
| Name | Type | References | Description |
| PersonId [KEY] | Integer | PersonId. | |
| PrimaryFlag | Boolean | PrimaryFlag. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Done | Boolean | Whether the activity is done or not 0 = Not done, 1 = Done If omitted returns both Done and Not done activities.
The allowed values are 0, 1. | |
| Exclude | String | A comma-separated string of activity IDs to exclude from result. |
Get details of Persons deals.
Note: DEPRECATED. To be removed in v26. Use Deals with PersonId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsDeals WHERE Id = 246 SELECT * FROM PersonsDeals WHERE Id = 246 AND Status = 'open'
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| Active | Boolean | Active. | |
| ActivitiesCount | Integer | ActivitiesCount. | |
| AddTime | Datetime | AddTime. | |
| CcEmail | String | CcEmail. | |
| CloseTime | String | CloseTime. | |
| CreatoractiveFlag | Boolean | CreatoractiveFlag. | |
| Creatoremail | String | Creatoremail. | |
| CreatorhasPic | Boolean | CreatorhasPic. | |
| Creatorid | Integer | Creatorid. | |
| Creatorname | String | Creatorname. | |
| CreatorPicHash | String | CreatorPicHash. | |
| Creatorvalue | Integer | Creatorvalue. | |
| Currency | String | Currency. | |
| Deleted | Boolean | Deleted. | |
| DoneActivitiesCount | Integer | DoneActivitiesCount. | |
| EmailMessagesCount | Integer | EmailMessagesCount. | |
| ExpectedCloseDate | Date | ExpectedCloseDate. | |
| FilesCount | Integer | FilesCount. | |
| FirstWonTime | Datetime | FirstWonTime. | |
| FollowersCount | Integer | FollowersCount. | |
| FormattedValue | String | FormattedValue. | |
| FormattedWeightedValue | String | FormattedWeightedValue. | |
| Label | String | Label. | |
| LastActivityDate | String | LastActivityDate. | |
| LastActivityId | String | LastActivityId. | |
| LastIncomingMailTime | Datetime | LastIncomingMailTime. | |
| LastOutgoingMailTime | Datetime | LastOutgoingMailTime. | |
| LostReason | String | LostReason. | |
| LostTime | String | LostTime. | |
| NextActivityDate | Date | NextActivityDate. | |
| NextActivityDuration | Time | NextActivityDuration. | |
| NextActivityId | Integer | NextActivityId. | |
| NextActivitynote | String | NextActivitynote. | |
| NextActivitysubject | String | NextActivitysubject. | |
| NextActivitytime | Time | NextActivitytime. | |
| NextActivitytype | String | NextActivitytype. | |
| NotesCount | Integer | NotesCount. | |
| OrgHidden | Boolean | OrgHidden. | |
| OrgActive_flag | Boolean | OrgActive_flag. | |
| OrgAddress | String | OrgAddress. | |
| OrgCcEmail | String | OrgCcEmail. | |
| OrgIdName | String | OrgName. | |
| OrgOwnerId | Integer | OrgOwnerId. | |
| OrgPeopleCount | Integer | OrgPeopleCount. | |
| OrgValue | Integer | OrgValue. | |
| OwnerName | String | OwnerName. | |
| ParticipantsCount | Integer | ParticipantsCount. | |
| PersonHidden | Boolean | PersonHidden. | |
| PersonActiveFlag | Boolean | PersonActiveFlag. | |
| PersonEmail | String | PersonEmail. | |
| PersonIdName | String | PersonName. | |
| PersonPhone | String | PersonPhone. | |
| PersonValue | Integer | PersonValue. | |
| PipelineId | Integer | PipelineId. | |
| Probability | String | Probability. | |
| ProductsCount | Integer | ProductsCount. | |
| RottenTime | String | RottenTime. | |
| StageChangeTime | Datetime | StageChangeTime. | |
| StageId | Integer | StageId. | |
| StageOrderNr | Integer | StageOrderNr. | |
| Status | String | Only fetch deals with specific status.
The allowed values are open, won, lost, deleted, all_not_deleted. The default value is all_not_deleted. | |
| Title | String | Title. | |
| UndoneActivitiesCount | Integer | UndoneActivitiesCount. | |
| UpdateTime | Datetime | UpdateTime. | |
| UserActiveFlag | Boolean | UserActiveFlag. | |
| UserEmail | String | UserEmail. | |
| UserHasPic | Boolean | UserHasPic. | |
| UserId | Integer | UserId. | |
| UserName | String | UserName. | |
| UserPicHash | String | UserPicHash. | |
| UserValue | Integer | UserValue. | |
| Value | Integer | Value. | |
| VisibleTo | String | VisibleTo. | |
| WeightedValue | Integer | WeightedValue. | |
| WeightedValueCurrency | String | WeightedValueCurrency. | |
| WonTime | Datetime | WonTime. | |
| PersonName | String | Person Name. | |
| OrgName | String | Org Name. |
Get details of Persons deals email.
Note: DEPRECATED. To be removed in v26.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsDealsEmail SELECT * FROM PersonsDealsEmail WHERE PersonsDealsId = 2
| Name | Type | References | Description |
| PersonsDealsId [KEY] | Integer | Id. | |
| Label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Primary. |
Get details of Persons deals phone.
Note: DEPRECATED. To be removed in v26.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsDealsPhone SELECT * FROM PersonsDealsPhone WHERE PersonsDealsId = 2
| Name | Type | References | Description |
| PersonsDealsId [KEY] | Integer | Id. | |
| Label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Primary. |
Get all emails asscociated with persons.
Note: DEPRECATED. To be removed in v26. Use PersonsEmails instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsEmail WHERE PersonId = 14 SELECT * FROM PersonsEmail WHERE FirstChar = 'c' SELECT * FROM PersonsEmail WHERE FilterId = 1 SELECT * FROM PersonsEmail WHERE UserId = 1
| Name | Type | References | Description |
| PersonId | Integer |
Persons.Id | Persons Id. |
| label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Primary. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FirstChar | String | If supplied, only persons whose name starts with the specified letter will be returned. | |
| FilterId | Integer | Filter Id. | |
| UserId | Integer | User Id. |
Get details of Persons file.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsFiles WHERE PersonId = 6
| Name | Type | References | Description |
| Id [KEY] | Integer | Id of the files. | |
| ActiveFlag | Boolean | Active Flag. | |
| ActivityId | String | Activity Id. | |
| AddTime | Datetime | AddTime. | |
| Cid | String | Cid. | |
| DealId | String | Deal Id. | |
| DealName | String | DealName. | |
| Description | String | Description. | |
| FileName | String | File Name. | |
| FileSize | Integer | File Size. | |
| FileType | String | File Type. | |
| InlineFlag | Boolean | Inline Flag. | |
| LogId | String | Log Id. | |
| MailMessageId | String | MailMessage Id. | |
| MailTemplateId | String | MailTemplate Id. | |
| Name | String | Name. | |
| OrgId | Integer | Org Id. | |
| OrgName | String | Org Name. | |
| PeopleName | String | People Name. | |
| PersonId | String |
Persons.Id | PersonId. |
| PersonName | String | Person Name. | |
| ProductId | String | Produc tId. | |
| ProductName | String | Product Name. | |
| RemoteId | String | Remote Id. | |
| RemoteLocation | String | Remote Location. | |
| S3Bucket | String | S3Bucket. | |
| UpdateTime | Datetime | Update Time. | |
| Url | String | Url. | |
| UserId | Integer | UserId. | |
| LeadId | String | LeadId. | |
| LeadName | String | LeadName. |
Get details of organizations mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsMailMessages WHERE PersonId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| PersonId | Integer |
Persons.Id | Persons Id. |
| AccountId | String | AccountId. | |
| AddTime | Datetime | addTime. | |
| Bcc | String | Bcc. | |
| BodyUrl | String | bodyUrl. | |
| Cc | String | cc. | |
| CompanyId | Integer | companyId. | |
| DeletedFlag | Boolean | DeletedFlag. | |
| Draft | String | Draft. | |
| DraftFlag | Boolean | DraftFlag. | |
| ExternalDeletedFlag | Boolean | ExternalDeletedFlag. | |
| From | String | From. | |
| AttachmentsFlag | Boolean | AttachmentsFlag. | |
| BodyFlag | Boolean | BodyFlag. | |
| InlineAttachmentsFlag | Boolean | InlineAttachmentsFlag. | |
| RealAttachmentsFlag | Boolean | RealAttachmentsFlag. | |
| ItemType | String | ItemType. | |
| TrackingEnabledFlag | Boolean | TrackingEnabledFlag. | |
| ThreadId | Integer | ThreadId. | |
| TrackingStatus | String | TrackingStatus. | |
| MessageTime | String | MessageTime. | |
| MessageId | String | MessageId. | |
| NylasId | String | NylasId. | |
| ReadFlag | Boolean | ReadFlag. | |
| S3Bucket | String | S3Bucket. | |
| S3BucketPath | String | S3BucketPath. | |
| SentFlag | Boolean | SentFlag. | |
| SentFromPipedriveFlag | Boolean | SentFromPipedriveFlag. | |
| SmartBccFlag | Boolean | SmartBccFlag. | |
| Snippet | String | Snippet. | |
| Subject | String | Subject. | |
| SyncedFlag | Boolean | SyncedFlag. | |
| TemplateId | String | TemplateId. | |
| Timestamp | Datetime | Timestamp. | |
| To | String | To. | |
| UpdateTime | Datetime | UpdateTime. | |
| UserId | Integer | UserId. | |
| WriteFlag | Boolean | writeFlag. | |
| Object | String | Object. |
Get details of Persons mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsMailMessagesBcc WHERE PersonId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of persons mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsMailMessagesCc WHERE PersonId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of persons mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsMailMessagesFrom WHERE PersonId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of Persons mail Messages.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsMailMessagesTo WHERE PersonId = 246
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| EmailAddress | String | EmailAddress. | |
| PersonId | String | PersonId. | |
| PersonName | String | PersonName. | |
| MessagePartyId | Integer | MessagePartyId. | |
| Name | String | Name. |
Get details of permitted users of persons.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsPermittedUsers WHERE PersonId = 6
| Name | Type | References | Description |
| PersonId | Integer |
Persons.Id | Persons Id. |
| Data | String | Users permitted to access an organization. |
Get all phone asscociated with persons.
Note: DEPRECATED. To be removed in v26. Use PersonsPhone instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsPhone WHERE PersonId = 14 SELECT * FROM PersonsPhone WHERE FirstChar = 'c' SELECT * FROM PersonsPhone WHERE FilterId = 1 SELECT * FROM PersonsPhone WHERE UserId = 1
| Name | Type | References | Description |
| PersonId | Integer |
Persons.Id | Persons ID. |
| label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Primary. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FirstChar | String | If supplied, only persons whose name starts with the specified letter will be returned. | |
| FilterId | Integer | Filter Id. | |
| UserId | Integer | User Id. |
Get details of Persons Products.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsProducts WHERE DealPersonId = 113
| Name | Type | References | Description |
| ProductId [KEY] | Integer | ProductId. | |
| DealActive | Boolean | DealActive. | |
| DealActivitiesCount | Integer | DealActivitiesCount. | |
| DealAddTime | Datetime | DealAddTime. | |
| DealCloseTime | String | DealCloseTime. | |
| DealCompanyId | Integer | DealCompanyId. | |
| DealCreatorUserId | Integer | DealCreatorUserId. | |
| DealCurrency | String | DealCurrency. | |
| DealDeleted | Boolean | DealDeleted. | |
| DealDoneActivitiesCount | Integer | DealDoneActivitiesCount. | |
| DealEmailMessagesCount | Integer | DealEmailMessagesCount. | |
| DealExpectedCloseDate | String | DealExpectedCloseDate. | |
| DealFilesCount | Integer | DealFilesCount. | |
| DealFirstAddtime | Datetime | DealFirstAddtime. | |
| DealFirstWonTime | String | DealFirstWonTime. | |
| DealFollowersCount | Integer | DealFollowersCount. | |
| DealId | Integer | DealId. | |
| DealLabel | String | DealLabel. | |
| DealLastActivityDate | String | DealLastActivityDate. | |
| DealLastActivityId | String | DealLastActivityId. | |
| DealLastIncomingMailTime | Datetime | DealLastIncomingMailTime. | |
| DealLastOutgoingMailTime | Datetime | DealLastOutgoingMailTime. | |
| DealLostReason | String | DealLostReason. | |
| DealLostTime | String | DealLostTime. | |
| DealNextActivityDate | Date | DealNextActivityDate. | |
| DealNextActivityId | Integer | DealNextActivityId. | |
| DealNextActivityTime | String | DealNextActivityTime. | |
| DealNotesCount | Integer | DealNotesCount. | |
| DealOrgId | Integer | DealOrgId. | |
| DealParticipantsCount | Integer | DealParticipantsCount. | |
| DealPersonId | Integer |
Persons.Id | persons Id. |
| DealPipelineId | Integer | DealPipelineId. | |
| DealProbability | String | DealProbability. | |
| DealProductsCount | Integer | DealProductsCount. | |
| DealStageChangetime | Datetime | DealStageChangetime. | |
| DealStageId | Integer | DealStageId. | |
| DealStatus | String | DealStatus. | |
| DealTitle | String | DealTitle. | |
| UndoneActivitiescount | Integer | UndoneActivitiescount. | |
| DealUpdateTime | Datetime | DealUpdateTime. | |
| DealUserId | Integer | DealUserId. | |
| DealValue | Double | DealValue. | |
| DealVisibleTo | String | DealVisibleTo. | |
| DealWonTime | String | DealWonTime. | |
| ProductActiveFlag | Boolean | ProductActiveFlag. | |
| ProductAddTime | Datetime | ProductAddTime. | |
| ProductCategory | String | ProductCategory. | |
| ProductCode | String | ProductCode. | |
| ProductCompanyId | Integer | ProductCompanyId. | |
| ProductDealId | Integer | ProductDealId. | |
| ProductDescription | String | ProductDescription. | |
| ProductFilesCount | String | ProductFilesCount. | |
| ProductFirstChar | String | ProductFirstChar. | |
| ProductFollowersCount | Integer | ProductFollowersCount. | |
| ProductName | String | ProductName. | |
| ProductOwnerId | Integer | ProductOwnerId. | |
| ProductSelectable | Boolean | ProductSelectable. | |
| ProductTax | Integer | ProductTax. | |
| ProductUnit | String | ProductUnit. | |
| ProductUpdateTime | Datetime | ProductUpdateTime. | |
| ProductVisibleTo | String | ProductVisibleTo. |
Get details of persons updates.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsUpdates WHERE PersonId = 246
SELECT * FROM PersonsUpdates WHERE PersonId = 10 AND AllChanges = 1
SELECT * FROM PersonsUpdates WHERE PersonId = 10 AND Items IN ('activity', 'plannedActivity')
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| ActiveFlag | Boolean | ActiveFlag. | |
| AddTime | Datetime | AddTime. | |
| NewValueFormatted | String | NewValueFormatted. | |
| AssignedToUserId | Integer | AssignedToUserId. | |
| Attendees | String | Attendees. | |
| BusyFlag | Boolean | BusyFlag. | |
| SyncIncludecontext | String | SyncIncludecontext. | |
| changeSource | String | changeSource. | |
| UserAgent | String | UserAgent. | |
| CompanyId | Integer | CompanyId. | |
| MeetingClient | String | MeetingClient. | |
| MeetingId | String | MeetingId. | |
| MeetingUrl | String | MeetingUrl. | |
| CreatedByUserId | Integer | CreatedByUserId. | |
| DealDropboxBcc | String | DealDropboxBcc. | |
| DealId | Integer | DealId. | |
| DealTitle | String | DealTitle. | |
| Done | Boolean | Done. | |
| DueDate | Date | DueDate. | |
| DueTime | Time | DueTime. | |
| Duration | Time | Duration. | |
| FieldKey | String | FieldKey. | |
| Fileclean_name | String | Fileclean_name. | |
| FileId | String | FileId. | |
| FileUrl | String | FileUrl. | |
| GcaleventId | String | GcaleventId. | |
| GoogleCalendarEtag | String | GoogleCalendarEtag. | |
| GoogleCalendarId | String | GoogleCalendarId. | |
| IsBulkUpdateFlag | String | IsBulkUpdateFlag. | |
| ItemId | Integer | ItemId. | |
| NotificationTime | Datetime | NotificationTime. | |
| NotificationUserId | Integer | NotificationUserId. | |
| LeadId | String | LeadId. | |
| Location | String | Location. | |
| AdminAreaLevel1 | String | AdminAreaLevel1. | |
| AdminAreaLevel2 | String | AdminAreaLevel2. | |
| Country | String | Country. | |
| FormattedAddress | String | FormattedAddress. | |
| Lat | Double | Lat. | |
| Locality | String | Locality. | |
| Long | Double | Long. | |
| PostalCode | String | PostalCode. | |
| Route | String | Route. | |
| StreetNumber | String | StreetNumber. | |
| Sublocality | String | Sublocality. | |
| Subpremise | String | Subpremise. | |
| LogTime | Datetime | LogTime. | |
| MarkedAsDoneTime | Datetime | MarkedAsDoneTime. | |
| NewValue | String | NewValue. | |
| Note | String | Note. | |
| LanguageId | Integer | LanguageId. | |
| OldValue | String | OldValue. | |
| OrgId | Integer | Organizations Id. | |
| OrgName | String | Organizations Name. | |
| OwnerName | String | Owner Name. | |
| Participants | String | Participants. | |
| PersonDropboxBcc | String | Person Dropbox Bcc. | |
| PersonId | Integer |
Persons.Id | Persons Id. |
| PersonName | String | PersonName. | |
| Publicdescription | String | Publicdescription. | |
| RecMasterActivityId | String | RecMasterActivityId. | |
| RecRule | String | RecRule. | |
| RecRuleExtension | String | RecRuleExtension. | |
| ReferenceId | Integer | ReferenceId. | |
| ReferenceType | String | ReferenceType. | |
| Series | String | Series. | |
| SourceTimezone | String | SourceTimezone. | |
| Subject | String | Subject. | |
| Type | String | Type. | |
| UpdateTime | Datetime | UpdateTime. | |
| UpdateUserId | Integer | UpdateUserId. | |
| UserId | Integer | UserId. | |
| Object | String | Object. | |
| Timestamp | Datetime | Timestamp. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | item specific updates.
The allowed values are activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get details of Deals Activities Attendees.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsUpdatesAttendees WHERE PersonId = 246
SELECT * FROM PersonsUpdatesAttendees WHERE PersonId = 10 AND AllChanges = 1
SELECT * FROM PersonsUpdatesAttendees WHERE PersonId = 10 AND Items IN ('activity', 'plannedActivity')
| Name | Type | References | Description |
| PersonId [KEY] | Integer |
Persons.Id | PersonId. |
| EmailAddress | String | EmailAddress. | |
| IsOrganizer | Integer | IsOrganizer. | |
| Name | String | Name. | |
| Status | String | Status. | |
| UserId | String |
Users.Id | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not.
The allowed values are 1. | |
| Items | String | Item specific updates.
The allowed values are activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Get details of activities participants
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsUpdatesParticipants WHERE PersonId = 10
SELECT * FROM PersonsUpdatesParticipants WHERE PersonId = 10 AND AllChanges = 1
SELECT * FROM PersonsUpdatesParticipants WHERE PersonId = 10 AND Items IN ('activity', 'plannedActivity')
| Name | Type | References | Description |
| PersonId [KEY] | Integer | PersonId. | |
| PrimaryFlag | Boolean | PrimaryFlag. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AllChanges | String | Whether to show custom field updates or not
The allowed values are 1. | |
| Items | String | item specific updates
The allowed values are activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document. |
Lists deals in a specific pipeline across all its stages.
Note: DEPRECATED. To be removed in v26. Use Deals with PipelineId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PipelineDeals WHERE PipelineId = 4
| Name | Type | References | Description |
| Id [KEY] | Integer | ID of the pipeline. | |
| Active | Boolean | Active. | |
| ActivitiesCount | Integer | ActivitiesCount. | |
| AddTime | Datetime | AddTime. | |
| CcEmail | String | CcEmail. | |
| CloseTime | String | CloseTime. | |
| CreatorUserId | Integer | CreatorUserId. | |
| Currency | String | Currency. | |
| Deleted | Boolean | Deleted. | |
| DoneActivitiesCount | Integer | DoneActivitiesCount. | |
| EmailMessagesCount | Integer | EmailMessagesCount. | |
| ExpectedCloseDate | Date | ExpectedCloseDate. | |
| FilesCount | Integer | FilesCount. | |
| FirstWonTime | Datetime | FirstWonTime. | |
| FollowersCount | Integer | FollowersCount. | |
| FormattedValue | String | FormattedValue. | |
| FormattedWeightedValue | String | FormattedWeightedValue. | |
| Label | String | Label. | |
| LastActivityDate | String | LastActivityDate. | |
| LastActivityId | String | LastActivityId. | |
| LastIncomingMailTime | Datetime | LastIncomingMailTime. | |
| LastOutgoingMailTime | Datetime | LastOutgoingMailTime. | |
| LostReason | String | LostReason. | |
| LostTime | String | LostTime. | |
| NextActivityDate | Date | NextActivityDate. | |
| NextActivityDuration | Time | NextActivityDuration. | |
| NextActivityId | Integer | NextActivityId. | |
| NextActivityNote | String | NextActivityNote. | |
| NextActivitySubject | String | NextActivitySubject. | |
| NextActivityTime | Time | NextActivityTime. | |
| NextActivityType | String | NextActivityType. | |
| NotesCount | Integer | NotesCount. | |
| OrgHidden | Boolean | OrgHidden. | |
| OrgId | Integer | OrgId. | |
| OrgName | String | OrgName. | |
| OwnerName | String | OwnerName. | |
| ParticipantsCount | Integer | ParticipantsCount. | |
| PersonHidden | Boolean | PersonHidden. | |
| PersonId | Integer | PersonId. | |
| PersonName | String | PersonName. | |
| PipelineId | Integer | PipelineId. | |
| Probability | String | Probability. | |
| ProductsCount | Integer | ProductsCount. | |
| RottenTime | String | RottenTime. | |
| StageChangeTime | Datetime | StageChangeTime. | |
| StageId | Integer | If supplied, only deals within the given stage will be returned. | |
| StageOrderNr | Integer | StageOrderNr. | |
| Status | String | Status. | |
| Title | String | Title. | |
| UndoneActivitiesCount | Integer | UndoneActivitiesCount. | |
| UpdateTime | Datetime | UpdateTime. | |
| UserId | Integer | UserId. | |
| Value | Integer | Value. | |
| VisibleTo | String | VisibleTo. | |
| WeightedValue | Integer | WeightedValue. | |
| WeightedValueCurrency | String | WeightedValueCurrency. | |
| WonTime | Datetime | WonTime. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FilterId | Integer | If supplied, only deals matching the given filter will be returned. |
Returns statistics for deals movements for given time period.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PipelineDealsConversionRates WHERE PipelineId = 4
| Name | Type | References | Description |
| PipelineId | Integer | ID of the pipeline. | |
| LostConversion | Integer | LostConversion. | |
| StageConversions | String | StageConversions. | |
| WonConversion | Integer | WonConversion. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| UserId | Integer | ID of the user who's pipeline statistics to fetch. | |
| StartDate | Datetime | Start of the period. | |
| EndDate | Datetime | End of the period. |
Returns statistics for deals movements for given time period.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PipeLineDealsMovements WHERE PipelineId = 4
| Name | Type | References | Description |
| PipelineId | Integer | ID of the pipeline. | |
| AverageAgeInDaysAcrossAllStages | Integer | AverageAgeInDaysAcrossAllStages. | |
| AverageAgeInDaysByStages | String | AverageAgeInDaysByStages. | |
| DealsLeftOpenCount | Integer | DealsLeftOpenCount. | |
| DealsLeftOpenDealsIds | String | DealsLeftOpenDealsIds. | |
| DealsLeftOpenFormattedValues | String | DealsLeftOpenFormattedValues. | |
| DealsLeftOpenValues | String | DealsLeftOpenValues. | |
| LostDealsCount | Integer | LostDealsCount. | |
| LostDealsDealsIds | String | LostDealsDealsIds. | |
| LostDealsFormattedValues | String | LostDealsFormattedValues. | |
| LostDealsValues | String | LostDealsValues. | |
| MovementsBetweenStagesCount | Integer | MovementsBetweenStagesCount. | |
| NewDealsCount | Integer | NewDealsCount. | |
| NewDealsDealsIds | String | NewDealsDealsIds. | |
| NewDealsFormattedValues | String | NewDealsFormattedValues. | |
| NewDealsValues | String | NewDealsValues. | |
| WonDealsCount | Integer | WonDealsCount. | |
| WonDealsDealsIds | String | WonDealsDealsIds. | |
| WonDealsFormattedValues | String | WonDealsFormattedValues. | |
| WonDealsValues | String | WonDealsValues. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| UserId | Integer | ID of the user who's pipeline statistics to fetch. | |
| StartDate | Datetime | Start of the period. Date in format of YYYY-MM-DD | |
| EndDate | Datetime | End of the period. Date in format of YYYY-MM-DD |
Returns statistics for deals movements for given time period average age in days.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PipelineDealsMovementsAverageAgeInDaysByStages WHERE StartDate='2022-05-18' and EndDate='2023-05-18'
| Name | Type | References | Description |
| PipelineId | Integer | ID of the pipeline. | |
| StageId | Integer | AverageAgeInDaysAcrossAllStages. | |
| Value | Integer | AverageAgeInDaysAcrossAllStages. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| UserId | Integer | ID of the user who's pipeline statistics to fetch. | |
| StartDate | Datetime | Start of the period. Date in format of YYYY-MM-DD | |
| EndDate | Datetime | End of the period. Date in format of YYYY-MM-DD |
Returns statistics for deals movements for given time period
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PipelineDealsStageConversions SELECT * FROM PipelineDealsStageConversions WHERE PipelineId = 4
| Name | Type | References | Description |
| PipelineId | Integer | ID of the pipeline | |
| ConversionRate | Integer | ConversionRate | |
| FromStageId | String | FromStageId | |
| ToStageId | Integer | ToStageId |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| UserId | Integer | ID of the user who's pipeline statistics to fetch | |
| StartDate | Date | Start of the period | |
| EndDate | Date | End of the period |
Returns data about all product fields options.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ProductFieldsOptions
| Name | Type | References | Description |
| Id [KEY] | String | ID of the Product Field Options. | |
| Label | String | Label. |
Get details of Products Deals.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ProductsDeals WHERE Id = 10 SELECT * FROM ProductsDeals WHERE Id = 10 AND status = 'open'
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| ProductId | Integer | Products Id. | |
| Active | Boolean | Active. | |
| ActivitiesCount | Integer | ActivitiesCount. | |
| AddTime | Datetime | AddTime. | |
| CcEmail | String | CcEmail. | |
| CloseTime | String | CloseTime. | |
| CreatorActiveFlag | Boolean | CreatorActiveFlag. | |
| CreatorEmail | String | CreatorEmail. | |
| CreatorHasPic | Boolean | CreatorHasPic. | |
| CreatorId | Integer | CreatorId. | |
| CreatorName | String | CreatorName. | |
| CreatorPicHash | String | CreatorPicHash. | |
| CreatorValue | Integer | CreatorValue. | |
| Currency | String | Currency. | |
| Deleted | Boolean | Deleted. | |
| DoneActivitiesCount | Integer | DoneActivitiesCount. | |
| EmailMessagesCount | Integer | EmailMessagesCount. | |
| ExpectedCloseDate | String | ExpectedCloseDate. | |
| FilesCount | Integer | FilesCount. | |
| FirstWonTime | String | FirstWonTime. | |
| FollowersCount | Integer | FollowersCount. | |
| FormattedValue | String | FormattedValue. | |
| FormattedWeightedValue | String | FormattedWeightedValue. | |
| Label | String | Label. | |
| LastActivityDate | String | LastActivityDate. | |
| LastActivityId | String | LastActivityId. | |
| LastIncomingMailTime | String | LastIncomingMailTime. | |
| LastOutgoingMailTime | String | LastOutgoingMailTime. | |
| LostReason | String | LostReason. | |
| LostTime | String | LostTime. | |
| NextActivityDate | Date | NextActivityDate. | |
| NextActivityDuration | Time | NextActivityDuration. | |
| NextActivityId | Integer | NextActivityId. | |
| NextActivityNote | String | NextActivityNote. | |
| NextActivitySubject | String | NextActivitySubject. | |
| NextActivityTime | Time | NextActivityTime. | |
| NextActivityType | String | NextActivityType. | |
| NotesCount | Integer | NotesCount. | |
| OrgHidden | Boolean | OrgHidden. | |
| OrgIdName | String | OrgId Name. | |
| OrgIdPeopleCount | Integer | OrgId People count. | |
| OrgIdOwnerId | Integer | OrgId Owner Id. | |
| OrgIdAddress | String | OrgId Address. | |
| OrgIdActiveFlag | Boolean | OrgId Active flag. | |
| OrgIdCcEmail | String | OrgId CcEmail. | |
| OrgIdValue | Integer | OrgId Value. | |
| OrgName | String | OrgName. | |
| OwnerName | String | OwnerName. | |
| ParticipantsCount | Integer | ParticipantsCount. | |
| PersonHidden | Boolean | PersonHidden. | |
| PersonActiveFlag | Boolean | PersonActiveFlag. | |
| PersonEmail | String | PersonEmail. | |
| PersonIdName | String | PersonName. | |
| PersonPhone | String | PersonPhone. | |
| PersonValue | Integer | PersonValue. | |
| PipelineId | Integer | PipelineId. | |
| Probability | String | Probability. | |
| ProductsCount | Integer | ProductsCount. | |
| RottenTime | String | RottenTime. | |
| StageChangeTime | String | StageChangeTime. | |
| StageId | Integer | StageId. | |
| StageOrderNr | Integer | StageOrderNr. | |
| Status | String | Only fetch deals with specific status.
The allowed values are open, won, lost, deleted, all_not_deleted. The default value is all_not_deleted. | |
| Title | String | Title. | |
| UndoneActivitiesCount | Integer | UndoneActivitiesCount. | |
| UpdateTime | Datetime | UpdateTime. | |
| UserActiveFlag | Boolean | UserActiveFlag. | |
| UserEmail | String | UserEmail. | |
| UserHasPic | Boolean | UserHasPic. | |
| UserId | Integer | UserId. | |
| UserName | String | UserName. | |
| UserPicHash | String | UserPicHash. | |
| Uservalue | Integer | Uservalue. | |
| Value | Double | Value. | |
| VisibleTo | String | VisibleTo. | |
| WeightedValue | Double | WeightedValue. | |
| WeightedValueCurrency | String | WeightedValueCurrency. | |
| WonTime | String | WonTime. | |
| PersonName | String | Person name. |
Get details of Products Deals person email.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ProductsDealsPersonEmail WHERE ProductId = 10 SELECT * FROM ProductsDealsPersonEmail WHERE ProductId = 10 AND status = 'open'
| Name | Type | References | Description |
| ProductId | Integer | Products Id. | |
| Label | String | Label. | |
| Primary | Boolean | Primary. | |
| Value | String | Value. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Status | String | Only fetch deals with specific status.
The allowed values are open, won, lost, deleted, all_not_deleted. The default value is all_not_deleted. |
Get details of deals person phone.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ProductsDealsPersonphone WHERE ProductId = 10 SELECT * FROM ProductsDealsPersonphone WHERE ProductId = 10 AND status = 'open'
| Name | Type | References | Description |
| ProductId | Integer | Products Id. | |
| Label | String | Label. | |
| Primary | Boolean | Primary. | |
| Value | String | Value. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Status | String | Only fetch deals with specific status.
The allowed values are open, won, lost, deleted, all_not_deleted. The default value is all_not_deleted. |
Get details of Persons file.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ProductsFiles WHERE ProductId = 6 SELECT * FROM ProductsFiles WHERE ProductId = 6 AND IncludeDeletedFiles = 0
| Name | Type | References | Description |
| Id [KEY] | Integer | Id of the products. | |
| ActiveFlag | Boolean | Active Flag. | |
| ActivityId | String | Activity Id. | |
| AddTime | Datetime | AddTime. | |
| Cid | String | Cid. | |
| DealId | String | Deal Id. | |
| DealName | String | DealName. | |
| Description | String | Description. | |
| FileName | String | File Name. | |
| FileSize | Integer | File Size. | |
| FileType | String | File Type. | |
| InlineFlag | Boolean | Inline Flag. | |
| LogId | String | Log Id. | |
| MailMessageId | String | MailMessage Id. | |
| MailTemplateId | String | MailTemplate Id. | |
| Name | String | Name. | |
| OrgId | Integer | Org Id. | |
| OrgName | String | Org Name. | |
| PeopleName | String | People Name. | |
| PersonId | String | PersonId. | |
| PersonName | String | Person Name. | |
| ProductId | String |
Products.id | Product Id. |
| ProductName | String | Product Name. | |
| RemoteId | String | Remote Id. | |
| RemoteLocation | String | Remote Location. | |
| S3Bucket | String | S3Bucket. | |
| UpdateTime | Datetime | Update Time. | |
| Url | String | Url. | |
| UserId | Integer | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| IncludeDeletedFiles | Integer | When enabled, the list of files will also include deleted files.
The allowed values are 0, 1. |
Get details of users permitted to access a Product.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ProductsPermittedUsers WHERE ProductId = 6
| Name | Type | References | Description |
| ProductId | Integer |
Products.Id | Products Id. |
| Data | String | Data. |
Get details of Products Prices.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ProductsPrices WHERE Id = 14
SELECT * FROM ProductsPrices WHERE Name LIKE '%Cdata%'
SELECT * FROM ProductsPrices WHERE code LIKE '%123%'
SELECT * FROM ProductsPrices WHERE FirstChar = 'c'
SELECT * FROM ProductsPrices WHERE FilterId = 1
SELECT * FROM ProductsPrices WHERE UserId = 1
SELECT * FROM ProductsPrices WHERE GetSummary = 1
SELECT * FROM ProductsPrices WHERE Ids IN (1, 2)
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| Cost | Integer | Cost. | |
| Currency | String | Currency. | |
| OverheadCost | String | OverheadCost. | |
| Price | Integer | Price. | |
| ProductId | Integer | ProductId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FirstChar | String | If supplied only Products whose name starts with the specified letter will be returned. | |
| UserId | Integer | User Id. | |
| FilterId | Integer | Filter Id. | |
| GetSummary | Boolean | Get Summary. | |
| Ids | Integer | The Ids of the Products that should be returned in the response. |
Get the details of a specific project template.
The Sync App will use the Pipedrive The filter is executed client side within the Sync App.
SELECT * FROM ProjectTemplates
| Name | Type | References | Description |
| Id [KEY] | Integer | Unique identifier of the project template | |
| Title | String | Title of the project template | |
| Description | String | Description of the project template | |
| UpdateTime | Datetime | Time at which the project template was updated. | |
| AddTime | Datetime | Time at which the project template was added. | |
| OwnerId | Integer | Owner Id of the project template. | |
| ProjectBoardId | Integer | Project boards Id of the project template. |
Returns data about all recent changes occurred after given timestamp.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Recents SELECT * FROM Recents WHERE Id = 2 SELECT * FROM Recents WHERE Id = 2 and SinceTimestamp = '022-01-01 01:29:32'
| Name | Type | References | Description |
| Id | Integer | Id. | |
| DataActive | Boolean | DataActive. | |
| DataActiveFlag | Boolean | DataActiveFlag. | |
| DataActivitiesCount | Integer | DataActivitiesCount. | |
| DataAddTime | Datetime | DataAddTime. | |
| DataAssignedToUserId | Integer | DataAssignedToUserId. | |
| DataAttendees | String | DataAttendees. | |
| DataBusyFlag | String | Data BusyFlag. | |
| DataCalendarSyncContext | String | DataCalendarSyncContext. | |
| DataCcEmail | String | DataCcEmail. | |
| DataCloseTime | String | DataCloseTime. | |
| DataCompanyId | Integer | DataCompanyId. | |
| DataConferenceMeetingClient | String | DataConferenceMeetingClient. | |
| DataConferenceMeetingId | String | DataConferenceMeetingId. | |
| DataConferenceMeetingUrl | String | DataConferenceMeetingUrl. | |
| DataCreatedByUserId | Integer | DataCreatedByUserId. | |
| DataCreatorUserId | Integer | DataCreatorUserId. | |
| DataCurrency | String | DataCurrency. | |
| DataDealDropboxBcc | String | DataDealDropboxBcc. | |
| DataDealId | String | DataDealId. | |
| DataDealTitle | String | DataDealTitle. | |
| DataDeleted | Boolean | DataDeleted. | |
| DataDone | Boolean | DataDone. | |
| DataDoneActivitiesCount | Integer | DataDoneActivitiesCount. | |
| DataDueDate | Date | DataDueDate. | |
| DataDueTime | Datetime | DataDueTime. | |
| DataDuration | Datetime | DataDuration. | |
| DataEmailMessagesCount | Integer | DataEmailMessagesCount. | |
| DataExpectedCloseDate | Date | DataExpectedCloseDate. | |
| DataFileId | String | DataFile Id. | |
| DataFileCleanName | String | DataFile clean name. | |
| DataFileUrl | String | DataFile url. | |
| DataFilesCount | Integer | DataFilesCount. | |
| DataFirstWonTime | String | DataFirstWonTime. | |
| DataFollowersCount | Integer | DataFollowersCount. | |
| DataFormattedValue | String | DataFormattedValue. | |
| DataFormattedWeightedValue | String | DataFormattedWeightedValue. | |
| DataGcalEventId | String | DataGcalEventId. | |
| DataGoogleCalendarEtag | String | DataGoogleCalendarEtag. | |
| DataGoogleCalendarId | String | DataGoogleCalendarId. | |
| DataId | Integer | DataId. | |
| DataLabel | String | DataLabel. | |
| ActivityDate | String | ActivityDate. | |
| ActivityId | String | ActivityId. | |
| IncomingMailTime | String | IncomingMailTime. | |
| LastNotificationTime | String | Last_notification_time. | |
| LastNotificationUserId | String | Last_notification_user_id. | |
| LastOutgoingMailTime | String | Last_outgoing_mail_time. | |
| LeadId | String | LeadId. | |
| LeadTitle | String | LeadTitle. | |
| Location | String | Location. | |
| AreaLevel1 | String | AreaLevel1. | |
| AreaLevel2 | String | AreaLevel2. | |
| LocationCountry | String | LocationCountry. | |
| LocationFormattedAddress | String | LocationFormattedAddress. | |
| Locationlocality | String | Locationlocality. | |
| LocationPostalCode | String | LocationPostalCode. | |
| LocationRoute | String | LocationRoute. | |
| LocationStreetNumber | String | LocationStreetNumber. | |
| LocationSublocality | String | LocationSublocality. | |
| LocationSubpremise | String | LocationSubpremise. | |
| LostReason | String | LostReason. | |
| LostTime | String | LostTime. | |
| MarkedAsDoneTime | String | MarkedAsDoneTime. | |
| NextActivityDate | String | NextActivityDate. | |
| NextActivityDuration | String | NextActivityDuration. | |
| NextActivityId | String | NextActivityId. | |
| NextActivityNote | String | NextActivityNote. | |
| NextActivitySubject | String | NextActivitySubject. | |
| NextActivityTime | String | NextActivityTime. | |
| NextActivityType | String | NextActivityType. | |
| Note | String | Note. | |
| NotesCount | Integer | NotesCount. | |
| NotificationLanguageId | Integer | NotificationLanguageId. | |
| OrgHidden | Boolean | OrgHidden. | |
| OrgId | Integer | OrgId. | |
| OrgName | String | OrgName. | |
| OwnerName | String | OwnerName. | |
| Participants | String | Participants. | |
| ParticipantsCount | Integer | ParticipantsCount. | |
| PersonDropboxBcc | String | PersonDropboxBcc. | |
| PersonHidden | Boolean | PersonHidden. | |
| PersonId | Integer | PersonId. | |
| PersonName | String | PersonName. | |
| PipelineId | Integer | PipelineId. | |
| Probability | String | Probability. | |
| ProductsCount | Integer | ProductsCount. | |
| PublicDescription | String | PublicDescription. | |
| RecMasterActivityId | String | RecMasterActivityId. | |
| RecRule | String | RecRule. | |
| RecRuleExtension | String | RecRuleExtension. | |
| ReferenceId | String | ReferenceId. | |
| ReferenceType | String | ReferenceType. | |
| RottenTime | String | RottenTime. | |
| Series | String | Series. | |
| SourceTimezone | String | SourceTimezone. | |
| StageChangeTime | String | StageChangeTime. | |
| StageId | Integer | StageId. | |
| StageOrderNr | Integer | StageOrderNr. | |
| Status | String | Status. | |
| Subject | String | Subject. | |
| DataTitle | String | DataTitle. | |
| DataType | String | DataType. | |
| UndoneActivitiesCount | Integer | UndoneActivitiesCount. | |
| UpdateTime | Datetime | UpdateTime. | |
| UpdateUserId | String | UpdateUserId. | |
| UserId | Integer | UserId. | |
| Value | Integer | Value. | |
| VisibleTo | String | VisibleTo. | |
| WeightedValue | Integer | WeightedValue. | |
| WeightedValueCurrency | String | WeightedValueCurrency. | |
| WonTime | String | WonTime. | |
| Item | String | Item. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| SinceTimestamp | Datetime | Timestamp in UTC.
The default value is 2000-01-01 01:29:32. |
Returns data about all recent changes occurred after given timestamp attendees.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM RecentsAttendees WHERE SinceTimestamp = '022-01-01 01:29:32'
| Name | Type | References | Description |
| EmailAddress | String | Email Address. | |
| IsOrganizer | Integer | Is Organizer. | |
| Name | String | Name. | |
| PersonId | Integer | Person Id. | |
| Status | String | Status. | |
| UserId | Integer | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| SinceTimestamp | Datetime | Timestamp in UTC.
The default value is 2000-01-01 01:29:32. |
Returns data about all recent changes occurred after given timestamp participants.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM RecentsParticipants WHERE SinceTimestamp = '022-01-01 01:29:32'
| Name | Type | References | Description |
| PersonId | Integer | Person Id. | |
| PrimaryFlag | Boolean | Primary Flag. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| SinceTimestamp | Datetime | Timestamp in UTC.
The default value is 2000-01-01 01:29:32. |
Get the list of either visible or hidden pipeline IDs for a specific role.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM RolesPipelinesVisibility WHERE RoleId = 2
| Name | Type | References | Description |
| RoleId [KEY] | Integer | ID of the Role. | |
| PipelineIds | String | Ids of the Pipeline. | |
| Visible | Boolean | Visible. |
Get deals in a specific stage.
Note: DEPRECATED. To be removed in v26. Use Deals with StageId filter instead.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM StagesDeals WHERE StageId = 2
| Name | Type | References | Description |
| Id [KEY] | Integer | Stages Deals Id. | |
| StageId | Integer | Stage Id. | |
| Active | Boolean | Active. | |
| ActivitiesCount | Integer | Activities count. | |
| AddTime | String | Added time of Stage deals. | |
| CcEmail | String | Cc Email. | |
| CloseTime | String | Close time of Stages deals. | |
| CreatorUserId | Integer | Creator user id. | |
| Currency | String | Currency. | |
| Deleted | Boolean | Boolean value that represents stage deals is deleted or not. | |
| DoneActivitiesCount | Integer | Count of done activities. | |
| EmailMessagesCount | Integer | Count of email messages. | |
| ExpectedCloseDate | Date | Expected close date. | |
| FilesCount | Integer | Count of files. | |
| FirstWonTime | String | First won time. | |
| FollowersCount | Integer | Count of followers. | |
| FormattedValue | String | Formatted value. | |
| FormattedWeightedValue | String | Formatted weighted value. | |
| Label | String | Label. | |
| LastActivityDate | String | Last activity date. | |
| LastActivityId | String | Last activity id. | |
| LastIncomingMailTime | String | Last incoming mail time. | |
| LastOutgoingMailTime | String | Last outgoing mail time. | |
| LostReason | String | Lost reason. | |
| LostTime | String | Lost time. | |
| NextAactivityDate | Date | Next activity date. | |
| NextActivityDuration | String | Next activity duration. | |
| NextActivityId | Integer | Next activity id. | |
| NextActivityNote | String | Next activity note. | |
| NextActivitySubject | String | Next activity subject. | |
| NextActivityTime | String | Next activity time. | |
| NextActivityType | String | Next activity type. | |
| NotesCount | Integer | Notes count. | |
| OrgHidden | Boolean | Org hidden. | |
| OrgId | Integer | Org Id. | |
| OrgName | String | Org Name. | |
| OwnerName | String | Owner name. | |
| ParticipantsCount | Integer | Participants count. | |
| PersonHidden | Boolean | Person hidden. | |
| PersonId | Integer | Person id. | |
| PersonName | String | Person name. | |
| PipelineId | Integer | Pipeline id. | |
| Probability | Unknown | Probability. | |
| ProductsCount | Integer | Products count. | |
| RottenTime | String | Rotten time. | |
| StageChangeTime | String | Stage change time. | |
| StageOrderNr | Integer | Stage order nr. | |
| Status | String | Status. | |
| Title | String | Title. | |
| UndoneActivitiesCount | Integer | Count of undone activities. | |
| UpdateTime | Datetime | Updated time. | |
| UserId | Integer | User id. | |
| Value | Integer | Value. | |
| VisibleTo | String | Visible to. | |
| WeightedValue | Integer | Weighted value. | |
| WeightedValueCurrency | String | Weighted value currency. | |
| WonTime | String | Won time. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FilterId | Integer | Filter id. | |
| Everyone | String | Everyone. |
The data of user connections.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App
For example, the following query is processed server side:
SELECT * FROM UserConnection
| Name | Type | References | Description |
| String | Google. |
Returns access details for all users in the company.
The Sync App uses the Pipedrive API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
For example, the following query is processed server-side:
SELECT * FROM UsersAccess
| Name | Type | References | Description |
| App | String | The name of the application the user is associated with. | |
| Admin | Boolean | Indicates whether the user has administrative access. | |
| PermissionSetId | String | The identifier for the permission set assigned to the user. |
List settings of an authorized user.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App
For example, the following query is processed server side:
SELECT * FROM UserSettings
| Name | Type | References | Description |
| ExpectedCloseDate | String | ExpectedCloseDate. | |
| BetaApp | String | BetaApp. | |
| CalltoLink | String | CalltoLink. | |
| FileUploadDestination | String | FileUploadDestination. | |
| ListLimit | Integer | ListLimit. | |
| MarketplaceCustomUrl | String | MarketplaceCustomUrl. | |
| MarketplaceExtensionsVendor | String | MarketplaceExtensionsVendor. | |
| MarketplaceTeam | String | MarketplaceTeam. | |
| PersonDuplicateCondition | String | PersonDuplicateCondition. | |
| SalesphoneCalltoOverride | String | SalesphoneCalltoOverride. |
Lists the followers of a specific user.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM UsersFollowers WHERE UserId = 2
| Name | Type | References | Description |
| UserId | Integer | ID of the user. | |
| Data | Integer | Data. |
Lists the followers of a specific user.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM UsersPermissions WHERE UserId = 13822542
| Name | Type | References | Description |
| UserId | Integer | ID of the user. | |
| CanAddCustomFields | Boolean | CanAddCustomFields. | |
| CanBulkEditItems | Boolean | CanBulkEditItems. | |
| CanChangeVisibilityOfItems | Boolean | CanChangeVisibilityOfItems. | |
| CanCreateOwnWorkflow | Boolean | CanCreateOwnWorkflow. | |
| CanModifyOwnerForDeals | Boolean | CanModifyOwnerForDeals. | |
| CanDeleteDeals | Boolean | CanDeleteDeals. | |
| CanConvertDealsToLeads | Boolean | CanConvertDealsToLeads. | |
| CanMergeDeals | Boolean | CanMergeDeals. | |
| CanEditDealsClosedDate | Boolean | CanEditDealsClosedDate. | |
| CanModifyOwnerForLeads | Boolean | CanModifyOwnerForLeads. | |
| CanDeleteLeads | Boolean | CanDeleteLeads. | |
| CanMergeLeads | Boolean | CanMergeLeads. | |
| CanSeeDealsListSummary | Boolean | CanSeeDealsListSummary. | |
| CanAddDeals | Boolean | CanAddDeals. | |
| CanEditOtherUsersDeals | Boolean | CanEditOtherUsersDeals. | |
| CanAddLeads | Boolean | CanAddLeads. | |
| CanEditOtherUsersLeads | Boolean | CanEditOtherUsersLeads. | |
| CanEditCustomFields | Boolean | CanEditCustomFields. | |
| CanDeleteCustomFields | Boolean | CanDeleteCustomFields. | |
| CanUseImport | Boolean | CanUseImport. | |
| CanModifyLabels | Boolean | CanModifyLabels. | |
| CanExportDataFromLists | Boolean | CanExportDataFromLists. | |
| CanShareFilters | Boolean | CanShareFilters. | |
| CanEditSharedFilters | Boolean | CanEditSharedFilters. | |
| CanShareInsights | Boolean | CanShareInsights. | |
| CanUseEmailTracking | Boolean | CanUseEmailTracking. | |
| CanSeeOtherUsersStatistics | Boolean | CanSeeOtherUsersStatistics. | |
| CanSeeCompanyWideStatistics | Boolean | CanSeeCompanyWideStatistics. | |
| CanSeeOtherUsers | Boolean | CanSeeOtherUsers. | |
| CanFollowOtherUsers | Boolean | CanFollowOtherUsers. | |
| CanSeeHiddenItemsNames | Boolean | CanSeeHiddenItemsNames. | |
| CanModifyOwnerForActivities | Boolean | CanModifyOwnerForActivities. | |
| CanDeleteActivities | Boolean | CanDeleteActivities. | |
| CanModifyOwnerForPeople | Boolean | CanModifyOwnerForPeople. | |
| CanDeletePeople | Boolean | CanDeletePeople. | |
| CanMergePeople | Boolean | CanMergePeople. | |
| CanModifyOwnerForOrganizations | Boolean | CanModifyOwnerForOrganizations. | |
| CanDeleteOrganizations | Boolean | CanDeleteOrganizations. | |
| CanMergeOrganizations | Boolean | CanMergeOrganizations. | |
| CanAddProducts | Boolean | CanAddProducts. | |
| CanEditOtherUsersProducts | Boolean | CanEditOtherUsersProducts. | |
| CanModifyOwnerForProducts | Boolean | CanModifyOwnerForProducts. | |
| CanDeleteProducts | Boolean | CanDeleteProducts. | |
| CanDeleteProductVariations | Boolean | CanDeleteProductVariations. | |
| CanUseApi | Boolean | CanUseApi. | |
| CanAddPeople | Boolean | CanAddPeople. | |
| CanEditOtherUsersPeople | Boolean | CanEditOtherUsersPeople. | |
| CanAddOrganizations | Boolean | CanAddOrganizations. | |
| CanEditOtherUsersOrganizations | Boolean | CanEditOtherUsersOrganizations. |
Lists role assignments for a user.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM UsersRoleAssignments WHERE UserId = 2
| Name | Type | References | Description |
| UserId | Integer | ID of the user. | |
| RoleId | Integer | Role Id. | |
| ParentRoleId | Integer | Parent Role Id. | |
| Name | String | Name. | |
| ActiveFlag | Boolean | Active flag. | |
| Type | String | Type. |
Lists the settings of user assigned role.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM UsersRoleSettings WHERE UserId = 2
| Name | Type | References | Description |
| UserId | Integer | ID of the user. | |
| DealDefaultVisibility | Integer | Deal Default Visibility. | |
| LeadDefaultVisibility | Integer | Lead Default Visibility. | |
| OrgDefaultVisibility | Integer | Org Default Visibility. | |
| PersonDefaultVisibility | Integer | Person Default Visibility. | |
| ProductDefaultVisibility | Integer | Product Default Visibility. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Pipedrive.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Pipedrive, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| AddAudioFile | Adds an audio recording to the call log. |
| AddChannel | Adds a new messaging channel, only admins are able to register new channels. |
| AddFile | Upload a file and associate it with Deal, Person, Organization, Activity or Product. |
| AddPersonPicture | Adds a picture to a specified person record. |
| CreateRemoteFile | Creates a new empty file in the remote location (googledrive). |
| DealsDuplicate | Duplicate deals.It will create new record for the particular deal. |
| DeleteChannel | Deletes an existing messenger’s channel and all related entities (conversations and messages). |
| DeletePersonPictures | Delete person picture. |
| GetAddons | Get all add-ons for a single company. |
| LinkRemoteFile | Links an existing remote file (googledrive). |
| MergeDeals | Merge two deals in one deal. |
| MergeOrganizations | Merges an organization with another organization. |
| MergePersons | Adds an audio recording to the call log. |
Adds an audio recording to the call log.
Pipedrive allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The required columns in AddAudioFile are Id and Filelocation. If FileLocation is not provided, both the Content which is an input stream of the file and FileName with extension should be provided.
To execute this procedure, enter:
EXEC AddAudioFile Id = '123436', FileLocation = 'C:\Users\Downloads\file_example_MP3_1MG.mp3'
| Name | Type | Description |
| Id | String | Id of call logs. |
| FileLocation | String | File to upload. |
| FileName | String | File name that is uploaded. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure. |
Adds a new messaging channel, only admins are able to register new channels.
Pipedrive allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in AddFile are FileLocation .
For example:
EXECUTE AddChannel Name = 'Test', ProviderChannelId = '123'
| Name | Type | Description |
| Name | String | The name of the channel. |
| ProviderChannelId | String | The channel ID. |
| AvatarUrl | String | The URL for an icon that represents your channel. |
| TemplateSupport | Boolean | If true, enables templates logic on UI. |
| ProviderType | String | It controls the icons (like the icon next to the conversation). |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure. |
Upload a file and associate it with Deal, Person, Organization, Activity or Product.
Pipedrive allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The required columns in AddFile are FileLocation. If FileLocation is not provided, both the Content which is an input stream of the file and FileName with extension should be provided.
To execute this procedure, enter:
EXEC AddFile DealId = '12', FileLocation = 'C:\Users\Downloads\file_example_MP3_1MG.mp3'
| Name | Type | Description |
| DealId | Integer | ID of the deal to associate file(s) with. |
| PersonId | Integer | ID of the person to associate file(s) with. |
| OrgId | Integer | ID of the organization to associate file(s) with. |
| ProductId | Integer | ID of the product to associate file(s) with. |
| ActivityId | Integer | ID of the activity to associate file(s) with. |
| FileLocation | String | File to upload. |
| FileName | String | File name that is uploaded. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure. |
Adds a picture to a specified person record.
Pipedrive allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The required columns in AddPersonPicture are Id and FileLocation. If FileLocation is not provided, both the Content which is an input stream of the file and FileName with extension should be provided.
To execute this procedure, enter:
EXEC AddPersonPicture Id = '1', FileLocation = 'C:\\Users\\Downloads\\download.jpg'
| Name | Type | Description |
| Id | Integer | ID of a person. |
| CropX | Integer | X coordinate to where start cropping form in pixels. |
| CropY | Integer | Y coordinate to where start cropping form in pixels. |
| CropWidth | Integer | Width of cropping area in pixels. |
| CropHeight | Integer | Height of cropping area in pixels. |
| FileLocation | String | File to upload. |
| FileName | String | File name that is uploaded. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure. |
Creates a new empty file in the remote location (googledrive).
Pipedrive allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The required columns in CreateRemoteFile are Filetype, Title,Itemid , Remotelocation and Itemtype.
For example:
EXECUTE CreateRemoteFile Filetype = 'gdoc', Title = 'tests', Itemid = '8230170', Remotelocation = 'googledrive', Itemtype = 'deal'
| Name | Type | Description |
| ItemId | Integer | ID of the item to associate the file with. |
| FileType | String | File type.
The allowed values are gdoc, gslides, gsheet, gform, gdraw. |
| Title | String | Id of call logs. |
| ItemType | String | Item type.
The allowed values are deal, organization, person. |
| RemoteLocation | String | The location type to send the file to. Only googledrive is currently supported.
The allowed values are googledrive. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Duplicate deals.It will create new record for the particular deal.
Pipedrive allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The required columns in DealsDuplicate are Id.
For example:
EXECUTE DealsDuplicate Id = '2'
| Name | Type | Description |
| Id | Integer | The ID of the deals. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure. |
Deletes an existing messenger’s channel and all related entities (conversations and messages).
Pipedrive allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in AddFile are FileLocation .
For example:
EXECUTE DeleteChannel Id = '123'
| Name | Type | Description |
| Id | String | The ID of the channel provided by the integration. |
| Name | Type | Description |
| Success | String | Execution status of the stored procedure. |
Delete person picture.
Pipedrive allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The required columns in DeletePersonPictures are Id.
For example:
EXECUTE DeletePersonPictures Id = 6
| Name | Type | Description |
| Id | Integer | ID of a person. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure. |
Adds an audio recording to the call log.
Pipedrive allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The required columns in DownloadFile are Id and DownloadLocation.
For example:
EXECUTE DownloadFile Id = 6, DownloadLocation = 'D:\\test\\download.txt'
| Name | Type | Description |
| Id | Integer | ID of the file. |
| DownloadLocation | String | Download location. For example: C:\File.mp4 |
| Encoding | String | The FileData input encoding type.
The allowed values are NONE, BASE64. The default value is BASE64. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure. |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Get all add-ons for a single company.
| Name | Type | Description |
| Code | String | Billing add-on code for a company |
Gets an authentication token from PipeDrive.
| Name | Type | Description |
| AuthMode | String | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the PipeDrive app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | The verifier returned from PipeDrive after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| State | String | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the PipeDrive authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with PipeDrive. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of PipeDrive. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
| Name | Type | Description |
| CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Pipedrive app settings. |
| State | String | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Pipedrive authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Links an existing remote file (googledrive).
Pipedrive allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The required columns in DownloadFile are RemoteId ,ItemType ,Itemid ,Remotelocation.
For example:
EXECUTE LinkRemoteFile RemoteId = 1Kh8s-KfS02dYfw2dnEXCal8q0AZ7Wt7T0qn5pJ2PqGM, ItemType = deal, itemid = 8230170, remotelocation = googledrive
| Name | Type | Description |
| ItemId | Integer | ID of the item to associate the file with. |
| RemoteId | String | The remote item id. |
| ItemType | String | Item type.
The allowed values are deal, organization, person. |
| RemoteLocation | String | The location type to send the file to. Only googledrive is currently supported.
The allowed values are googledrive. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Merge two deals in one deal.
Pipedrive allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The required columns in MergeDeals are Id and MergeWithId.
For example:
EXECUTE MergeDeals Id = 1, MergeWithId = 2
| Name | Type | Description |
| Id | Integer | ID of a Deal. |
| MergeWithId | Integer | ID of the deal that the deal will be merged with. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure. |
Merges an organization with another organization.
| Name | Type | Description |
| Id | Integer | The ID of the Organization. |
| MergeWithId | Integer | The ID of the Organization that the Organization will be merged with. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure. |
Adds an audio recording to the call log.
Pipedrive allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The required columns in MergePersons are Id and MergeWithId.
For example:
EXECUTE MergePersons Id = 1, MergeWithId = 2
| Name | Type | Description |
| Id | Integer | ID of a person. |
| MergeWithId | Integer | The ID of the Person that will not be overwritten This Person data will be prioritized in case of conflict with the other Person. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure. |
Refreshes the OAuth access token used for authentication with Pipedrive.
| Name | Type | Description |
| OAuthRefreshToken | String | Set this to the token value that expired. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Pipedrive. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | This is the same as the access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
This section shows the available API objects and provides more information on executing SQL to Pipedrive APIs.
Additionally, the Pipedrive API limits the number and combinations of columns that can be projected over the data or used to restrict the results returned. Please note that the PipeDrive V2 endpoint is currently in beta.
The Sync App models the data in Pipedrive as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Activities | Get all Activities assigned to a particular User. |
| Deals | Get all deals. |
| DealsDiscounts | Get details of deals discounts. |
| Organizations | Get all organizations. |
| Persons | Get all persons. |
| Pipelines | Get all pipelines. |
| Products | Get all products. |
| ProductVariations | Get details of product variations. |
| Stages | Get all stages data. |
Get all Activities assigned to a particular User.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Activities WHERE Id = 1 SELECT * FROM Activities WHERE done = 0 SELECT * FROM Activities WHERE OrgId = 3
Insert can be executed by specifying the Subject column. The columns that are not required can be inserted optionally.
INSERT INTO Activities (Subject, Type) VALUES ('New Meeting', 'call')
UPDATE can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Activities SET Subject = 'Updated activity title' WHERE Id = 1
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Activities WHERE Id = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the activity. | |
| Subject | String | False |
Subject of the activity. | |
| PublicDescription | String | False |
Public description for the activity. | |
| Type | String | False |
Type of the activity. | |
| DueTime | Time | False |
The due time for the activity in HH:MM. | |
| Duration | Time | False |
The duration of the activity in HH:MM. | |
| AddTime | Datetime | True |
The date-time in which the activity was added. | |
| UpdateTime | Datetime | True |
The date-time in which the activity was updated. | |
| Busy | Boolean | False |
Whether the activity marks the assignee as busy or not in their calendar | |
| ConferenceMeetingClient | String | True |
The conference meeting client for the activity. | |
| ConferenceMeetingId | String | True |
The meeting id for the conference call. | |
| ConferenceMeetingUrl | String | True |
The url for the conference meeting. | |
| CreatorUserId | Integer | True |
The user id of the creator of the activity | |
| DealId | Integer | False |
The id of the deal corresponding to the activity | |
| Done | Boolean | False |
Whether the activity is done or not. | |
| DueDate | Date | False |
The due-date for the activity. | |
| IsDeleted | Boolean | True |
Whether the activity is deleted or not. | |
| LeadId | String | False |
The Id of the lead corresponding to the activity. | |
| LocationAggregate | String | False |
The location of the activity. | |
| MarkedAsDoneTime | Datetime | True |
The date-time in which the activity was marked as done. | |
| Note | String | False |
The note of the acitivity. | |
| OrgId | Integer | False |
The id of the organisation corresponding to the activity. | |
| OwnerId | Integer | False |
The id of the owner of the activity. | |
| ParticipantsAggregate | String | False |
The information regarding the participants of the acitivity. | |
| PersonId | Integer | False |
The id of the person linked to the activity. | |
| Priority | Integer | False |
The priority of the activity. | |
| ProjectId | String | False |
The id of the project linked to the acitivity. | |
| AttendeesAggregate | String | False |
The list of attendees linked to the acitivity. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FilterId | Integer |
The ID of the Filter to use. |
Get all deals.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Deals WHERE Id = 14 SELECT * FROM Deals WHERE StageId = 1 SELECT * FROM Deals WHERE Status = 'Open' SELECT * FROM Deals WHERE FilterId = 1
Insert can be executed by specifying the Title columns.The columns that are not read-only can be inserted. Following is an example of how to insert into this table.
INSERT INTO Deals (Title, Currency, StageId, LabelIds) VALUES ('title', 'USD', 1, '[76, 86]')
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Deals SET Title = 'test' WHERE Id = 2
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE Deals WHERE Id = 105
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Deals id. | |
| Title | String | False |
Title. | |
| CreatorUserId | Integer | True |
Creator User Id. | |
| OwnerId | Integer | False |
Owner Id. | |
| Value | Double | False |
Value of the deal. | |
| PersonId | Integer | False |
Person Id. | |
| OrgId | Integer | False |
Org Id. | |
| StageId | Integer | False |
Stage Id. | |
| PipelineId | Integer | False |
Pipeline Id. | |
| Currency | String | False |
Currency. | |
| AddTime | Datetime | False |
Add Time. | |
| UpdateTime | Datetime | False |
Update Time. | |
| StageChangeTime | Datetime | False |
Stage Change Time. | |
| Status | String | False |
Status. The allowed values are open, won, lost, deleted. | |
| IsDeleted | Boolean | False |
Is Deleted. | |
| Probability | Double | False |
Probability. | |
| LostReason | String | False |
Lost Reason. | |
| VisibleTo | Integer | False |
Visible To. | |
| CloseTime | Datetime | False |
Close Time. | |
| WonTime | Datetime | False |
Won Time. | |
| LostTime | Datetime | False |
Lost Time. | |
| LocalWonDate | Date | True |
Local Won Date. | |
| LocalLostDate | Date | True |
Local Lost Date. | |
| LocalCloseDate | Date | True |
Local Close Date. | |
| ExpectedCloseDate | Date | False |
Expected Close Date. | |
| LabelIds | String | False |
Label Ids. | |
| Origin | String | True |
Origin. | |
| OriginId | String | True |
Origin Id. | |
| Channel | Integer | True |
Channel. | |
| ChannelId | String | True |
Channel Id. | |
| Acv | Integer | True |
Acv. | |
| Arr | Integer | True |
Arr. | |
| Mrr | Integer | True |
Mrr. | |
| NextActivityId | Integer | True |
Next Activity Id. | |
| LastActivityId | Integer | True |
Last Activity Id. | |
| FirstWonTime | Datetime | True |
First Won Time. | |
| ProductsCount | Integer | True |
Last Activity Id. | |
| FilesCount | Integer | True |
Products Count. | |
| NotesCount | Integer | True |
Notes Count. | |
| FollowersCount | Integer | True |
Followers Count. | |
| EmailMessagesCount | Integer | True |
Email Messages Count. | |
| ActivitiesCount | Integer | True |
Activities Count. | |
| DoneActivitiesCount | Integer | True |
Done Activities Count. | |
| UndoneActivitiesCount | Integer | True |
Undone Activities Count. | |
| ParticipantsCount | Integer | True |
Participants Count. | |
| LastIncomingMailTime | Datetime | True |
Last Incoming Mail Time. | |
| LastOutgoingMailTime | Datetime | True |
Last Outgoing Mail Time. | |
| CustomFields | String | True |
The custom-fields for the deal. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FilterId | Integer |
Filter Id |
Get details of deals discounts.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier of the discount for the deal | |
| Type | String | False |
The type of discount, eg. percentage, currency etc. | |
| Amount | Integer | False |
The amount of discount for a deal. | |
| CreatedAt | Datetime | True |
The date at which the discount is created. | |
| CreatedBy | Integer | True |
The id of the user that created the discount. | |
| DealId [KEY] | Integer | True |
The id of the deal corresponding to the discount. | |
| Description | String | False |
The description of the discount. | |
| UpdatedAt | Datetime | True |
The date at which the discount was updated. | |
| UpdatedBy | Integer | True |
The id pf the user that updated the discount. |
Get all organizations.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Organizations WHERE Id = 1 SELECT * FROM Organizations WHERE OwnerId = 1
Insert can be executed by specifying the Name column. The columns that are not required can be inserted optionally.
Insert into Organizations (Name, AddressAggregate) values ('[Sample] New Org 5', '[{\"label\": \"work\",\"value\": \"123 Elm Street, Springfield123\"}]')
UPDATE can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Organizations SET Name = 'Updated Org name' WHERE Id = 1
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Organizations WHERE Id = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the organisation. | |
| Name | String | False |
The name of the organization. | |
| AddressAggregate | String | False |
The address of the organisation. | |
| Website | String | True |
The website of the organization. | |
| AddTime | Datetime | True |
The date-time at which the organisation was added. | |
| OwnerId | Integer | False |
The id of the owner of the organisation. | |
| AnnualRevenue | String | True |
The annual revenue of the organisation. | |
| CustomFields | String | True |
The custom-fields for the organization. | |
| EmployeeCount | String | True |
The count of employees in the organisation. | |
| Industry | String | True |
The industry corrsponding to the organisation. | |
| IsDeleted | Boolean | True |
Whether the organisation is deleted. | |
| LabelIds | String | False |
The array of label ids corresponding to the organisation. | |
| String | True |
The linked-in id corresponding to the organization. | ||
| UpdateTime | Datetime | True |
The last updated date and time of the organization. | |
| VisibleTo | Integer | False |
The visibility of the organization. | |
| NextActivityId | Integer | True |
Next Activity Id. | |
| LastActivityId | Integer | True |
Last Activity Id. | |
| OpenDealsCount | Integer | True |
Open Deals Count. | |
| RelatedOpenDealsCount | Integer | True |
Related Open Deals Count. | |
| ClosedDealsCount | Integer | True |
Closed Deals Count. | |
| RelatedClosedDealsCount | Integer | True |
Related Closed Deals Count. | |
| EmailMessagesCount | Integer | True |
Email Messages Count. | |
| PeopleCount | Integer | True |
People Count. | |
| ActivitiesCount | Integer | True |
Activities Count. | |
| DoneActivitiesCount | Integer | True |
Done Activities Count. | |
| UndoneActivitiesCount | Integer | True |
Undone Activities Count. | |
| FilesCount | Integer | True |
Files Count. | |
| NotesCount | Integer | True |
Notes Count. | |
| FollowersCount | Integer | True |
Followers Count. | |
| WonDealsCount | Integer | True |
Won Deals Count. | |
| RelatedWonDealsCount | Integer | True |
Related Won Deals Count. | |
| LostDealsCount | Integer | True |
Lost Deals Count. | |
| RelatedLostDealsCount | Integer | True |
Related Lost Deals Count. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FilterId | Integer |
Filter Id |
Get all persons.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Persons WHERE Id = 1 SELECT * FROM Persons WHERE OwnerId = 1 AND OrgId=2 SELECT * FROM Persons WHERE DealId = 1'
Insert can be executed by specifying the Name column. The columns that are not required can be inserted optionally.
Insert into Persons (Name) values ('New name 1')
UPDATE can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
Update Persons Set name='Updated name 1' where id=10
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Persons where Id=10
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the person | |
| Name | String | False |
The name of the person. | |
| FirstName | String | True |
The first name of the person. | |
| LastName | String | True |
The last name of the person. | |
| EmailsAggregate | String | False |
The array of email details. | |
| PhonesAggregate | String | False |
The array of phone details. | |
| AddTime | Datetime | True |
The date-time in which the persons data was added. | |
| CustomFields | String | True |
The custom-fields for the person. | |
| IsDeleted | Boolean | True |
Is the person data deleted. | |
| LabelIds | String | False |
The id of the label associated with the person. | |
| OrgId | Integer | False |
The id of the organisation associated with the person. | |
| OwnerId | Integer | False |
The id of the owner associated with the person data. | |
| PictureId | String | True |
The id of the picture associated with the person. | |
| UpdateTime | Datetime | True |
The date-time in which the persons data was updated. | |
| VisibleTo | Integer | False |
The visibility of the person. | |
| NextActivityId | Integer | True |
Next Activity Id. | |
| LastActivityId | Integer | True |
Last Activity Id. | |
| OpenDealsCount | Integer | True |
Open Deals Count. | |
| RelatedOpenDealsCount | Integer | True |
Related Open Deals Count. | |
| ClosedDealsCount | Integer | True |
Closed Deals Count. | |
| RelatedClosedDealsCount | Integer | True |
Related Closed Deals Count. | |
| ParticipantOpenDealsCount | Integer | True |
Participant Open Deals Count. | |
| ParticipantClosedDealsCount | Integer | True |
Participant Closed Deals Count. | |
| EmailMessagesCount | Integer | True |
Email Messages Count. | |
| ActivitiesCount | Integer | True |
Activities Count. | |
| DoneActivitiesCount | Integer | True |
Done Activities Count. | |
| UndoneActivitiesCount | Integer | True |
Undone Activities Count. | |
| FilesCount | Integer | True |
Files Count. | |
| NotesCount | Integer | True |
Notes Count. | |
| FollowersCount | Integer | True |
Followers Count. | |
| WonDealsCount | Integer | True |
Won Deals Count. | |
| RelatedWonDealsCount | Integer | True |
Related Won Deals Count. | |
| LostDealsCount | Integer | True |
Lost Deals Count. | |
| RelatedLostDealsCount | Integer | True |
Related Lost Deals Count. | |
| LastIncomingMailTime | Datetime | True |
Last Incoming Mail Time. | |
| LastOutgoingMailTime | Datetime | True |
Last Outgoing Mail Time. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| FilterId | Integer |
Filter Id |
| DealId | Integer |
The id of the deal corresponding to the activity |
Get all pipelines.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Pipelines WHERE Id = 1
Insert can be executed by specifying the Name column. The columns that are not required can be inserted optionally.
insert into Pipelines (Name) values ('Pipeline 2')
UPDATE can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
Update Pipelines Set Name = 'Updated Pipeline 2' where id=4
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Pipelines WHERE Id = 1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the pipeline. | |
| Name | String | False |
The name of the pipeline. | |
| AddTime | Datetime | True |
The date-time in which the pipeline was added. | |
| IsDealProbabilityEnabled | Boolean | False |
Is deal probability enabled. | |
| IsDeleted | Boolean | True |
Is the pipeline deleted. | |
| OrderNr | Integer | True |
The order number of the pipeline. | |
| UpdateTime | Datetime | True |
The date-time in which the pipeline was updated. |
Get all products.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Products WHERE Id = 1
Insert can be executed by specifying the Name column. The columns that are not required can be inserted optionally.
Insert into Products (Name) values ('My product name')
UPDATE can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
Update Products Set Name = 'Updated product name' where id=8
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Products where Id=8
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the product. | |
| Name | String | False |
The name of the product. | |
| Description | String | False |
The description of the product. | |
| PricesAggregate | String | False |
Array of price details for the product. | |
| Tax | Integer | False |
The tax levied on the product. | |
| Unit | String | False |
The unit in which this product is sold | |
| AddTime | Datetime | True |
The date-time in which theproduct was added. | |
| BillingFrequency | String | False |
The frequency of billing of the product. | |
| BillingFrequencyCycles | Integer | False |
The cycle of the billing frequency of the product. | |
| Category | String | False |
The category of the product. | |
| Code | String | False |
The code of the product. | |
| CustomFields | String | True |
The custom-fields for the product. | |
| IsDeleted | Boolean | True |
Is the product deleted. | |
| IsLinkable | Boolean | False |
Whether this product can be added to a deal or not. | |
| OwnerId | Integer | False |
The id of the owner of the product. | |
| UpdateTime | Datetime | True |
The date-time in which the product was updated. | |
| VisibleTo | Integer | False |
The visibility of the product. |
Get details of product variations.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
Select * from ProductVariations where productid=1
Insert can be executed by specifying the Name and productId columns. The columns that are not required can be inserted optionally.
insert into ProductVariations (Name,Productid) values ('product var',1)
UPDATE can be executed by specifying the Id and ProductId in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
Update ProductVariations set name='updated product var' where id=2 and productid=1
Delete can be executed by specifying the Id and ProductId in the WHERE Clause.
For example:
DELETE FROM ProductVariations where id=2 and productid=1
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the product variant. | |
| Name | String | False |
The name of the product variant. | |
| PricesAggregate | String | False |
The array of the price data of the product variant. | |
| ProductId [KEY] | Integer | False |
The id of the product. |
Get all stages data.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM Stages WHERE Id = 1 SELECT * FROM Stages WHERE PipelineId = 1
Insert can be executed by specifying the Name and PipelineId columns. The columns that are not required can be inserted optionally.
Insert into Stages (Name, PipelineId) values ('New Stage',1)
UPDATE can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
Update Stages set Name = 'Updated Stage' where id=8
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Stages where id=8
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the stage. | |
| Name | String | False |
The name of the stage. | |
| AddTime | Datetime | True |
The date-time in which the stage was added. | |
| DaysToRotten | Integer | False |
The number of days the deals not updated in this stage would become rotten. | |
| DealProbability | Integer | False |
The success probability percentage of the deal. | |
| IsDealRotEnabled | Boolean | False |
Whether deals in this stage can become rotten | |
| IsDeleted | Boolean | True |
Whether the deal is deleted. | |
| OrderNr | Integer | True |
The order number corresponding the the stage | |
| PipelineId | Integer | False |
The pipeline id of the the stage | |
| UpdateTime | Datetime | True |
The date-time in which the stage was updated. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| ActivitiesAttendees | Get all Activities attendees |
| ActivitiesParticipants | Get details of activities participants |
| DealsProducts | Get details of deals products. |
| PersonsEmails | Get all emails asscociated with persons. |
| PersonsPhone | Get all phone asscociated with persons. |
Get all Activities attendees
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ActivitiesAttendees WHERE ActivitiesId = 246 SELECT * FROM ActivitiesAttendees WHERE Done = false SELECT * FROM ActivitiesAttendees WHERE PersonId = 1 SELECT * FROM ActivitiesAttendees WHERE DealId = 2 SELECT * FROM ActivitiesAttendees WHERE OrgId = 1
| Name | Type | References | Description |
| ActivitiesId [KEY] | Integer |
Activities.Id | Activities ID. |
| EmailAddress [KEY] | String | EmailAddress. | |
| IsOrganizer | Boolean | IsOrganizer. | |
| Name | String | Name. | |
| AttendeePersonId | Integer | AttendeePersonId. | |
| Status | String | Status. | |
| UserId | Integer | UserId. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FilterId | Integer | The ID of the Filter to use. | |
| OwnerId | Integer | The id of the owner of the activity. | |
| DealId | Integer | The id of the deal corresponding to the activity | |
| LeadId | String | The Id of the lead corresponding to the activity. | |
| PersonId | Integer | The id of the person corresponding to the activity. | |
| OrgId | Integer | The id of the organisation corresponding to the activity. | |
| Done | Boolean | Whether the Activity is done or not. If omitted, returns both Done and Not done activities. |
Get details of activities participants
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM ActivitiesParticipants WHERE ActivitiesId = 246 SELECT * FROM ActivitiesParticipants WHERE Done = true SELECT * FROM ActivitiesParticipants WHERE PersonId = 1 SELECT * FROM ActivitiesParticipants WHERE DealId = 2 SELECT * FROM ActivitiesParticipants WHERE OrgId = 1
| Name | Type | References | Description |
| ParticipantPersonId [KEY] | Integer | ParticipantPersonId | |
| ActivitiesId [KEY] | Integer |
Activities.Id | Activities ID. |
| PrimaryFlag | Boolean | PrimaryFlag |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FilterId | Integer | The ID of the Filter to use. | |
| OwnerId | Integer | The id of the owner of the activity. | |
| DealId | Integer | The id of the deal corresponding to the activity | |
| LeadId | String | The Id of the lead corresponding to the activity. | |
| PersonId | Integer | The id of the person corresponding to the activity. | |
| OrgId | Integer | The id of the organisation corresponding to the activity. | |
| Done | Boolean | Whether the Activity is done or not. If omitted, returns both Done and Not done activities. |
Get details of deals products.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM DealsProductsV2 WHERE Id = 9 AND DealId = 10;
| Name | Type | References | Description |
| Id [KEY] | Integer | Id. | |
| IsEnabled | Boolean | Is enabled. | |
| AddTime | Datetime | AddTime. | |
| UpdateTime | Datetime | UpdateTime. | |
| Comments | String | Any textual comment associated with this product-deal attachment. | |
| Currency | String | Currency. | |
| Discount | Double | Discount. | |
| DealId | Integer | Deal id. | |
| ItemPrice | Double | Price at which this product will be added to the deal. | |
| Name | String | Name. | |
| BillingFrequency | String | Billing frequency. | |
| BillingFrequencyCycles | Integer | Billing frequency cycles. | |
| BillingStartDate | Datetime | Billing start date. | |
| TaxMethod | String | Tax method. | |
| DiscountType | String | Discount Type. | |
| ProductId | Integer | ID of the product that will be attached. | |
| ProductVariationId | Integer | ID of the product variation. | |
| Quantity | Double | How many items of this product will be added to the deal. | |
| Sum | Double | Sum. | |
| Tax | Double | Tax percentage.
The default value is 0. |
Get all emails asscociated with persons.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsEmails WHERE PersonId = 14 SELECT * FROM PersonsEmails WHERE OwnerId = 2 SELECT * FROM PersonsEmails WHERE DealId = 1 SELECT * FROM PersonsEmails WHERE OrgId = 1
| Name | Type | References | Description |
| PersonId | Integer |
Persons.Id | Persons Id. |
| Label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Primary. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FilterId | Integer | Filter Id. | |
| OwnerId | Integer | Owner Id. | |
| DealId | Integer | The id of the deal corresponding to the activity | |
| OrgId | Integer | The id of the organisation corresponding to the activity. |
Get all phone asscociated with persons.
The Sync App will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM PersonsPhone WHERE PersonId = 14 SELECT * FROM PersonsPhone WHERE OwnerId = 2 SELECT * FROM PersonsPhone WHERE DealId = 1 SELECT * FROM PersonsPhone WHERE OrgId = 1
| Name | Type | References | Description |
| PersonId | Integer |
Persons.Id | Persons ID. |
| Label | String | Label. | |
| Value | String | Value. | |
| Primary | Boolean | Primary. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FilterId | Integer | Filter Id. | |
| OwnerId | Integer | Owner Id. | |
| DealId | Integer | The id of the deal corresponding to the activity | |
| OrgId | Integer | The id of the organisation corresponding to the activity. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Pipedrive.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Pipedrive, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
Gets an authentication token from PipeDrive.
| Name | Type | Description |
| AuthMode | String | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the PipeDrive app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | The verifier returned from PipeDrive after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| State | String | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the PipeDrive authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with PipeDrive. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of PipeDrive. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
| Name | Type | Description |
| CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Pipedrive app settings. |
| State | String | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Pipedrive authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Refreshes the OAuth access token used for authentication with Pipedrive.
| Name | Type | Description |
| OAuthRefreshToken | String | Set this to the token value that expired. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Pipedrive. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | This is the same as the access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | Whether to use Basic Authentication or OAuth Authentication when connecting to PipeDrive. |
| CompanyDomain | The company domain used for accessing your Pipedrive account. |
| APIToken | The API Token used for accessing your PipeDrive account. |
| Schema | Specify the Pipedrive API version to use. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| IncludeCustomFields | Set to true to retrieve custom fields values for deals, organizations, persons and products. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | Whether to use Basic Authentication or OAuth Authentication when connecting to PipeDrive. |
| CompanyDomain | The company domain used for accessing your Pipedrive account. |
| APIToken | The API Token used for accessing your PipeDrive account. |
| Schema | Specify the Pipedrive API version to use. |
Whether to use Basic Authentication or OAuth Authentication when connecting to PipeDrive.
Whether to use Basic Authentication or OAuth Authentication when connecting to PipeDrive.
The company domain used for accessing your Pipedrive account.
The company Domain used for accessing your Pipedrive account. You can get it manually from the Pipedrive app by logging into your Developer Sandbox account and seeing the URL.
Here are examples of supported values:
The API Token used for accessing your PipeDrive account.
The API Token can be found in PipeDrive by going to account name (on the top right) -> Company settings -> Personal preferences -> API.
Specify the Pipedrive API version to use.
Select from the following to specify which API version of Pipedrive to use:
Note: The V2 API is currently in beta phase.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Pipedrive. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Pipedrive. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Pipedrive. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\Pipedrive Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| IncludeCustomFields | Set to true to retrieve custom fields values for deals, organizations, persons and products. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
Set to true to retrieve custom fields values for deals, organizations, persons and products.
Set to true to retrieve custom fields values for deals, organizations, persons and products.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Deals WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.