Skip to navigation

List Prospect Statuses

Available by Request

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.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Authentication

x-api-keystring
API Key authentication via header

Response

A paged array of prospect statuses
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.

requiresNotebooleanOptional

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

isDefaultbooleanOptional

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

idstringOptionalformat: "uuid"
readableIdstringOptional
idempotencyIdstringOptionalformat: "uuid"
createdAtdatetimeOptional
updatedAtdatetimeOptional