API Reference

Get a list of contacts

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

Returns a number of contacts which is filterable based on their basic information.

Query Params
string

Returns contacts with the provided email address.

string

Returns contacts with a piece of information similar to the provided string, such as name, email, location, etc.

string
enum

What criteria to order the returned list of results.

filter
object

Filter the returned contacts based on various criteria. Use /rest/contacts/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 3 months 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 3 months ago