Leads

Returns lead data.

Select

The add-in 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 add-in.

Id supports the '=' operator.
SearchByEmail supports the '=' operator.
OwnerId supports the '=' operator.
PersonId supports the '=' operator.
OrganizationId supports the '=' operator.

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

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

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

Delete can be executed by specifying the Id in the WHERE Clause. For example:

DELETE FROM Leads WHERE Id = 'bf1bb1e0-6e13-11ec-b981-a127469657bd'

Columns


Name	Type	ReadOnly	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	False	Sourcename.
Title	String	False	The name of the Lead.
Updatetime	Datetime	True	UpdateTime.
Amount	Integer	False	The potential value of the Lead.
Currency	String	True	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.

Pseudo-Columns

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.