v1

latestOpenAPI 3.0.02026-07-1427437.7 KB
Prospects

Get prospect

Retrieves the information of a specific prospect, by its prospectId.

For security and privacy reasons, this request returns masked prospect data. For unmasked information, see Get unmasked prospect.

Learn more about the Profile System and its other API endpoints.

get/api/storage/profile-system/prospects/{prospectId}

Path parameters

prospectIdstring required
Example:51clk394-8534-447e-a0ca-1803p669c987

ID of the prospect as returned by the Create prospect endpoint's response, in the id field.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

{"stackTrail":"paths:/api/storage/profile-system/prospects/{prospectId}:get:responses:200:content:application/json:schema:items","oasType":"schema","type":"unknown"}