v1
latestOpenAPI 3.0.12026-08-0621301.7 MBGet all archived leads
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.
Query parameters
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
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).
Response
Successful response containing payload in the data field