---
title: "GET /policy/{tenantLocator}/accounts/list"
method: GET
path: "/policy/{tenantLocator}/accounts/list"
---

# GET /policy/{tenantLocator}/accounts/list

`GET /policy/{tenantLocator}/accounts/list`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/policy/{tenantLocator}/accounts/list`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/policy/:tenantLocator/accounts/list/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required

## Query parameters

- `offset` integer
- `count` integer

## Response `200`

OK

- AccountListResponse
  - `listCompleted` boolean, required
  - `items` AccountResponse[], required
    - `locator` string, ulid, required
    - `type` string, required: One of the configured Account Types
    - `accountState` 'draft' | 'validated' | 'discarded', required
    - `data` object, required
    - `createdAt` string, date-time, required
    - `createdBy` string, uuid, required
    - `delinquencyPlanName` string
    - `shortfallTolerancePlanName` string
    - `autoRenewalPlanName` string
    - `excessCreditPlanName` string
    - `preferences` Preferences
      - `installmentPreferences` InstallmentPreferences
        - `cadence` 'none' | 'fullPay' | 'weekly' | 'everyOtherWeek' | 'monthly' | 'quarterly' | 'semiannually' | 'annually' | 'thirtyDays' | 'everyNDays'
        - `anchorMode` 'generateDay' | 'termStartDay' | 'dueDay'
        - `generateLeadDays` integer
        - `dueLeadDays` integer
        - `installmentWeights` number[], required
        - `maxInstallmentsPerTerm` integer
        - `installmentPlanName` string
        - `anchorType` 'none' | 'dayOfMonth' | 'anchorTime' | 'dayOfWeek' | 'weekOfMonth'
        - `dayOfMonth` integer
        - `dayOfWeek` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
        - `weekOfMonth` 'none' | 'first' | 'second' | 'third' | 'fourth' | 'fifth'
        - `anchorTime` string, date-time
        - `autopayLeadDays` number
    - `validationResult` ValidationResult
      - `validationItems` ValidationItemResponse[]
        - `elementType` string, required
        - `locator` string, ulid, required
        - `errors` string[], required
      - `success` boolean, required
    - `billingLevel` 'account' | 'inherit' | 'policy', required
    - `invoicingPlanName` string
    - `region` string
    - `invoiceDocument` string
    - `timezone` string
    - `accountNumber` string, required
    - `contacts` ContactRoles[], required
      - `contactLocator` string, ulid, required
      - `roles` string[], required
    - `anonymizedAt` string, date-time
    - `paymentExecutionRetryPlanName` string

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/6537d24b3693?raw)