Skip to navigation

List Leads

View as Markdown

List the leads in your organization, most recently updated first. Only leads you have access to are returned.

Results come from the search index, so a lead you just created or updated may not appear immediately.

Use _fields to return only the fields you need, or _fields=_all to also include optional fields such as primary_email, primary_phone and contact_ids. Custom field values appear as custom.{custom_field_id} keys.

Results are paginated with _limit and _skip.

To filter leads, use Advanced Filtering. To retrieve more leads than this endpoint allows, use Exports.

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

_limitintegerOptional<=200Defaults to 100
Number of results to return.
_skipintegerOptional<=250000Defaults to 0
Number of results to skip before returning, for pagination. The maximum is 35,000 for some organizations.
_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response
datalist of objects
The results on this page.
has_moreboolean
Whether more results exist after this page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error