Skip to main content
GET
List Files

Authorizations

Authorization
string
header
required

Your account's API key, sent as Authorization: Bearer <your API key>. Keys are issued per environment, so a staging key will not work against production.

Query Parameters

fileType
string
required

Filter files by document type name, such as Elevation Certificate or Building Permit. Must match a document type configured for your account; see File types, or ask your customer success rep which are available.

Example:

"Elevation Certificate"

page
integer

1-based page number. List endpoints return 25 results per page.

Required range: x >= 1
Example:

1

hiddenFromPublic
enum<string>

true returns only files hidden from the public site, false only files visible on it. Omit to return both. Use false when displaying files publicly.

Available options:
true,
false
externalSystemId
string

Return only items your system recorded under this identifier. Files and SI/SD records enforce uniqueness, so those match at most one; Log records do not. It can be set when creating or updating the item, or by an integration with an external system such as Accela.

Example:

"EC-2024-0417"

Response

Success. errors is empty.

errors
object[]
required

Empty when the request succeeded. Otherwise one entry per failure, and the resource fields on the response are empty: null for single resources, [] for lists, with pageInfo omitted.

Example:
files
object[]
required

Up to 25 files for the requested page.

pageInfo
object

Pagination metadata for a list response. Present whenever the request succeeded, and omitted when it failed validation.

Example: