API ReferenceRequests

Get Request

Retrieve a specific request by ID

Authentication

x-api-keystring
API Key authentication via header

Path parameters

requestIdstringRequired
Request identifier

Query parameters

include_virtual_propertiesbooleanOptionalDefaults to false
Whether to include virtual properties in the response. Defaults to false unless explicitly set to true.

Response

Request details
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