leads_list_archived
Retrieve a paginated list of archived leads, filtered by owner, person, or organization, to review or restore inactive leads.
Instructions
List archived leads with pagination and filtering options.
Returns a paginated list of archived leads. Archived leads are leads that have been moved out of the active Leads Inbox but not deleted or converted to deals.
Workflow tips:
Archived leads are sorted by creation time (oldest to newest)
Use owner_id to filter by lead owner
Use person_id or organization_id to filter by associated entities
filter_id takes precedence over other filters
Use start/limit for pagination (default limit: 100, max: 500)
Archived leads can be restored to active status using leads/update
Common use cases:
List all archived leads: {}
List archived leads for a specific owner: { "owner_id": 123 }
List archived leads for a person: { "person_id": 456 }
Review archived leads before deletion: { "limit": 50 }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| owner_id | No | Filter by owner (user) ID | |
| person_id | No | Filter by person ID | |
| organization_id | No | Filter by organization ID | |
| filter_id | No | ID of the filter to use | |
| sort | No | Field names and sorting mode (e.g., "title ASC, value DESC") | |
| start | No | Pagination start | |
| limit | No | Number of items to return |