Skip to main content
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"
}
'
{
  "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>"
}

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
​
report_id
string<uuid>
required

The report ID this showing belongs to

​
showing_date
string<date-time>

Date and time of the showing

​
scheduled_date
string<date-time>

Scheduled date and time of the showing

​
attendee_name
string
​
attendee_email
string<email>
​
attendee_phone
string
​
agent_name
string
​
feedback
string
​
rating
integer
Required range: 1 <= x <= 5
​
interested
boolean
​
event_type
enum<string>
default:showing
Available options:
showing,
open_house
​
title
string
​
attendees_count
integer
default:1
​
unique_showing_key
string

Unique identifier for the showing event from external systems. Used for deduplication and integration purposes.

​
showing_time_start
string<date-time>

Start time of the showing event. Used for API entries to specify exact start time.

​
showing_time_end
string<date-time>

End time of the showing event. Used for API entries to specify exact end time.

Response

Showing created successfully

​
data
object
​
message
string