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

# List Accounts

`GET /plug/accounts`

Get a list of accounts in the Arcadia system. This endpoint is pageable. If your organization does not have the Intervals product enabled and if the account is not activated, you will see limited detailed data returned.

This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing).

## Query parameters

- `search` string
- `globalSearch` string
- `page` integer
- `size` integer
- `sort` string[]

## Headers

- `Arcadia-Version` string, required

## Response `200`

OK

- PagedPublicAccountResource
  - `accounts` PublicAccountResource[], required — An array of the accounts that satisfied the search criteria
    - `accountNumber` string, required — An account identifier provided by the commodity provider (often times the bill publisher).
    - `billingCycle` 'MONTHLY' | 'BIMONTHLY' | 'QUARTERLY' | 'TRIANNUALLY' | 'HALF_YEARLY' | 'YEARLY' | 'ABNORMAL', nullable, required — The expected billing cycle. Determined by the service period of the most recent Statement.
    - `correlationIds` string[], required — A list of correlationIds cascaded from all directly associated Credentials and Files.
    - `createdAt` string, date-time, required — A timestamp indicating when the entity was created.
    - `createdBy` string, nullable, required — User or system responsible for creating the entity.
    - `customData` PublicCustomDataResource, required — You can use these fields to specify additional metadata.
    - `firstExtractedAt` string, date-time, nullable, required — The timestamp for when data was first extracted for the account.
    - `id` string, required — A unique identifier for the entity.
    - `isAccessible` boolean, required — Indicates whether the Account has at least one Credential associated with it in an accessible status detail.
    - `isCustomerActionRequired` boolean, required — Indicates whether any action is required from you regarding this resource.
    - `isHistoryFulfilled` boolean, required — If true, all Statement Gaps for this Account are `EXPECTED`, or Statement Gaps are not applicable for the Account, such as summary Accounts or Accounts without any `CORE` `serviceTypeClassification` Meters. If false, there is at least one Statement Gap that is not `EXPECTED` or the gaps are pending computation.
    - `isIntervalsThirdPartyPortalAccount` boolean, required — Indicates whether or not this account is enrolled under an intervals third party portal.
    - `isStatementsProductActive` boolean, required — Indicates whether the Plug Statements product is active for this account.
    - `lastModifiedAt` string, date-time, nullable, required — The timestamp indicating when this resource was last modified.
    - `lastModifiedBy` string, nullable, required — The user or system that last modified this resource.
    - `lastSuccessfulStatementExtractionAt` string, date-time, nullable, required — The timestamp indicating the most recent successful data extraction.
    - `latestNewStatementAt` string, date-time, nullable, required — The timestamp indicating the most recent new statement received for the account.
    - `latestStatementDate` string, date, nullable, required — The date of the most recent statement.
    - `nextExpectedPostDate` string, date, nullable, required — The date we expect to see a new statement for this account.
    - `normalizedAccountNumber` string, required — The normalized version of the account number (removing things like hyphens, underscores, and leading zeros).
    - `prepaid` boolean, required — Indicates whether the account operates on a prepaid basis, where services are paid for in advance.
    - `provider` PublicProviderResource, nullable, required — The entity providing service and issuing bills (informally known as a utility).
      - `country` string, nullable, required — The country associated with the billing address.
      - `id` string, required — A unique identifier for the entity.
      - `intervalServiceTypes` string[], required — List of interval service types supported by this provider (e.g., ['electric', 'gas'])
      - `isIntervalDataSupported` boolean, nullable, required — Indicates whether the provider supports interval data
      - `isIntervalFileUploadSupported` boolean, nullable, required — Indicates whether the provider supports interval file upload
      - `isRealTimeCredentialValidationSupported` boolean, required — Indicates whether the provider supports credential validation
      - `name` string, nullable, required — The name of the utility service provider.
    - `providerClassification` 'PUBLISHER' | 'PASS_THROUGH', nullable, required — Indicates whether this account is associated with the publisher or pass-through provider on the bill.
    - `serviceTypes` PublicServiceTypeResource[], required — An array of all types of service supported, such as electricity, water, or gas.
      - `serviceType` string, required — The type of service supported, such as electricity, water, or gas.
      - `serviceTypeClassification` 'CORE' | 'SUPPLEMENTAL', required — The classification for the service type depending on the comprehensiveness of data that can be returned.
    - `siteNames` string[], required — An array of names for Sites.
    - `status` 'NEW_ACCOUNT' | 'CONNECTION_SUCCESS' | 'CONNECTION_IN_PROGRESS' | 'DATA_ACCESS_FAILURE' | 'INACTIVE' | 'CONNECTION_DEACTIVATED', required — Status of the resource.
    - `statusDetail` 'DATA_ACCESSIBLE' | 'ISSUE_UNDER_REVIEW' | 'CREDENTIAL_ISSUE' | 'NO_DATA_AVAILABLE' | 'NO_BILLS_DISCOVERED_AFTER_MOST_RECENT_NEXT_EXPECTED_POST_DATE' | 'NO_BILLS_DISCOVERED_AFTER_FINAL_BILL_NOTICE' | 'EMAIL_APPROVAL' | 'UNSUCCESSFUL_EMAIL_APPROVAL' | 'USER_REVOKED_ACCESS' | 'STATEMENT_EXTRACTION_NOT_REQUESTED', required — Reason the resource has the current status.
    - `summaryAccountId` string, nullable, required — The unique identifier of the summary account.
    - `summaryAccountNumber` string, nullable, required — The number or identifier assigned to the summary account by the provider.
    - `totalMeters` integer, required — Total number of meters associated with this account.
    - `type` 'NORMAL' | 'SUMMARY' | 'SUB_ACCOUNT', required — Indicates the type of the account.
    - `voidedAt` string, date-time, nullable, required — A timestamp indicating when the entity was voided. This value resets to null if the entity is unvoided. See event history for additional context.
  - `page` PageMetadata, required — Specifies which page of results to return; this is 0-indexed
    - `number` integer, required
    - `size` integer, required
    - `totalElements` integer, required
    - `totalPages` integer, required

---

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