Skip to main content
GET
List / filter leads

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Query Parameters

after
string
Minimum string length: 1
limit
integer
default:100
Required range: 1 <= x <= 500
includeDeleted
enum<string>
default:false
Available options:
true,
false
leadStatus
enum<string>
Available options:
new_lead,
screened_needs_match,
matched_to_firm_marketplace,
matched_to_firm_match_direct,
pending_turndown,
screened_turned_down,
no_contact_turned_down,
PromotedToCase,
hidden,
ContactInProgress,
under_review_with_firm,
PendingLead,
ContactAttemptsMaxed,
DuplicateLead,
financing_lead,
defendant,
test_lead,
pending_promotion,
converted,
matched_to_firm_signed_retainers,
waiting_for_retainer
leadType
enum<string>
Available options:
inbound_call,
inbound_message,
online_submission,
financing_intake,
online_contact_promoted,
admin_upload,
insta_lead_form,
hubspot_lead,
admin_financing_upload
source
string
Required string length: 1 - 200
createdAfter
string
createdBefore
string
q
string
Required string length: 2 - 200

Response

Success

success
boolean
required
leads
object[]
required
nextCursor
string | null
required