API Reference

Get list items for all contacts

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

Get a list of all contacts and associated data in your Nutshell Instance, in a list item format. List items have additional fields attached to them for filtering purposes. Contacts are people that you do business with, and are referred to as 'People' in the Nutshell UI.

Query Params
filter
object

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

string

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

sort
array of strings

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

sort
Response

Updated 3 months ago

Did this page help you?
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

Did this page help you?