API Reference

Get a list of leads

get
https://app.nutshell.com/rest/leads

Get a list of all leads and associated data in your Nutshell Instance.

Query Params
string

Used to search all related info on an entity. Returns all entities that are similar to the query term.

string
enum

Sort the returned list by a chosen field. Use a '-' before the field name to sort in descending order.

filter
object

Filter the returned leads based on various criteria. Use /rest/leads/list/fields to get a full list of valid filter keys.

integer

The page of results to return. Indexing is 0-based.

integer

How many results to return per page

Response

Updated about 1 month ago

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

Updated about 1 month ago