> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Accounts

> This endpoint gets or creates a new account.

### Body

<ParamField body="limit" required="false" type="string">
  This is the limit of the accounts.
</ParamField>

<ParamField body="offset" required="false" type="string">
  This is the offset of the accounts.
</ParamField>

<ParamField body="order_direction" required="false" type="string">
  This is the order direction of the accounts.
</ParamField>

### Response

<ResponseField name="id" required="true" type="string">
  This is the id of the account.
</ResponseField>

<ResponseField name="accountName" required="true" type="string">
  This is the account name of the account.
</ResponseField>

<ResponseField name="accountNotes" required="true" type="string">
  This is the account notes of the account.
</ResponseField>

<ResponseField name="accountSubtype" required="true" type="string">
  This is the account subtype of the account.
</ResponseField>

<ResponseField name="accountType" required="true" type="string">
  This is the account type of the account.
</ResponseField>

<ResponseField name="account_owner" required="true" type="string">
  This is the account owner of the account.
</ResponseField>

<ResponseField name="account_source" required="true" type="string">
  This is the account source of the account.
</ResponseField>

<ResponseField name="annualRevenue" required="true" type="string">
  This is the annual revenue of the account.
</ResponseField>

<ResponseField name="avatar" required="true" type="string">
  This is the avatar of the account.
</ResponseField>

<ResponseField name="billingCity" required="true" type="string">
  This is the billing city of the account.
</ResponseField>

<ResponseField name="billingCountry" required="true" type="string">
  This is the billing country of the account.
</ResponseField>

<ResponseField name="billingLatitude" required="true" type="string">
  This is the billing latitude of the account.
</ResponseField>

<ResponseField name="billingLongitude" required="true" type="string">
  This is the billing longitude of the account.
</ResponseField>

<ResponseField name="billingState" required="true" type="string">
  This is the billing state of the account.
</ResponseField>

<ResponseField name="billingStreet" required="true" type="string">
  This is the billing street of the account.
</ResponseField>

<ResponseField name="created_at" required="true" type="string">
  This is the created at of the account.
</ResponseField>

<ResponseField name="description" required="true" type="string">
  This is the description of the account.
</ResponseField>

<ResponseField name="employees" required="true" type="string">
  This is the employees of the account.
</ResponseField>

<ResponseField name="fax" required="true" type="string">
  This is the fax of the account.
</ResponseField>

<ResponseField name="industry" required="true" type="string">
  This is the industry of the account.
</ResponseField>

<ResponseField name="is_active" required="true" type="string">
  This is the is active of the account.
</ResponseField>

<ResponseField name="is_public" required="true" type="string">
  This is the is public of the account.
</ResponseField>

<ResponseField name="last_modified_by" required="true" type="string">
  This is the last modified by of the account.
</ResponseField>

<ResponseField name="numberOfEmployees" required="true" type="string">
  This is the number of employees of the account.
</ResponseField>

<ResponseField name="ownership" required="true" type="string">
  This is the ownership of the account.
</ResponseField>

<ResponseField name="phone" required="true" type="string">
  This is the phone of the account.
</ResponseField>

<ResponseField name="rating" required="true" type="string">
  This is the rating of the account.
</ResponseField>

<ResponseField name="shippingCity" required="true" type="string">
  This is the shipping city of the account.
</ResponseField>

<ResponseField name="shippingCountry" required="true" type="string">
  This is the shipping country of the account.
</ResponseField>

<ResponseField name="shippingLatitude" required="true" type="string">
  This is the shipping latitude of the account.
</ResponseField>

<ResponseField name="shippingLongitude" required="true" type="string">
  This is the shipping longitude of the account.
</ResponseField>

<ResponseField name="shippingState" required="true" type="string">
  This is the shipping state of the account.
</ResponseField>

<ResponseField name="shippingStreet" required="true" type="string">
  This is the shipping street of the account.
</ResponseField>

<ResponseField name="sicCode" required="true" type="string">
  This is the sic code of the account.
</ResponseField>

<ResponseField name="tickerSymbol" required="true" type="string">
  This is the ticker symbol of the account.
</ResponseField>

<ResponseField name="website" required="true" type="string">
  This is the website of the account.
</ResponseField>

<ResponseField name="yearStarted" required="true" type="string">
  This is the year started of the account.
</ResponseField>

<ResponseField name="zipCode" required="true" type="string">
  This is the zip code of the account.
</ResponseField>

<ResponseField name="created_by" required="true" type="string">
  This is the created by of the account.
</ResponseField>

<ResponseField name="updated_by" required="true" type="string">
  This is the updated by of the account.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl --location --request GET 'https://api.stateset.com/v1/accounts' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Token <token>' \
  --data-raw '{
      "limit": 10,
      "offset": 0,
      "order_direction": "desc"
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {

      "count": 1,
      "next": null,
      "previous": null,
      "results": [
          {
              "id": "1",
              "accountName": "Test Account",
              "accountNotes": "Test Account Notes",
              "accountSubtype": "Test Account Subtype",
              "accountType": "Test Account Type",
              "account_owner": "Test Account Owner",
              "account_source": "Test Account Source",
              "annualRevenue": "Test Annual Revenue",
              "avatar": "Test Avatar",
              "billingCity": "Test Billing City",
              "billingCountry": "Test Billing Country",
              "billingLatitude": "Test Billing Latitude",
              "billingLongitude": "Test Billing Longitude",
              "billingState": "Test Billing State",
              "billingStreet": "Test Billing Street",
              "created_at": "2021-04-27T15:00:00.000000Z",
              "description": "Test Description",
              "employees": "Test Employees",
              "fax": "Test Fax",
              "industry": "Test Industry",
              "is_active": true,
              "is_public": true,
              "last_modified_by": "Test Last Modified By",
              "numberOfEmployees": "Test Number Of Employees",
              "ownership": "Test Ownership",
              "phone": "Test Phone",
              "rating": "Test Rating",
              "shippingCity": "Test Shipping City",
              "shippingCountry": "Test Shipping Country",
              "shippingLatitude": "Test Shipping Latitude",
              "shippingLongitude": "Test Shipping Longitude",
              "shippingState": "Test Shipping State",
              "shippingStreet": "Test Shipping Street",
              "sicCode": "Test Sic Code",
              "tickerSymbol": "Test Ticker Symbol",
              "website": "Test Website",
              "yearStarted": "Test Year Started",
              "zipCode": "Test Zip Code",
              "created_by": "Test Created By",
              "updated_by": "Test Updated By"
          }
      ]

  }
  ```
</ResponseExample>

# Accounts

Accounts describes the general data about the accounts in Stateset.

## The account object

#### Attributes

| Name               | Type      | Description                                              |
| ------------------ | --------- | -------------------------------------------------------- |
| id                 | Text      | Unique identifier for the account                        |
| accountName        | Text      | Name of the account                                      |
| accountNotes       | Text      | Notes or additional information about the account        |
| accountSubtype     | Text      | Subtype or specific category of the account              |
| accountType        | Text      | Type or general category of the account                  |
| account\_owner     | Text      | Owner or responsible person for the account              |
| account\_source    | Text      | Source or origin of the account                          |
| annualRevenue      | Text      | Annual revenue associated with the account               |
| avatar             | Text      | URL or path to the account's avatar image                |
| billingCity        | Text      | City of the billing address                              |
| billingCountry     | Text      | Country of the billing address                           |
| billingLatitude    | Text      | Latitude coordinate of the billing address               |
| billingLongitude   | Text      | Longitude coordinate of the billing address              |
| billingState       | Text      | State or province of the billing address                 |
| billingStreet      | Text      | Street address of the billing address                    |
| created\_at        | Date/Time | Date and time when the account was created               |
| description        | Text      | Description or additional details about the account      |
| employees          | Text      | Number or range of employees associated with the account |
| fax                | Text      | Fax number of the account                                |
| industry           | Text      | Industry or sector of the account                        |
| is\_active         | Boolean   | Indicates whether the account is currently active        |
| is\_public         | Boolean   | Indicates whether the account is public or private       |
| last\_modified\_by | Text      | Last person who modified the account                     |
| numberOfEmployees  | Text      | Number of employees associated with the account          |
| ownership          | Text      | Ownership type or structure of the account               |
| parentAccount      | Text      | Parent account associated with the account               |
| phone              | Text      | Phone number of the account                              |
| rating             | Text      | Rating or evaluation of the account                      |
| shippingCity       | Text      | City of the shipping address                             |
| shippingCountry    | Text      | Country of the shipping address                          |
| shippingLatitude   | Text      | Latitude coordinate of the shipping address              |
| shippingLongitude  | Text      | Longitude coordinate of the shipping address             |
| shippingState      | Text      | State or province of the shipping address                |
| shippingStreet     | Text      | Street address of the shipping address                   |
| stockTicker        | Text      | Stock ticker symbol associated with the account          |
| website            | Text      | Website URL of the account                               |
| yearStarted        | Text      | Year the account was started or established              |
