v1
latestOpenAPI 3.0.12026-07-22120163333.7 KBList Leads
Returns a page of leads matching the supplied filters with pagination metadata.
Notes:
- limit must be in [1, 100]; otherwise 400 LIMIT_NOT_VALID.
- Use offset for offset-based pagination or scrollId for cursor-based pagination.
- Multiple filters are combined with AND logic; multi-value filters within a single parameter (e.g. allTags, anyTags) apply their documented AND / OR semantics.
Query parameters
Search for lead by pipeline stage names.
Search for lead by source name.
Precise search for lead by phone number. Example: 3479033333
Precise search for lead by email address.
Search for contacts by user that is assigned to them.
Search for contacts by if they have or have not been contacted.
Search for lead by group names. deprecated, use segments instead.
Search for lead by segment names.
Search for lead with all tag names.
Search for lead with any tag names.
Search for lead by office ids.
Query sub group leads or not
Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request.
Start index of the responded leads
Quantitative limitation of responded leads, range: [1, 100]
The sort order can be one of the following: Default, LastContact, LastCall, LastEmail, LastActivity, CreateTime, Inquries, DeleteTime, AssignTime, Score, Activity, Communication, HasDrip, HasAlert, Task, Lender, ActivitySearch, ActivityViews, ActivityFavorites, DripStatus, DripOpenRate, AlertFrequency, AlertOpenRate, SCOREV2 or SmartPlanStatus
Descending sort(true) or ascending sort(false)
Search for lead with any languages (abbreviation)
Whether to precise search for leads based on email or phone
[{"roleName":"Lead assign role name","assigneeToIds":[111,222]}]
Search by name, phone or email
Headers
Bearer [access_token]
Response
Page of matching leads with pagination metadata.
Example response
{
"get_metadata": {
"collection": "note",
"limit": 10,
"total": 50
},
"leads": [
{
"emails": [
"jane.doe@example.com",
"jdoe-work@company.com"
],
"phones": [
"+14155551234",
"+12125559876"
],
"leadInquiry": {
"priceMin": 1,
"priceMax": 10000000,
"propertyType": [
"Single Family Home",
"Condo"
],
"bedroomsMin": 1,
"bathroomsMin": "1",
"locations": [
{
"city": "Austin",
"stateCode": "TX"
}
]
},
"leadPropertyList": [
{
"price": 100000,
"state": "California",
"city": "New York",
"streetAddress": "22348 Regnart RD",
"zipCode": "25401",
"propertyType": "Single Family Home",
"bedrooms": 3,
"bathrooms": 2,
"squareFeet": 100,
"lotSize": 26.33,
"parkingSpace": 1,
"floors": 1,
"priceMax": 10000000,
"priceMin": 100000
}
],
"customAttributes": [
{
"attributeType": "number, text, date, anniversary_date, single_select, multi_select, percentage, currency"
}
],
"groups": [
"VIP Clients",
"Open House Feb"
],
"segments": [
"First-Time Buyers",
"Downtown Area"
],
"leadTypes": [
2,
5
],
"phoneStatuses": [
2,
3
],
"buyingTimeFrame": "6-12",
"preQual": "Yes",
"houseToSell": "Yes",
"fthb": "Yes",
"withBuyerAgent": "Yes",
"sellingTimeFrame": "1-3",
"mortgage": "Yes",
"buyHouse": "Yes",
"withListingAgent": "Yes",
"opportunity": "High Interest",
"leadFamilyMemberList": [
{
"phones": [
"+14155551234"
],
"emails": [
"spouse@example.com"
]
}
]
}
]
}