Skip to main content
​
GET
endpoint
/api/v1/files
Retrieve a paginated list of files filtered by type.

​
Query Parameters

​
fileType
string
required
Filter files by document type name. The value must match an existing document type name configured for your account (e.g., Elevation Certificate, Building Permit). Contact your CS rep for available document types.
​
externalSystemId
string
Find file via it’s externalSystemId. Since this value is unique, this will return exactly zero or one entry in the files array. externalSystemId can be set via the Submit File or Update File API or through an integration with an external data source (such as Accela).
​
hiddenFromPublic
boolean
Filter by public visibility. true returns only private files, false returns only public files
​
page
integer
Page number for pagination. See Pagination.
If displaying Forerunner data on a publicly accessible website, set hiddenFromPublic=false to ensure you only retrieve files approved for public display.

​
Response

​
files
array
Array of file objects (up to 25 per page)
​
pageInfo
object
Pagination metadata. See Pagination.
​
errors
array
Array of error objects. See Errors.
curl "https://app.withforerunner.com/api/v1/files?fileType=Elevation%20Certificate&page=1" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "files": [
    {
      "id": "f8a3b2c1-d4e5-6789-abcd-ef0123456789",
      "filename": "123_main_st_ec.pdf",
      "mimeType": "application/pdf",
      "url": "https://app.withforerunner.com/files/f8a3b2c1-d4e5-6789-abcd-ef0123456789",
      "downloadURL": "https://app.withforerunner.com/files/f8a3b2c1-d4e5-6789-abcd-ef0123456789/download",
      "publicURL": "https://app.withforerunner.com/public/files/f8a3b2c1-d4e5-6789-abcd-ef0123456789",
      "property": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
        "address": "123 Main St, Springfield, IL 62701",
        "url": "https://app.withforerunner.com/properties/a1b2c3d4-e5f6-7890-abcd-ef0123456789",
        "publicURL": "https://app.withforerunner.com/public/properties/a1b2c3d4-e5f6-7890-abcd-ef0123456789",
        "coordinates": [39.7817, -89.6501],
        "parcel": {
          "id": "f1e2d3c4-b5a6-7890-dcba-098765432109",
          "parcelId": "12-34-567-890",
          "address": "123 Main St, Springfield, IL 62701"
        }
      }
    }
  ],
  "pageInfo": {
    "page": 1,
    "pageSize": 25,
    "totalCount": 67,
    "totalPages": 3
  },
  "errors": []
}