Get leads

Search and filter your leads. This is your main tool for finding leads by status, location, assigned rep, or any other criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Supports all JSON:API query parameters including:

Filtering - filter[field]=value
(e.g., filter[city]=New York&filter[latest_activity_at][gte]=2024-08-27T06:00:00.000Z)

Sorting - sort=field or sort=-field
(e.g., sort=-inserted_at)

Pagination - page[limit]=N&page[offset]=N&page[count]=true
Maximum supported value for page[limit] is 250.
(e.g., page[limit]=25&page[offset]=50)

Field Selection - fields[type]=field1,field2
(e.g., fields[lead]=city,title)

Includes - include=relationship
Valid includes: contacts, contacts.phones, contacts.emails, lead_notes, lead_files, lead_status, assignee
(e.g., include=contacts,lead_status,assignee)

Responses

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