Skip to main content
GET
/
v1
/
showings
List all showings
curl --request GET \
  --url https://api.northreports.com/v1/showings \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "north_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "showing_date": "2023-11-07T05:31:56Z",
      "scheduled_date": "2023-11-07T05:31:56Z",
      "attendee_name": "<string>",
      "attendee_email": "<string>",
      "attendee_phone": "<string>",
      "agent_name": "<string>",
      "feedback": "<string>",
      "rating": 3,
      "interested": true,
      "event_type": "showing",
      "title": "<string>",
      "attendees_count": 0,
      "unique_showing_key": "<string>",
      "showing_time_start": "2023-11-07T05:31:56Z",
      "showing_time_end": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

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

Authorization: Bearer north_sk_live_xxxxxxxxxxxx

Query Parameters

​
report_id
string<uuid>

Filter by specific report ID

​
limit
integer
default:50

Maximum number of showings to return

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

Number of showings to skip for pagination

Required range: x >= 0

Response

Successfully retrieved showings

​
data
object[]
​
total
integer
​
limit
integer
​
offset
integer