v1

latestOpenAPI 3.0.02026-08-04109109370.6 KB

Accounts (Companies)

Get an account

Get an account by ID. Accounts are companies or organizations that you do business with, and are referred to as 'Companies' in the Nutshell UI. <br> <br> The returned arrays creators, owners, origins, contacts, accountTypes, and industries contain additional information corresponding to the requested accounts.

get/accounts/{id}

Path parameters

idstring[] required

API ids are of the form 'n-accounts', where n is an integer. Ids can be listed in a comma-separated format to retrieve multiple accounts.

Response

account

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"
      }
    }
  ],
  "creators": [
    {
      "avatarUrl": "https://app.nutshell.com/avatars/contacts/1006/{path}",
      "initials": "AF",
      "id": "3-contacts"
    }
  ],
  "owners": [
    {
      "avatarUrl": "https://app.nutshell.com/avatars/contacts/1006/{path}",
      "initials": "AF",
      "id": "3-contacts"
    }
  ],
  "origins": [
    {
      "avatarUrl": "https://app.nutshell.com/avatars/contacts/1006/{path}",
      "initials": "AF",
      "htmlUrl": "https://app.nutshell.com/lead/1006",
      "htmlUrlPath": "/lead/1006",
      "id": "3-contacts"
    }
  ],
  "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"
    }
  ],
  "accountTypes": [
    {
      "id": "3-contacts"
    }
  ],
  "industries": [
    {
      "id": "3-contacts",
      "name": "Software"
    }
  ]
}