API Reference

Get a list of accounts

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

Get all accounts and associated data in your Nutshell instance. Accounts are companies or organizations that you do business with, and are referred to as 'Companies' in the Nutshell UI.

Query Params
string

query for accounts associated with a specific email address

string

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

filter
object

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

sort
array of strings

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

sort
string

Limit the number of results returned, for pagination.

string

Request a specific page of results, for pagination. Used in conjunction with the page[limit] parameter. Indexing is 0-based.

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