We are changing the behaviour of existing deals and leads endpoints to no longer return archived items. Requesting archived deals and leads will be available through new dedicated API endpoints instead. In addition, archived deals and leads will not be editable through the API.

For a full overview of how archiving deals and leads works in Pipedrive, see our Archiving Knowledge Base article.

Summary of the changing endpoints

The following endpoints will be affected:

• GET /v1/deals
• GET /v2/deals
• GET /v1/deals/timeline
• GET /v1/deals/summary
• GET /v1/organizations/{id}/deals
• GET /v1/persons/{id}/deals
• GET /v1/products/{id}/deals
• GET /v1/pipelines/{id}/deals
• GET /v1/stages/{id}/deals
• GET /v1/leads
• PATCH /v1/leads/{id}
• PUT /v1/deals/{id}
• PATCH /v2/deals/{id}

What is changing?

1. Archived deals will not be returned in deals and organizations, persons, products, pipelines and stages linked deals endpoints

From Jul 15th, 2025 the following endpoints will not return archived deals by default:

• GET /api/v1/deals
• GET /api/v2/deals
• GET /api/v1/deals/timeline
• GET /api/v1/deals/summary
• GET /api/v1/organizations/{id}/deals
• GET /api/v1/persons/{id}/deals
• GET /api/v1/products/{id}/deals
• GET /api/v1/pipelines/{id}/deals
• GET /api/v1/stages/{id}/deals

To retrieve archived deals, please use the following new API V2 endpoint instead:

• GET /api/v2/deals/archived

Archived deals linked to a given organization, person, product, pipeline or stage can be fetched instead from the GET /api/v2/deals/archived endpoint that support the following query parameters:

• org_id
• person_id
• pipeline_id
• stage_id

Example: GET /api/v2/deals/archived?org_id=1

As announced in the Deprecation of selected API v1 endpoints changelog post, we are deprecating a number V1 endpoints related to deals by the end of 2025. To support a smooth transition, we are still providing temporary support for archived item endpoints in V1, allowing existing integrations to begin using archiving without immediately requiring a V2 migration.

The following V1 endpoints will be available until the end of 2025:

• GET /v1/deals/archived
• GET /v1/deals/timeline/archived
• GET /v1/deals/summary/archived

2. Archived leads will not be returned by default in leads endpoint

From Jul 15th, 2025 the GET /v1/leads endpoint will not return archived deals by default and will only return. Instead the new GET /v1/leads/archived endpoint can be used to fetch archived leads.

3. archived_status query parameter deprecation for leads endpoint

From Jul 15th, 2025 the GET /v1/leads endpoint will ignore the archived_status query parameter and will only return not-archived leads.

4. Archived leads cannot be edited

From Jul 15th, 2025 archived leads will not be editable through PATCH /v1/leads/{id} endpoint. Only the is_archived property can be edited to unarchive the lead.

Here's an example of the 403 error response:

{
  "success": false,
  "error": "Archived lead cannot be updated.",
  "code": "ERR_LEAD_ARCHIVED",
  "error_info": null,
  "data": null,
  "additional_data: null
}

5. Archived deals cannot be edited

From Jul 15th, 2025 archived deals will no longer be editable through PUT /v1/deals/{id} and PATCH /v2/deals/{id} endpoints. Only the is_archived property can be edited to unarchive the deal.

Here's an example of the 403 error response:

{
  "success": false,
  "error": "Archived deal cannot be updated",
  "code": "ERR_DEAL_ARCHIVED",
  "error_info": null,
  "data": null,
  "additional_data: null
}

As outlined in this deprecation announcement, API V1 endpoint for editing deals is also deprecated, and we recommend using the PATCH /v2/deals/{id} API V2 endpoint for updating deals going forward.

However, to support a smooth transition, temporary support for PUT /v1/deals/{id} will continue until the end of 2025.

If you have any questions or comments, feel free to let us know in the Developer’s Community.