API Reference

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

get
https://partners.staging-youlendapi.com/onboarding/Leads/all
🚧

This is our recommended endpoint for fetching a list of leads.

As well as filtering by sign up date, you can also filter on one or more lead states, valid lead states are:
"stage1incomplete", "stage1submitted", "stage1rejected", "ineligible", "rescinded",
"offersProvided", "offerAccepted", "offersExpired", "contractgenerated", "contractsent" (DocuSign flow), "contractsigned",
"readytofund", "stage2submitted" (deprecated), "stage2rejected" (deprecated) or "onboardingcomplete" (deprecated).

Body Params

Search Criteria model.

leadStates
array of strings | null
leadStates
string | null
date-time
required
length ≥ 1
date-time
required
length ≥ 1
string | null
Headers
string
string
enum
Defaults to application/json
Allowed:
Responses

204

No leads were found that match the input criteria for the lending partner.

Updated about 2 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago