endpoint
/api/v1/files/:id
Path Parameters
string
required
The unique identifier of the file
Response
object
Show properties
Show properties
string
UUID uniquely identifying the file
string
Original filename when uploaded
string
File format type (e.g.,
application/pdf, image/png)string
URL for the file’s internal Forerunner page. Requires user authentication.
string
URL for direct file download. Requires authentication.
string
Public download page URL. Absent if the file is hidden from public.
object | null
Associated property. Null if the file is not linked to a property. See Property object for the object schema.
curl https://app.withforerunner.com/api/v1/files/f8a3b2c1-d4e5-6789-abcd-ef0123456789 \
-H "Authorization: Bearer YOUR_API_KEY"
{
"file": {
"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"
}
}
},
"errors": []
}