provider Leads GET /leads
@utdk/pipedrive /leads
Get all leads
Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals.
limit query
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
integer
start query
For pagination, the position that represents the first result for the page
integer
owner_id query
If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
integer
person_id query
If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
integer
organization_id query
If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
integer
filter_id query
The ID of the filter to use
integer
updated_since query
If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
string
sort query
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
enum: id, title, owner_id, creator_id…

Try it

Authentication
Configure credentials for Pipedrive API v1
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getleads
GET/leads
Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals.

For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.

For pagination, the position that represents the first result for the page

If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.

If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.

If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.

The ID of the filter to use

If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.

The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import pipedrive from '@utdk/pipedrive';

await pipedrive.getleads()