v1

latestOpenAPI 3.0.12026-07-2487164202.8 KB

GET Details

List leads with filtering applied. Returns a max 500 of the most recent results.

get/Leads/all

Headers

api-versionstring

Request body

leadStatesstring[] nullable

Gets or sets the list of lead states to filter by.

filterBystring nullable

dateFromstring date-time required

dateTostring date-time required

sortBystring nullable

Example request

{
  "filterBy": "StateUpdated | SignUpDate",
  "sortBy": "State | StateUpdated | SignUpDate | Owner | LeadType | Country | CountryISOCode | CompanyType"
}

Response

Request processed successfully.

leadIdstring uuid

Gets or sets the lead id.

thirdPartyCustomerIdstring nullable

Gets or sets the TPCI associated with the lead.

preApprovalIdstring uuid

Gets or sets the PreApproval Id.

statestring nullable

Gets or sets the state for the lead.

stateUpdatedstring date-time

Gets or sets the state updated for the lead.

signUpDatestring date-time

Gets or sets the sign-up date for the lead.

additionalInfoobject nullable

Gets or sets additional info associated with the lead.

companyNamestring nullable

Gets or sets the name of the company.

namestring nullable

Gets or sets the name.

ownerstring nullable

Gets or sets the owner.

leadTypestring nullable

Gets or sets the lead type.

partnerLoanTypestring nullable

Gets or sets the Partner Loan Type - "Initial", "Early Renewal" or "Renewal".

ownerEmailstring nullable

Gets or sets the registered email of the owner.

countrystring nullable

Gets or sets the country.

countryISOCodestring nullable

Gets or sets the country ISO value.

emailstring nullable

Gets or sets the registered email of the borrower.

commentsobject[] nullable

Gets or sets the comments.

companyTypestring nullable

Gets or sets the company type.

rejectionReasonsobject[] nullable

Gets or sets the rejection reasons.

ineligibleReasonsobject[] nullable

Gets or sets the ineligible reasons.

rescindedReasonsobject[] nullable

Gets or sets the rescinded reasons.

productTypestring nullable

Gets or sets the product code.