Sign in
Contacts (People)

Get a list of contacts

Returns a number of contacts which is filterable based on their basic information.

get/contacts

Query parameters

emailstring

Returns contacts with the provided email address.

qstring

Returns contacts with a piece of information similar to the provided string, such as name, email, location, etc.

sort'accountType' | '-accountType' | 'accounts' | '-accounts' | 'createdTime' | '-createdTime' | 'email' | '-email' | 'industry' | '-industry' | 'lastContactedTime' | '-lastContactedTime' | 'name' | '-name' | 'owner' | '-owner' | 'phone' | '-phone' | 'postalCode' | '-postalCode' | 'territory' | '-territory'

What criteria to order the returned list of results. Without this parameter, contacts are ordered by given name in ascending order. For name sorting, contacts with blank names are returned last in both ascending and descending order.

filterobject

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

Contact

linksobject

Where to get related entities.

Example response

{
  "contacts": [
    {
      "id": "3-contacts",
      "name": "Andy Nutshell",
      "description": "CEO / cofounder @ Nutshell. Building growth software, wrangling beagles 🐶",
      "emails": [
        {
          "isPrimary": true,
          "name": "personal",
          "value": "andy@nutshell.com"
        }
      ],
      "addresses": [
        {
          "isPrimary": true,
          "name": "address",
          "value": {
            "location": {
              "longitude": -83.732124,
              "latitude": 42.279594
            }
          },
          "locationAccuracy": "8",
          "address_1": "206 E Huron St",
          "address_2": "Suite 200",
          "city": "Ann Arbor",
          "state": "MI",
          "postalCode": "48103",
          "country": "US"
        }
      ],
      "phones": [
        {
          "isOptedOut": true,
          "isPrimary": true,
          "name": "phone",
          "value": {
            "countryCode": "1",
            "number": "7341234567",
            "extension": "123",
            "numberFormatted": "734-123-4567",
            "E164": "+17341234567",
            "countryCodeAndNumber": "+1 734-123-4567"
          }
        }
      ],
      "urls": [
        {
          "isPrimary": true,
          "name": "LinkedIn",
          "value": "https://www.linkedin.com"
        }
      ],
      "avatarUrl": "https://app.nutshell.com/avatars/contacts/1006/{path}",
      "initials": "AF",
      "htmlUrl": "https://app.nutshell.com/lead/1006",
      "htmlUrlPath": "/lead/1006",
      "jobTitle": "CEO",
      "firstName": "Andy",
      "lastName": "Fowler",
      "href": "https://app.nutshell.com/rest/contacts/3-contacts"
    }
  ]
}

Changes