GET /leads/archived

Returns multiple 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.

Servers

https://api.pipedrive.com/v1

Query parameters

Name	Type	Required	Description
`person_id`	Integer	No	If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
`filter_id`	Integer	No	The ID of the filter to use
`limit`	Integer	No	For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
`sort`	String	No	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). Possible values: `"was_seen"` `"add_time"` `"update_time"` `"id"` `"title"` `"expected_close_date"` `"owner_id"` `"next_activity_id"` `"creator_id"`
`organization_id`	Integer	No	If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
`start`	Integer	No	For pagination, the position that represents the first result for the page
`owner_id`	Integer	No	If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.