---
title: "Get a list of accounts"
method: GET
path: "/accounts"
tags: ["Accounts (Companies)"]
---

# Get a list of accounts

`GET /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.

## Query parameters

- `email` string
- `q` string
- `filter` object — Filter the returned accounts based on various criteria. Use /rest/accounts/list/fields to get a full list of valid filter keys.
- `sort` string[]
- `page[limit]` string
- `page[page]` string

## Response `200`

accounts

- object
  - `meta` object — Information about the Nutshell instance making the request
    - `count` integer — The number of returned accounts
    - `total` integer — The total number of accounts in your Nutshell instance
    - `facets` object — Contains an AccountType object, which lists the id and count for each account type in your instance
      - `AccountType` object
        - `n-accountTypes` integer — The number of accounts with the account type id n-accountTypes, where n is an integer
    - `instanceId` string — The Nutshell instance ID
    - `siteId` string — Site ID for WebFX customers
  - `accounts` Account[] — An array of returned accounts.
    - `id` string — The API ID of this entity, formatted {integer}-{entityType}
    - `name` string — The entity's full name.
    - `description` string — A brief explanation of this entity which appears under their name.
    - `createdTime` integer — Unix timestamp
    - `deletedTime` integer — Unix timestamp
    - `emails` object[] — All email addresses associated with an entity.
      - `isPrimary` boolean — If entity has multiple email addresses, which should be used as the primary point of contact.
      - `name` string — A label for the email address, e.g. 'work', 'personal', 'support'.
      - `value` string — The email address itself.
    - `addresses` object[] — All addresses associated with an entity.
      - `isPrimary` boolean — Should this address be used if there are multiple
      - `name` string — A label for the address, e.g. 'work', 'home', 'shipping'.
      - `value` object — The geographic coordinates for the address.
        - `location` object
          - `longitude` number
          - `latitude` number
      - `locationAccuracy` string — How specific the address is. 8 is an exact street address, 1 is only a country.
      - `address_1` string — Primary street address
      - `address_2` string — Secondary street address, such as a suite or apartment number
      - `address_3` string
      - `city` string — City or town
      - `state` string — State or province
      - `postalCode` string — ZIP or postal code
      - `country` string — Country code
      - `timezone` string
    - `phones` object[]
      - `isOptedOut` boolean — If this number has opted out of receiving SMS messages
      - `isPrimary` boolean — Should this phone number be used if there are multiple
      - `name` string — A label for the phone number, e.g. 'work', 'home', 'mobile'.
      - `value` object
        - `countryCode` string — Phone number prefix for calling individuals in other countries
        - `number` string — The unformatted phone number with only digits
        - `extension` string — An additional code to reach a specific person or department which share a number
        - `numberFormatted` string — The phone number formatted for human readability
        - `E164` string — The phone number formatted for international use; a common programatic standard for working with phone numbers
        - `countryCodeAndNumber` string — The phone number formatted for human readability with the country code
    - `urls` object[]
      - `isPrimary` boolean — Should this URL be used if there are multiple
      - `name` string — A label for the URL, e.g. 'LinkedIn', 'Facebook', 'personal website'.
      - `value` string — The URL itself
    - `avatarUrl` string — The URL of the entity's avatar image.
    - `initials` string — The initials of the entity, used as a fallback for the avatar image.
    - `htmlUrl` string — The link to the entity within the app.
    - `htmlUrlPath` string — The path to the entity within the app.
    - `href` string
    - `revenue` object
      - `amount` string
      - `formatted` string
    - `employeeCount` integer

---

[API](https://skmtc.dev/nutshell/apis/nutshell-api.md) · [All operations](https://skmtc.dev/nutshell/apis/nutshell-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nutshell/nutshell-api/revisions/14f59cf6a09a/schema)