PIpipedrive
Leads

Get all leads

Changed on

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.

get/leads

Request

  • Base URL
    https://api.pipedrive.com/v1
  • Auth
    • API key in header x-api-token
    • or OAuth 2
      Authorization code: https://oauth.pipedrive.com/oauth/authorize
      Token URL: https://oauth.pipedrive.com/oauth/token scopes: leads:read, leads:full

Query parameters

limitinteger
Example:100

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

startinteger

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

owner_idinteger
Example:1

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

person_idinteger
Example:1

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

organization_idinteger
Example:1

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

filter_idinteger
Example:1

The ID of the filter to use

updated_sincestring
Example:2025-01-01T10:20:00Z

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.

sortstring

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). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.

Response

Successful response containing payload in the data field

successboolean

Changes

  • 4ff2a1a915c7Revision changes
    • breaking

      removed the enum value add_time from the query request parameter sort

    • breaking

      removed the enum value creator_id from the query request parameter sort

    • breaking

      removed the enum value expected_close_date from the query request parameter sort

    • breaking

      removed the enum value id from the query request parameter sort

    • breaking

      removed the enum value next_activity_id from the query request parameter sort

    • breaking

      removed the enum value owner_id from the query request parameter sort

    • breaking

      removed the enum value title from the query request parameter sort

    • breaking

      removed the enum value update_time from the query request parameter sort

    • breaking

      removed the enum value was_seen from the query request parameter sort

  • e28596d02774Revision changes
    • info

      added the optional property // to the response with the status