API ReferenceOpportunities

List Opportunities

Retrieve a paginated list of opportunities. Supports: - Pagination (`page_size`, `page`) - Date filtering (`updated_after`, `updated_before`) - Sorting (`order_by`, default: desc) - Field search (`title`, `address`, `primaryName`, `primaryPhone`, `primaryEmail`) - Full text search (`q`) **Note:** The `/requests` path is an alias for `/opportunities` and will continue to work until users are individually notified and migrated. **Note:** If an opportunity has no `title` (empty or whitespace-only), the response returns the parent account's `title` instead. The stored value is not modified — this is a read-time fallback only.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

updated_afterstringOptionalformat: "date-time"

Filter items updated after this timestamp (ISO 8601)

updated_beforestringOptionalformat: "date-time"

Filter items updated before this timestamp (ISO 8601)

order_byenumOptionalDefaults to asc
Sort order for results
Allowed values:
include_virtual_propertiesbooleanOptionalDefaults to false
Whether to include virtual properties in the response. Defaults to false unless explicitly set to true.
include_archivedbooleanOptionalDefaults to false

Whether to include archived (inactive) records in the response. By default only active records are returned.

qstringOptional
Full text search query
titlestringOptional
Title search query
addressstringOptional
Address search query
primaryNamestringOptional
Contact name search query
primaryPhonestringOptional
Contact phone search query
primaryEmailstringOptional
Contact email search query

Response

List of opportunities
idinteger
Unique identifier
createdAtstringformat: "date-time"
Creation timestamp
updatedAtstringformat: "date-time"
Last update timestamp
titlestring

Record title/name

descriptionstring or null
Record description
addresslist of strings

An array containing a single string, which represents the full opportunity location/address.

isActiveboolean
Whether the record is active
primaryEmailstring or nullformat: "email"
Primary contact email
primaryPhonestring or null
Primary contact phone
numberinteger
Sequential opportunity number
custommap from strings to any
Custom fields
tradeslist of strings
Array of trade types
valuedouble or null
Deal value
sizedouble or null
Deal size
confidencedouble or null

Deal confidence score (0-100)

workflowIdinteger or null
Associated workflow ID
accountIdinteger or null
Associated account ID
createdByIdinteger
Identifier of the user who created the opportunity
geoLocationlist of strings

Latitude/Longitude in “lat,lon” format

imageUrlstring or null
Image URL for the opportunity
streetViewUrlstring or null
Street view image URL
citystring
zipcodestring
statestring
streetstring
phaseobject or null
phaseInstanceslist of objects
Ordered list of phase instances for the opportunity
ownerobject or null
salesRepobject or null
projectManagerobject or null
jurisdictionobject or null
lastActivitystring or nullformat: "date-time"
phaseIdinteger or null
workflowNamestring
Name of the associated workflow.

Errors

401
Unauthorized Error