List Files
Returns files of a single document type, 25 per page, ordered by filename.
When you are displaying files on a public site, pass hiddenFromPublic=false so you only receive files approved for public display.
Elevation Certificates appear here only once processing has finished. A certificate that is still processing, or that was canceled, is absent, so do not read an empty result straight after an upload as a failed upload.
Authorizations
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
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.
"Elevation Certificate"
1-based page number. List endpoints return 25 results per page.
x >= 11
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.
true, false 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.
"EC-2024-0417"
Response
Success. errors is empty.
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.
Up to 25 files for the requested page.
Pagination metadata for a list response. Present whenever the request succeeded, and omitted when it failed validation.