Hi team/community,
We are using the API v1 for the deals entity but we are not able to find the documentation as it has been moved to v2.
We understand that, but due to some PROD issues, we need to figure out:
1- How can we filter by date in the v1/deals endpoint
2- Is there any difference between the data retrieved from these 2 endpoints?
v1/deals
v1/deals/collection
Thanks.
Hi! As you noted, both of these endpoints have been deprecated since April 2025 so please migrate to v2 as soon as possible to avoid your integration breaking in the future.
The /v1/deals/collection response was rather similar to the new /v2/deals endpoint in the sense that it did not contain related objects and used cursor pagination (while /v1/deals contained a lot of extra data and used offset pagination). It was only available to subset of users, though (“Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response.”)
These were the documented query parameters for /v1/deals:
user_id
INTEGER
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_id
INTEGER
The ID of the filter to use
stage_id
INTEGER
If supplied, only deals within the given stage will be returned
status
STRING
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.
DEFAULT all_not_deleted
VALUES open won lost deleted all_not_deleted
start
INTEGER
Pagination start
DEFAULT 0
limit
INTEGER
Items shown per page
sort
STRING
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_you
NUMBER
When supplied, only deals owned by you are returned. However, filter_id takes precedence over owned_by_you when both are supplied.