Get File
curl --request GET \
--url https://app.withforerunner.com/api/v1/files/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.withforerunner.com/api/v1/files/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.withforerunner.com/api/v1/files/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.withforerunner.com/api/v1/files/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.withforerunner.com/api/v1/files/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.withforerunner.com/api/v1/files/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.withforerunner.com/api/v1/files/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"errors": [],
"file": {
"id": "f8a3b2c1-d4e5-4789-abcd-ef0123456789",
"url": "https://demoville.app.withforerunner.com/files/f8a3b2c1-d4e5-4789-abcd-ef0123456789",
"downloadURL": "https://demoville.app.withforerunner.com/view-file/f8a3b2c1-d4e5-4789-abcd-ef0123456789",
"publicURL": "https://demoville.withforerunner.com/view-file/f8a3b2c1-d4e5-4789-abcd-ef0123456789",
"filename": "123_main_st_ec.pdf",
"mimeType": "application/pdf",
"property": {
"id": "a1b2c3d4-e5f6-4890-abcd-ef0123456789",
"address": "123 Main St, Springfield, IL 62701",
"publicURL": "https://demoville.withforerunner.com/properties/a1b2c3d4-e5f6-4890-abcd-ef0123456789",
"coordinates": [
39.7817,
-89.6501
],
"parcel": {
"id": "f1e2d3c4-b5a6-4890-8cba-098765432109",
"address": "123 Main St, Springfield, IL 62701",
"parcelId": "12-34-567-890"
}
}
}
}{
"errors": [
{
"message": "Invalid UUID format for id parameter",
"field": "id"
}
],
"file": null
}Files
Get File
Returns a single file’s metadata by its Forerunner UUID, along with the property it is attached to.
This is the metadata only, not the file itself — download the contents from downloadURL or publicURL.
GET
/
api
/
v1
/
files
/
{id}
Get File
curl --request GET \
--url https://app.withforerunner.com/api/v1/files/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.withforerunner.com/api/v1/files/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.withforerunner.com/api/v1/files/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.withforerunner.com/api/v1/files/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.withforerunner.com/api/v1/files/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.withforerunner.com/api/v1/files/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.withforerunner.com/api/v1/files/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"errors": [],
"file": {
"id": "f8a3b2c1-d4e5-4789-abcd-ef0123456789",
"url": "https://demoville.app.withforerunner.com/files/f8a3b2c1-d4e5-4789-abcd-ef0123456789",
"downloadURL": "https://demoville.app.withforerunner.com/view-file/f8a3b2c1-d4e5-4789-abcd-ef0123456789",
"publicURL": "https://demoville.withforerunner.com/view-file/f8a3b2c1-d4e5-4789-abcd-ef0123456789",
"filename": "123_main_st_ec.pdf",
"mimeType": "application/pdf",
"property": {
"id": "a1b2c3d4-e5f6-4890-abcd-ef0123456789",
"address": "123 Main St, Springfield, IL 62701",
"publicURL": "https://demoville.withforerunner.com/properties/a1b2c3d4-e5f6-4890-abcd-ef0123456789",
"coordinates": [
39.7817,
-89.6501
],
"parcel": {
"id": "f1e2d3c4-b5a6-4890-8cba-098765432109",
"address": "123 Main St, Springfield, IL 62701",
"parcelId": "12-34-567-890"
}
}
}
}{
"errors": [
{
"message": "Invalid UUID format for id parameter",
"field": "id"
}
],
"file": null
}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.
Path Parameters
UUID of the resource in Forerunner.
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.
Show child attributes
Show child attributes
Example:
[]
The requested file. Null when no file matched the id.
Show child attributes
Show child attributes
Was this page helpful?