v1

latestOpenAPI 3.0.12026-08-0621301.7 MB
Deals

Get all archived deals

Returns all archived deals.

get/deals/archived

Query parameters

user_idinteger

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.

filter_idinteger

The ID of the filter to use

person_idinteger

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

org_idinteger

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

product_idinteger

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

pipeline_idinteger

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

stage_idinteger

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

status'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'

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.

startinteger

Pagination start

limitinteger

Items shown per page

sortstring

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

owned_by_you0 | 1

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

Response

Get all archived deals

successboolean

If the response is successful or not