API ReferenceRequests

Create Request

Create a new request with required and optional fields. Required fields: - `title`: Request title/name - `address`: Request location - `trades`: Array of trade types Optional fields: - `clientId`: Link to existing client - `workflowId`: Link to workflow - `phaseId`: Link to phase - `value`: Request value - `size`: Request size - `confidence`: Confidence score (0-100) - `primaryEmail`/`primaryPhone`: Contact information - `custom`: Custom fields object Note: If primaryEmail or primaryPhone is provided, a contact will be automatically created or matched.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

allow_new_optionsbooleanOptionalDefaults to false
Whether to allow creation of new dropdown options during record creation
match_byenumOptionalDefaults to title
Field to use for matching existing records
Allowed values:
match_found_strategyenumOptionalDefaults to skip
Strategy to use when a match is found
Allowed values:

Request

This endpoint expects an object.
titlestringRequired

Project title/name

addresslist of stringsRequired

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

tradeslist of stringsRequired
Array of trade types
descriptionstring or nullOptional
Project description
clientIdstringOptional
ID of associated client
workflowIdstringOptional
ID of associated workflow
valuedoubleOptional
Project value
sizedoubleOptional
Project size
statusenumOptional
Status of the project: * `ACTIVE` - Project is active and in progress * `ON_HOLD` - Project is temporarily paused * `CANCELLED` - Project has been cancelled * `COMPLETED` - Project has been completed
Allowed values:
primaryEmailstringOptionalformat: "email"
Primary contact email
primaryPhonestringOptional
Primary contact phone
custommap from strings to anyOptional
Custom fields

Response

Matching request found
addresslist of strings or null

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

citystring or null
clientIdinteger or null
Associated client ID
companyIdinteger or null
Company identifier
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 request
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 request
isActiveboolean or null
Whether the record is active
jurisdictionobject or null
lastActivitystring or nullformat: "date-time"
numberinteger or null
Sequential request number
ownerobject or null
phaseobject or null
phaseIdinteger or null
phaseInstanceslist of objects or null
Ordered list of phase instances for the request
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