v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB

Opportunity

Get All Opportunities

This endpoint retrieves all opportunities for the current organization. <h3>Required Scope</h3>opportunity:read or opportunity:write

get/api/v2/opportunities

nextstring

Retrieves the next batch of opportunities. This value expires after 2 minutes if a request has not been made during that time.

limitinteger

The maximum number of opportunities to display per page. A maximum of 1000 is allowed.

filter[start_date]string date

Filter criteria that returns opportunities from this date through filter[end_date]. Format yyyy-mm-dd.

filter[end_date]string date

Filter criteria that returns opportunities from filter[start_date] through this date. Format yyyy-mm-dd.

filter[status]string

Filter criteria that returns opportunities with the desired status. Possible values include Open and Closed.

Success