Create a new showing
curl --request POST \
--url https://api.northreports.com/v1/showings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"report_id": "550e8400-e29b-41d4-a716-446655440000",
"showing_date": "2024-01-20T14:00:00Z",
"attendee_name": "John Buyer",
"attendee_email": "[email protected]",
"attendee_phone": "(555) 123-4567",
"event_type": "showing",
"title": "Property Showing",
"unique_showing_key": "ext_12345"
}
'import requests
url = "https://api.northreports.com/v1/showings"
payload = {
"report_id": "550e8400-e29b-41d4-a716-446655440000",
"showing_date": "2024-01-20T14:00:00Z",
"attendee_name": "John Buyer",
"attendee_email": "[email protected]",
"attendee_phone": "(555) 123-4567",
"event_type": "showing",
"title": "Property Showing",
"unique_showing_key": "ext_12345"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
report_id: '550e8400-e29b-41d4-a716-446655440000',
showing_date: '2024-01-20T14:00:00Z',
attendee_name: 'John Buyer',
attendee_email: '[email protected]',
attendee_phone: '(555) 123-4567',
event_type: 'showing',
title: 'Property Showing',
unique_showing_key: 'ext_12345'
})
};
fetch('https://api.northreports.com/v1/showings', 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://api.northreports.com/v1/showings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'report_id' => '550e8400-e29b-41d4-a716-446655440000',
'showing_date' => '2024-01-20T14:00:00Z',
'attendee_name' => 'John Buyer',
'attendee_email' => '[email protected]',
'attendee_phone' => '(555) 123-4567',
'event_type' => 'showing',
'title' => 'Property Showing',
'unique_showing_key' => 'ext_12345'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.northreports.com/v1/showings"
payload := strings.NewReader("{\n \"report_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"showing_date\": \"2024-01-20T14:00:00Z\",\n \"attendee_name\": \"John Buyer\",\n \"attendee_email\": \"[email protected]\",\n \"attendee_phone\": \"(555) 123-4567\",\n \"event_type\": \"showing\",\n \"title\": \"Property Showing\",\n \"unique_showing_key\": \"ext_12345\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.northreports.com/v1/showings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"report_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"showing_date\": \"2024-01-20T14:00:00Z\",\n \"attendee_name\": \"John Buyer\",\n \"attendee_email\": \"[email protected]\",\n \"attendee_phone\": \"(555) 123-4567\",\n \"event_type\": \"showing\",\n \"title\": \"Property Showing\",\n \"unique_showing_key\": \"ext_12345\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.northreports.com/v1/showings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"report_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"showing_date\": \"2024-01-20T14:00:00Z\",\n \"attendee_name\": \"John Buyer\",\n \"attendee_email\": \"[email protected]\",\n \"attendee_phone\": \"(555) 123-4567\",\n \"event_type\": \"showing\",\n \"title\": \"Property Showing\",\n \"unique_showing_key\": \"ext_12345\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"north_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"showing_date": "2023-11-07T05:31:56Z",
"attendee_name": "<string>",
"attendee_email": "<string>",
"event_type": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"message": "<string>"
}{
"error": {
"message": "Address is required",
"status": 400
}
}{
"error": {
"message": "Invalid API key",
"status": 401
}
}{
"error": {
"message": "Permission denied: reports:create",
"status": 403
}
}{
"error": {
"message": "Rate limit exceeded. Please try again later.",
"status": 429
}
}Showings
Create Showing
Creates a new showing event for a report.
POST
/
v1
/
showings
Create a new showing
curl --request POST \
--url https://api.northreports.com/v1/showings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"report_id": "550e8400-e29b-41d4-a716-446655440000",
"showing_date": "2024-01-20T14:00:00Z",
"attendee_name": "John Buyer",
"attendee_email": "[email protected]",
"attendee_phone": "(555) 123-4567",
"event_type": "showing",
"title": "Property Showing",
"unique_showing_key": "ext_12345"
}
'import requests
url = "https://api.northreports.com/v1/showings"
payload = {
"report_id": "550e8400-e29b-41d4-a716-446655440000",
"showing_date": "2024-01-20T14:00:00Z",
"attendee_name": "John Buyer",
"attendee_email": "[email protected]",
"attendee_phone": "(555) 123-4567",
"event_type": "showing",
"title": "Property Showing",
"unique_showing_key": "ext_12345"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
report_id: '550e8400-e29b-41d4-a716-446655440000',
showing_date: '2024-01-20T14:00:00Z',
attendee_name: 'John Buyer',
attendee_email: '[email protected]',
attendee_phone: '(555) 123-4567',
event_type: 'showing',
title: 'Property Showing',
unique_showing_key: 'ext_12345'
})
};
fetch('https://api.northreports.com/v1/showings', 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://api.northreports.com/v1/showings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'report_id' => '550e8400-e29b-41d4-a716-446655440000',
'showing_date' => '2024-01-20T14:00:00Z',
'attendee_name' => 'John Buyer',
'attendee_email' => '[email protected]',
'attendee_phone' => '(555) 123-4567',
'event_type' => 'showing',
'title' => 'Property Showing',
'unique_showing_key' => 'ext_12345'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.northreports.com/v1/showings"
payload := strings.NewReader("{\n \"report_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"showing_date\": \"2024-01-20T14:00:00Z\",\n \"attendee_name\": \"John Buyer\",\n \"attendee_email\": \"[email protected]\",\n \"attendee_phone\": \"(555) 123-4567\",\n \"event_type\": \"showing\",\n \"title\": \"Property Showing\",\n \"unique_showing_key\": \"ext_12345\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.northreports.com/v1/showings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"report_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"showing_date\": \"2024-01-20T14:00:00Z\",\n \"attendee_name\": \"John Buyer\",\n \"attendee_email\": \"[email protected]\",\n \"attendee_phone\": \"(555) 123-4567\",\n \"event_type\": \"showing\",\n \"title\": \"Property Showing\",\n \"unique_showing_key\": \"ext_12345\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.northreports.com/v1/showings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"report_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"showing_date\": \"2024-01-20T14:00:00Z\",\n \"attendee_name\": \"John Buyer\",\n \"attendee_email\": \"[email protected]\",\n \"attendee_phone\": \"(555) 123-4567\",\n \"event_type\": \"showing\",\n \"title\": \"Property Showing\",\n \"unique_showing_key\": \"ext_12345\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"north_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"showing_date": "2023-11-07T05:31:56Z",
"attendee_name": "<string>",
"attendee_email": "<string>",
"event_type": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"message": "<string>"
}{
"error": {
"message": "Address is required",
"status": 400
}
}{
"error": {
"message": "Invalid API key",
"status": 401
}
}{
"error": {
"message": "Permission denied: reports:create",
"status": 403
}
}{
"error": {
"message": "Rate limit exceeded. Please try again later.",
"status": 429
}
}Authorizations
API key authentication. Include your API key in the Authorization header:
Authorization: Bearer north_sk_live_xxxxxxxxxxxx
Body
application/json
The report ID this showing belongs to
Date and time of the showing
Scheduled date and time of the showing
Required range:
1 <= x <= 5Available options:
showing, open_house Unique identifier for the showing event from external systems. Used for deduplication and integration purposes.
Start time of the showing event. Used for API entries to specify exact start time.
End time of the showing event. Used for API entries to specify exact end time.
⌘I