provider Deals GET /deals/archived
@utdk/pipedrive /deals/archived
Get all archived deals
Returns all archived deals.
user_id query
If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
integer
filter_id query
The ID of the filter to use
integer
person_id query
If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
integer
org_id query
If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
integer
product_id query
If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.
integer
pipeline_id query
If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
integer
stage_id query
If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
integer
status query
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
enum: open, won, lost, deleted…
start query
Pagination start
integer
limit query
Items shown per page
integer
sort query
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).
string
owned_by_you query
When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.
enum: 0, 1

Try it

Authentication
Configure credentials for Pipedrive API v1
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getarchiveddeals
GET/deals/archived
Returns all archived deals.

If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.

The ID of the filter to use

If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.

If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.

If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.

If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.

If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.

Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.

Pagination start

Items shown per page

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).

When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import pipedrive from '@utdk/pipedrive';

await pipedrive.getarchiveddeals({
  "status": "all_not_deleted",
  "start": 0
})