Skip to main content
GET
Read retained building permits
Read this account’s unexpired prop_shovels_ building-permit observations for1 credit. Requires the property_id returned by searchPermits;24h retention. Returns the retained permit rows — dates, status, job value, fees, tags and contractor id exactly as indexed by the provider. No fresh provider call and no re-billing of the permit records; expired or cross-account IDs return404. Provider-indexed filings only: not a complete permit history, and missing fields stay unknown.

Authorizations

x-api-key
string
header
required

Path Parameters

property_id
string
required
Minimum string length: 1

Query Parameters

limit
integer
default:1
Required range: 1 <= x <= 100
cursor
string
fields
string

Response-only comma-separated field paths relative to data items; up to 32 paths. Source requests and billing are unchanged.

Maximum string length: 4127
format
enum<string>
default:json

Response-only export format. JSON retains the envelope; CSV/NDJSON contain data records, with request/credit metadata in headers. Errors stay JSON.

Available options:
json,
csv,
ndjson

Response

Successful response; meta discloses source completeness

data
object[]
required
meta
object
required