Sign in

v1

OpenAPI 3.0.02026-08-04109109370.6 KB
Leads

Get list items for all leads

Get a list of all leads and associated data in your Nutshell Instance, in a list item format. List items have additional fields attached to them for filtering purposes.

get/leads/list

Query parameters

filterobject

Filter the returned leads based on various criteria. Use /rest/leads/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.

sort'-age' | '-value' | '-milestone' | '-confidence' | '-name' | '-closedTime' | '-owner' | '-sources' | 'age' | 'value' | 'milestone' | 'confidence' | 'name' | 'closedTime' | 'owner' | 'sources'

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

Response

Leads 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"
    }
  ]
}