API ReferenceProspects

List Prospect Statuses

<Badge>Available by Request</Badge> List the platform-wide prospect status catalogue. `ProspectStatus` is fixed, global master data — it has no organizationId or propertyId, and the same statuses with the same ids exist in every environment. The `id` returned here is the value to send as `prospectStatusId` when calling `PUT /prospects/{prospectId}/status`. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

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 prospect statuses
createdAtdatetimeOptional
idstringOptionalformat: "uuid"
idempotencyIdstringOptionalformat: "uuid"
isDefaultbooleanOptional

Whether this is the default status assigned to newly-created prospects. Not filterable (boolean fields have no keyword mapping).

nameenumOptional
orderintegerOptional

Display order of the status. Only equality filtering is supported server-side (filter=order=3); sorting on this field is lexicographic, not numeric, so sort results may not match numeric expectations.

readableIdstringOptional
requiresNotebooleanOptional

Whether the Fortress UI requires a note when a prospect is moved to this status. Not filterable (boolean fields have no keyword mapping).

updatedAtdatetimeOptional