Sign in

v1

OpenAPI 3.0.02026-08-04109109370.6 KB
Accounts (Companies)

Create an account

Create a new account. Accounts are companies or organizations that you do business with, and are referred to as 'Companies' in the Nutshell UI.

post/accounts

Response

OK

idstring

The API ID of this entity, formatted {integer}-{entityType}

namestring

The entity's full name.

descriptionstring

A brief explanation of this entity which appears under their name.

createdTimeinteger

Unix timestamp

deletedTimeinteger

Unix timestamp

avatarUrlstring

The URL of the entity's avatar image.

initialsstring

The initials of the entity, used as a fallback for the avatar image.

htmlUrlstring

The link to the entity within the app.

htmlUrlPathstring

The path to the entity within the app.

hrefstring
employeeCountinteger

Example response

{
  "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"
  }
}