---
title: "List Files"
method: GET
path: "/plug/files"
tags: ["Files"]
---

# List Files

`GET /plug/files`

A file is a utility statement PDF uploaded for OCR processing on the Arcadia Platform. This endpoint allows you to get a list of all the files that are in the system. This endpoint is pageable.

## Query parameters

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

## Headers

- `Arcadia-Version` string, required

## Response `200`

OK

- PagedPublicFileResource
  - `files` PublicFileResource[], required
    - `accountNumbers` string[], required — An array of account identifiers provided by the commodity provider (often times the bill publisher).
    - `correlationId` string, nullable, required — A string value you can set to help you reconcile with your internal systems.
    - `createdAt` string, date-time, required — A timestamp indicating when the entity was created.
    - `createdBy` string, required — User or system responsible for creating the entity.
    - `discoveredStatementId` string, nullable, required — The unique identifier for the discovered statement in the Arcadia platform.
    - `fileName` string, required — The name of the file when it was originally submitted.
    - `id` string, required — A unique identifier for the entity.
    - `isCustomerActionRequired` boolean, required — Indicates whether any action is required from you regarding this resource.
    - `lastModifiedAt` string, date-time, required — The timestamp indicating when this resource was last modified.
    - `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.
    - `statementDate` string, date, nullable, required — The date of the statement.
    - `statementId` string, nullable, required — The unique identifier of a statement.
    - `status` 'QUEUED' | 'FAILURE' | 'IN_PROGRESS' | 'COVERAGE_REQUEST' | 'SUCCESS', required — Status of the resource.
    - `statusDetails` string[], required — Reasons the resource has the current status.
    - `transferMethod` 'CLIENT' | 'API' | 'EMAIL' | 'SFTP' | 'WEB_NAVIGATION_OCR', required — Indicates the method you used to send data to us.
  - `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)