API ReferenceProspects

Read Prospect

Info for a specific prospect

Path parameters

prospectIdstringRequired
The id of the prospect

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request
activitieslist of objects or null
assignedUserobject or null
assignedUserIdstring or nullformat: "uuid"
createdAtdatetime or null
emailstring or null
firstNamestring or null
householdslist of objects or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
lastNamestring or null
middleNamestring or null
organizationIdstring or nullformat: "uuid"
phonestring or null
preferencesobject or null
propertyobject or null
propertyIdstring or nullformat: "uuid"
readableIdstring or null
referralSourcestring or null
updatedAtdatetime or null