Skip to main content
GET
List all reports

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header:

Query Parameters

limit
integer
default:50

Maximum number of reports to return (ignored when address is provided)

Required range: 1 <= x <= 100
offset
integer
default:0

Number of reports to skip for pagination (ignored when address is provided)

Required range: x >= 0
status
enum<string>

Filter by report status (ignored when address is provided)

Available options:
draft,
published,
all
address
string

Search for a specific report by address. When provided, returns a single matching report as { data: <report> } (not a paginated list). Takes priority over all other filters. Supports partial matching (case-insensitive) with automatic abbreviation handling. Example: "123 Main St", "456 Oak Avenue", or just "Main Street"

Response

Successfully retrieved reports.

  • Without address: Returns a paginated list { data: [...], total, limit, offset }
  • With address: Returns a single report { data: { id, address, ... } }
data
object[]
total
integer
limit
integer
offset
integer