---
title: "OData end point to get a list of all accounts (contacts) accessible by the user"
method: GET
path: "/api/account"
tags: ["Account"]
---

# OData end point to get a list of all accounts (contacts) accessible by the user

`GET /api/account`

## Response `200`

OK

- AccountDTOExport[]
  - `contacts` ContactDTO[] — This is the primary contact for this account. All invoices and notifications will be sent to this contact.
    - `customFieldValues` CustomFieldValueDTO[]
      - `valueString` string — Used to set the value type for CustomField.ValueType of 'textBox', 'textEdit' and 'dropDownList'.
      - `valueNumber` number, double — Used to set the value type for CustomField.ValueType of 'number' and 'currency'.
      - `valueDateTime` string, date-time — Used to set the value type for CustomField.ValueType of 'dateTime' and 'date'.
      - `valueDateString` string — Returns a string date value used in the UI for Dates
      - `valueBoolean` boolean — Used to set the value type for CustomField.ValueType of 'checkbox'
      - `customFieldGuid` string, uuid, required — Used to set the reference in POST and PUTReferenced the custom field object for this value. Referenced the custom field object for this value.
      - `valueContact` ContactRef
        - `firstName` string
        - `lastName` string
        - `middleName` string
        - `accountName` string
        - `displayName` string
        - `guid` string, uuid
        - `email` string
    - `email` string
    - `mobile` string
    - `home` string
    - `office` string
    - `ext` string
    - `fax` string
    - `salutation` string
    - `position` string
    - `prefix` string
    - `isDeleted` boolean — 
    - `firstName` string
    - `lastName` string
    - `middleName` string
    - `accountName` string
    - `displayName` string
    - `guid` string, uuid
  - `website` string
  - `billingAddress` AddressDTO
    - `name` string — ie. Home / Office
    - `address1` string
    - `address2` string
    - `city` string
    - `state` string
    - `country` string
    - `postalCode` string
  - `name` string — Account (company) name
  - `currencyCode` string — This defines the currency for this account. Must be in ISO 4217 format. Invoices created for this account will use this currency. If null, defaults will be set.
  - `number` integer — Account number, must be unique.
  - `assignedTo` UserRef[] — The users this account (contact) is assigned to. For custom security roles this can define which users can access this account.
    - `guid` string, uuid
    - `displayName` string — 
    - `name` string — 
    - `timeZoneId` string
  - `assignedToGuids` string[], required — Used to set the reference in POST and PUTFor compatibility reasons, this will return an array of guids for the assigned to users instead of a list of UserRef objects. For compatibility reasons, this will return an array of guids for the assigned to users instead of a list of UserRef objects.
  - `primaryContact` ContactDTO
    - `customFieldValues` CustomFieldValueDTO[]
      - `valueString` string — Used to set the value type for CustomField.ValueType of 'textBox', 'textEdit' and 'dropDownList'.
      - `valueNumber` number, double — Used to set the value type for CustomField.ValueType of 'number' and 'currency'.
      - `valueDateTime` string, date-time — Used to set the value type for CustomField.ValueType of 'dateTime' and 'date'.
      - `valueDateString` string — Returns a string date value used in the UI for Dates
      - `valueBoolean` boolean — Used to set the value type for CustomField.ValueType of 'checkbox'
      - `customFieldGuid` string, uuid, required — Used to set the reference in POST and PUTReferenced the custom field object for this value. Referenced the custom field object for this value.
      - `valueContact` ContactRef
        - `firstName` string
        - `lastName` string
        - `middleName` string
        - `accountName` string
        - `displayName` string
        - `guid` string, uuid
        - `email` string
    - `email` string
    - `mobile` string
    - `home` string
    - `office` string
    - `ext` string
    - `fax` string
    - `salutation` string
    - `position` string
    - `prefix` string
    - `isDeleted` boolean — 
    - `firstName` string
    - `lastName` string
    - `middleName` string
    - `accountName` string
    - `displayName` string
    - `guid` string, uuid
  - `tags` TagDTO[] — Tags, Used in POST and PUT to modify account tags so make sure you include all tags.
    - `name` string, required
  - `tagNames` string[] — For compatibility reasons, this will return an array of tag names instead of a list of tag objects.
  - `createdDate` string, date-time — 
  - `lastModifiedDate` string, date-time — 
  - `paid` number, double — Total amount paid. Total amount paid.
  - `trustBalance` number, double — Trust account balance. Trust account balance.
  - `operatingBalance` number, double — Sum of OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds - Invoices.AmountDue Sum of OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds - Invoices.AmountDue
  - `billable` number, double — Total billable time entries, expenses and flat rates. Total billable time entries, expenses and flat rates.
  - `status` 'Active' | 'Archived'
  - `saleDocumentTemplateGuid` string, uuid — Used to set the reference in POST and PUT
  - `saleDocumentTemplateName` string
  - `contactInvoiceRecipients` ContactRef[]
    - `firstName` string
    - `lastName` string
    - `middleName` string
    - `accountName` string
    - `displayName` string
    - `guid` string, uuid
    - `email` string
  - `contactInvoiceRecipientsGuids` string[] — Used to set the reference in POST and PUT
  - `is1099Eligible` boolean
  - `taxId` string
  - `surchargesEnabled` boolean
  - `nameAndNumber` string — 
  - `guid` string, uuid
  - `utbmsIsEnabled` boolean
  - `id` integer

---

[API](https://skmtc.net/practicepanther/apis/legacy-api-v1.md) · [All operations](https://skmtc.net/practicepanther/apis/legacy-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/practicepanther/legacy-api-v1/revisions/a444c5b1e78b/schema)