Skip to navigation

List contacts

View as Markdown

List the contacts in your organization, newest first (by date_created).

To list the contacts on a single lead, pass lead_id. If you don’t have the “View All Leads” permission, lead_id is required: without it, the request fails with 403. It also returns 403 if you can’t access the lead you named.

Use _fields to return only the fields you need. lead_id is always returned. Custom field values appear as custom.{custom_field_id} keys.

Results are paginated with _limit and _skip.

To filter by criteria other than lead_id, use Advanced Filtering. To retrieve more contacts 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<=1000Defaults to 100
Number of results to return.
_skipintegerOptional<=15000Defaults to 0
Number of results to skip before returning, for pagination.
_fieldsstringOptional

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

lead_idstring or nullOptional

Only return contacts on this lead, e.g. lead_etYl6PwL12hkj14567kjolJwZuZehb9b85EDH9CKuAI. Required if you don’t have the “View All Leads” permission.

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