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.

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
accountIdinteger or null
Associated account ID
addresslist of strings or null

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

citystring or null
confidencedouble or null

Deal confidence score (0-100)

createdAtstring or nullformat: "date-time"
Creation timestamp
createdByIdinteger or null
Identifier of the user who created the opportunity
custommap from strings to any or null
Custom fields
descriptionstring or null
Record description
geoLocationlist of strings or null

Latitude/Longitude in “lat,lon” format

idinteger or null
Unique identifier
imageUrlstring or null
Image URL for the opportunity
isActiveboolean or null
Whether the record is active
jurisdictionobject or null
lastActivitystring or nullformat: "date-time"
numberinteger or null
Sequential opportunity number
ownerobject or null
phaseobject or null
phaseIdinteger or null
phaseInstanceslist of objects or null
Ordered list of phase instances for the opportunity
primaryEmailstring or nullformat: "email"
Primary contact email
primaryPhonestring or null
Primary contact phone
projectManagerobject or null
salesRepobject or null
sizedouble or null
Deal size
statestring or null
streetstring or null
streetViewUrlstring or null
Street view image URL
titlestring or null

Record title/name

tradeslist of strings or null
Array of trade types
updatedAtstring or nullformat: "date-time"
Last update timestamp
valuedouble or null
Deal value
workflowIdinteger or null
Associated workflow ID
workflowNamestring or null
Name of the associated workflow.
zipcodestring or null

Errors