Sign in

v1

latestOpenAPI 3.0.02026-08-04109109370.6 KB
Leads

Get a list of leads

Get a list of all leads and associated data in your Nutshell Instance.

get/leads

Query parameters

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.

filterobject

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

Leads

linksobject

Example response

{
  "meta": {
    "instanceId": "12345"
  },
  "leads": [
    {
      "htmlUrl": "https://app.nutshell.com/lead/1006",
      "htmlUrlPath": "/lead/1006",
      "avatarUrl": "https://app.nutshell.com/avatars/contacts/1006/{path}",
      "initials": "AF",
      "id": "3-contacts",
      "name": "John Doe",
      "value": {
        "formatted": "$100.00",
        "amount": "100.00",
        "currency": "USD"
      },
      "description": "This is a description",
      "createdTime": {
        "absoluteLocalizedString": "May 28, 2024",
        "value": "May 28, 2024"
      },
      "ownerType": "users",
      "status": "open",
      "confidence": 25
    }
  ]
}