HomeGuidesAPI ReferenceChangelog
Log In
API Reference
Start typing to search…

List Files

get https://api.arcadia.com/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.

Log in to see full request history
Query Params
string

A search query string. See this page for more information.

The searchable fields for this endpoint are:

  • accountNumbers
  • correlationId
  • createdAt
  • fileId
  • fileName
  • normalizedAccountNumbers
  • organizationId
  • provider.name
  • statementId
  • status
  • statusDetails
string

A global search query string. See this page for more information.

integer
Defaults to 0

Zero-based page index (0..N)

integer
Defaults to 20

The size of the page to be returned

sort
array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort
Headers
string
required
Defaults to 2024-02-21

The Arcadia-Version for the request

Response

Response body
object
files
array of objects
required
files*
object
accountNumbers
array of strings
required

An array of account identifiers provided by the commodity provider (often times the bill publisher).

accountNumbers*
string | null
required

A string value you can set to help you reconcile with your internal systems.

date-time
required

A timestamp indicating when the entity was created.

string
required

User or system responsible for creating the entity.

string
required

The name of the file when it was originally submitted.

string
required

A unique identifier for the entity.

boolean
required

Indicates whether any action is required from you regarding this resource.

date-time
required

The timestamp indicating when this resource was last modified.

object | null
required

The entity providing service and issuing bills (informally known as a utility).

date | null
required

The date of the statement.

string | null
required

The unique identifier of a statement.

string
required

Status of the resource.

QUEUED FAILURE IN_PROGRESS COVERAGE_REQUEST SUCCESS

statusDetails
array of strings
required

Reasons the resource has the current status.

statusDetails*
string
required

Indicates the method you used to send data to us.

CLIENT API EMAIL SFTP WEB_NAVIGATION_OCR

page
object
required

Specifies which page of results to return; this is 0-indexed

int64
required
int64
required
int64
required
int64
required

Updated about 2 months ago

Did this page help you?
Language
Credentials
OAuth2

Updated about 2 months ago

Did this page help you?