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.

sort

string

enum

What criteria to order the returned list of results. Without this parameter, contacts are ordered by given name in ascending order. For name sorting, contacts with blank names are returned last in both ascending and descending order.

filter

object

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

page[page]

integer

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

page[limit]

integer

How many results to return per page

Response

200Contact