List Prospects
List all prospects.
Each prospect includes isPrimaryProspect: true when the prospect is the primary member
of the household it converted into, false when it is a non-primary member, and null
when the prospect has not been converted to an applicant yet, so the status cannot be
determined — in which case the key is omitted from the record; treat a missing key as
null. Filter on it with isPrimaryProspect = true, = false, or = NULL.
Each prospect also includes portalInviteUrl, the link to send the prospect so they can
register in the resident portal and apply, once a portal account exists for them. Use
POST /prospects/{prospectId}/portal-invitation to create the account and get the link for
a prospect that does not have one yet.
Authentication
Response
Whether this prospect is the primary prospect — the household member Fortress marks as Primary on the application the prospect converted into. false means the prospect is a non-primary member of that household. null means the status cannot be determined: the prospect has not been converted to an applicant, so there is no household membership to read it from. The export pipeline omits null columns, so an undetermined prospect is returned without this key — treat a missing isPrimaryProspect as null.
The prospect’s own resident portal link, to send them so they can register and apply. While the prospect’s portal account is unclaimed this is the claim link; once claimed it is the property’s portal login link. null (and omitted from the record) until a portal account exists for the prospect — call POST /prospects/{prospectId}/portal-invitation to create one — or when the resident portal is not active for the property. The claim link lets whoever holds it set the account password, so send it only to the prospect.