---
title: "List accounts of customer"
method: GET
path: "/accounts"
tags: ["Accounts"]
---

# List accounts of customer

`GET /accounts`

## Request

- Base URL: `https://api.togai.com`
- URL: `https://api.togai.com/accounts`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/togaihq/apis/togai-apis/docs/accounts/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of accounts of a customer with pagination and sort.

## Query parameters

- `nextToken` string
- `pageSize` number

## Response `200`

Response for list customers request

- AccountPaginatedResponse
  - `data` Account[]
    - `id` string, required: Identifier of the account
    - `togaiAccountId` string, required: Unique identifier of the account
    - `togaiCustomerId` string, required: Unique identifier of the customer
    - `name` string, required: Name of the Account
    - `customerId` string, required: Identifier of the customer
    - `invoiceCurrency` string: [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency in which the account must be invoiced Defaults to Base currency.
    - `aliases` object[]: list of aliases of the account
      - `alias` string
    - `netTermDays` integer
    - `address` Address: billing address of the customer
      - `phoneNumber` string: Contact number
      - `line1` string: Address line 1 (eg. Street, PO Box, Company Name)
      - `line2` string: Address line 2 (eg. apartment, suite, unit or building)
      - `postalCode` string: ZIP or postal code
      - `city` string: City, district, suburb, town or village
      - `state` string: State, county, province or region
      - `country` string: Two letter country code [ISO-3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
    - `primaryEmail` string: Primary email of the customer
    - `status` 'ACTIVE' | 'DRAFT' | 'ARCHIVED', required: Status of the account
    - `settings` CreateEntitySetting[]
      - `id` string, required
      - `value` string, required
      - `namespace` string, required
      - `name` string, required
      - `dataType` 'STRING' | 'NUMERIC' | 'JSON' | 'JSON_LOGIC', required
    - `invoiceGroupDetails` InvoiceGroupDetails: Invoice group details
      - `id` string, required
      - `name` string, required
      - `email` string, required
      - `dailyInvoiceConsolidation` boolean, required
      - `netTermDays` integer
      - `invoiceCurrency` string, required
      - `billingAddress` Address, required: billing address of the customer
        - `phoneNumber` string: Contact number
        - `line1` string: Address line 1 (eg. Street, PO Box, Company Name)
        - `line2` string: Address line 2 (eg. apartment, suite, unit or building)
        - `postalCode` string: ZIP or postal code
        - `city` string: City, district, suburb, town or village
        - `state` string: State, county, province or region
        - `country` string: Two letter country code [ISO-3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
    - `metadata` object: Additional information associated with the account. Example: GSTN, VATN
    - `tags` string[]: Tag for accounts are stored in lowercase
  - `nextToken` string
  - `context` PaginationOptions
    - `pageSize` integer
    - `sortOrder` 'ASC' | 'DESC'

## Other responses

- `400`: Error response
- `401`: Error response
- `403`: Error response
- `404`: Error response
- `429`: Error response
- `default`: Error response

## Changes

- **2024-03-18** `3135bb8c67b3`: 1 info
  - added the optional property `data/items/netTermDays` to the response with the `200` status
- **2024-03-01** `6fb940b0dad9`: 2 breaking, 1 warning, 3 info
  - the response property `data/items/invoiceCurrency` became optional for the status `200`
  - the `data/items/primaryEmail` response property's maxLength was increased from `255` to `320` for the response status `200`
  - added the new `DRAFT` enum value to the `data/items/status` response property for the response status `200`
  - added the optional property `data/items/tags` to the response with the `200` status
  - …2 more
- **2023-11-30** `b3351be4b462`: 1 warning
  - removed the optional property `data/items/aliases/items/status` from the response with the `200` status
- **2023-11-03** `a6c96c5ec06e`: 3 info
  - added the optional property `data/items/address/phoneNumber` to the response with the `200` status
  - added the optional property `data/items/invoiceGroupDetails/billingAddress/phoneNumber` to the response with the `200` status
  - added the optional property `data/items/metadata` to the response with the `200` status
- **2023-09-25** `ae3b70608528`: 2 info
  - added the optional property `data/items/address` to the response with the `200` status
  - added the optional property `data/items/primaryEmail` to the response with the `200` status

[Operation history](https://skmtc.dev/togaihq/apis/togai-apis/changes/accounts/get.md)

---

[API](https://skmtc.dev/togaihq/apis/togai-apis.md) - [All operations](https://skmtc.dev/togaihq/apis/togai-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/togaihq/apis/togai-apis/revisions/442f5d8f4aa0?raw)