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

• api-key
• Bearer

Parameters

Path Parameters

servicepartner

required

string

Query Parameters

leadId

required

string format: uuid

Responses

200

OK

object

id

string format: uuid

status

string

Allowed values: Unmatched Matched Reviewed Contacted Qualified Funded Disqualified Withdrawn

requestedAmount

number format: double

nullable

404

Not Found

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

409

Conflict

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties