Get a lead by ID

GET

/api/v1/{servicepartner}/leads

Retrieves a specific lead using its unique identifier. The lead must belong to either the service partner or referral partner making the request. Returns basic lead information including status and requested amount.

Authorizations

• Bearer
• api-key

Parameters

Path Parameters

servicepartner

required

String

string

Query Parameters

leadId

required

Guid

string format: uuid

Responses

200

OK

LeadReadModel

object

id

Guid

string format: uuid

status

LegacyLeadStage

string

Allowed values: Unmatched Matched Reviewed Contacted Qualified Funded Disqualified Withdrawn

requestedAmount

Nullable`1

number format: double

nullable

404

Not Found

ProblemDetails

object

type

String

string

nullable

title

String

string

nullable

status

Nullable`1

integer format: int32

nullable

detail

String

string

nullable

instance

String

string

nullable

key

additional properties

Object

409

Conflict

ProblemDetails

object

type

String

string

nullable

title

String

string

nullable

status

Nullable`1

integer format: int32

nullable

detail

String

string

nullable

instance

String

string

nullable

key

additional properties

Object