Sign in

v1

OpenAPI 3.0.02026-08-04109109370.6 KB
Contacts (People)

Get list items for all contacts

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.

get/contacts/list

Query parameters

filterobject

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

qstring

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

sortstring[]

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

Response

contacts list

Example response

{
  "meta": {
    "instanceId": "12345"
  },
  "listItems": [
    {
      "htmlUrl": "https://app.nutshell.com/lead/1006",
      "htmlUrlPath": "/lead/1006",
      "avatarUrl": "https://app.nutshell.com/avatars/contacts/1006/{path}",
      "initials": "AF",
      "id": "3-contacts"
    }
  ]
}