Sign in

v2

latestOpenAPI 3.0.02026-08-08112115411.4 KB
Accounts (Companies)

Get a list of 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.

get/accounts

Query parameters

emailstring

query for accounts associated with a specific email address

qstring

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

filterobject

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

sortstring[]

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

page[limit]string

Limit the number of results returned, for pagination.

page[page]string

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

Response

accounts

Example response

{
  "meta": {
    "instanceId": "12345"
  },
  "accounts": [
    {
      "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",
      "revenue": {
        "amount": "8675309.00",
        "formatted": "$8,675,309.00"
      }
    }
  ]
}