Skip to main content
POST
/
v1
/
reports
Create a new report
curl --request POST \
  --url https://api.northreports.com/v1/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "456 Oak Avenue",
  "city": "Austin",
  "state": "TX",
  "zip": "78704",
  "price": 525000,
  "beds": 4,
  "baths": 2.5,
  "sqft": 2200,
  "year_built": 2015,
  "property_type": "Single Family",
  "description": "Beautiful home with modern updates",
  "listing_agent": "John Smith",
  "created_by": "Jane Doe",
  "custom_agent_name": "Jane Doe",
  "custom_agent_email": "[email protected]"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "price": 123,
    "bedrooms": 123,
    "bathrooms": 123,
    "square_feet": 123,
    "date_created": "2023-11-07T05:31:56Z",
    "listing_agent": "<string>",
    "created_by": "<string>",
    "custom_agent_name": "<string>",
    "status": "<string>",
    "is_draft": true,
    "is_published": true
  },
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Authorization: Bearer north_sk_live_xxxxxxxxxxxx

Body

application/json
​
address
string
required

Property street address

​
city
string
​
state
string
​
zip
string
​
price
number

Listing price in dollars

​
beds
integer
​
baths
number
​
sqft
integer
​
year_built
integer
​
property_type
string

e.g., "Single Family", "Condo", "Townhouse"

​
lot_size
number
​
description
string
​
zpid
string

Zillow property ID

​
zillow_url
string<uri>
​
mls_id
string
​
status
string
default:For Sale
​
is_draft
boolean
default:true
​
custom_agent_name
string
​
custom_agent_email
string<email>
​
custom_agent_phone
string
​
listing_agent
string

Name of the listing agent. If not provided, defaults to the team admin/account owner's name.

​
created_by
string

Name of the person who created the report. If not provided, defaults to the team name (from the team associated with the API key).

​
custom_logo_url
string<uri>
​
primary_brand_color
string

Hex color code

​
secondary_brand_color
string

Hex color code

Response

Report created successfully

​
data
object
​
message
string