v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Opportunity API:Opportunities

Find opportunities

get/opportunities

Query parameters

Activeboolean

Filter on opportunity stage.

OwnerIdinteger[]

Search for opportunities by owner

CompanyIdinteger[]

Search for opportunities by company

WorkTypeIdinteger[]

Search for opportunities by worktype

UserGroupIdinteger[]

Search for opportunities by user group

EstimatedClosestring[]

Search for opportunities with a specific estimated close date (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

CreatedAtstring[]

Search for opportunities created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

UpdatedAtstring[]

Search for opportunities updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

Offsetinteger

The index of the first entry to return from the resource collection

Limitinteger

The maximum number of entries to return.<br /> Setting to 0 will return only the total count of matching resources.

Response

List of opportunity matching the specified criteria

totalCountinteger required