API ReferenceProspects

List Prospects

List all prospects

Query parameters

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

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of prospects
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