Showami (1.0)

Download OpenAPI specification:

License: Showami Terms of Service

The Showami API for creating, accepting, and updating showings and rentals.

API key access levels

Every request must include an X-Api-Key header. Keys are issued at one of two access levels:

Full access — can read and modify resources via any HTTP method.
Read-only — restricted to GET, HEAD, and OPTIONS requests. Any request using another method is rejected with 403 Forbidden and the body { "message": "Read-only API keys cannot modify resources." }. Use a read-only key for integrations that only need to pull data (reporting, dashboards, audits). The sign-in endpoints (POST /api/v1/users/tokens and POST /users/sign_in) are allowlisted so the key bearer can still exchange credentials for a user token.

Authentication

Authenticate with Showami

Authenticate with API

Use email/password to generate an Access Token and Refresh Token.

NOTE: this route is not in the /api/v1 namespace. You must send an application/json request to https://showami.com/users/sign_in

Request Body schema: application/json
required

object

email	string
password	string

Responses

Response Schema: application/json

access_token	string Access Tokens expire 24 hours after issue
refresh_token	string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"user": {"email": "[email protected]",
"password": "some_secure_password"
}
}

Response samples

Content type

application/json

{"access_token": "lmn456",
"refresh_token": "xyz890"
}

Refresh Access Token

Generate fresh Access Token from valid Refresh Token. This also cycles the Refresh token and returns a new one.

Request Body schema: application/json
required

refresh_token

string

Responses

Response Schema: application/json

access_token	string Access Tokens expire 24 hours after issue
refresh_token	string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"refresh_token": "abc123"
}

Response samples

Content type

application/json

{"access_token": "lmn456",
"refresh_token": "xyz890"
}

Showings

API endpoints related to Showings

Accepted Showings

Get a list of all Showings where the authenticated user is the Showing Agent.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Responses

Response Schema: application/json

Array

integer

The id of the showing

showing_request_id

integer

The id of the showing request

showing_at

string

The date and time of the showing

duration

number

The duration of the showing

mls

string

The MLS number of the showing

notes

string

The private notes of the showing (visible to only the initiating agent and showing agent)

public_notes

string

The public notes of the showing

access_information

string

Instructions for accessing the property.

showing_group

string

The id of the showing group

buyer_name

string

The name of the buyer

buyer_phone

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

string

Enum: "individual" "couple" "family"

The type of buyer

buyer_external_id

string

An external identifier for the buyer from the calling/external system

price

integer

The price of the showing

payout

integer

The payout of the showing

paid_group_amount

integer

The total payout amount of all showings in the group

tip

integer

The tip of the showing

status

string

Enum: "unassigned" "unconfirmed" "confirmed" "completed" "cancelled" "expired" "no_show" "processing_payment" "paid" "cancelled_with_payment" "unassigned_with_preferred" "refunded" "in_progress" "closed_without_payment"

The status of the showing

who_cancelled

string

Enum: "SA" "BA"

Which user cancelled the showing

cancellation_notes

string

The notes of the cancellation

reposted

boolean

The reposted status of the showing

message_count

integer

The message count of the showing

counter_proposal_count

integer

The counter proposal count of the showing

reschedulable

boolean

If the showing is rescheduleable or not

rescheduling_requested

boolean

If the a showing rescheduling is requested or not

repostable

boolean

If the showing is repostable or not

counter_proposable

boolean

If the showing is counter proposable or not

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the showing

schedule_details

string

The details of the schedule

amendable

boolean

If the showing is amendable or not

outstanding_amendment

boolean

If the showing has an outstanding amendment or not

review_allowed

boolean

If the showing is reviewable or not

no_show_eligible

boolean

If the showing is no show eligible or not

showing_type

string

The type of showing

original_showing_id

integer

The id of the original showing

external_id

string

The external id of the showing

external_app_url

string

A link into the calling/external app for this showing. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

nar_buyer_agreement

boolean

The nar buyer agreement status of the showing

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object (ShowingAgentResponse)

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Array of objects (Tenant)

The additional tenants on a rental or rental open house showing. Use a tenant's id to remove it via the Remove Tenant from Rental endpoint. Empty for showing types that do not support additional tenants.

Array

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Response samples

Content type

application/json

[{"id": 123,
"showing_request_id": 456,
"showing_at": "2020-10-22T13:00:00.000-06:00",
"duration": 2.5,
"mls": "12120009",
"notes": "Here are the details...",
"public_notes": "We're looking for you to do the following...",
"access_information": "Lockbox code 1234, call (555) 123-4567 on arrival",
"showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
"buyer_name": "Sally Ride",
"buyer_phone": 7205551234,
"buyer_type": "individual",
"buyer_external_id": "buyer-abc-123",
"price": 100,
"payout": 79,
"paid_group_amount": 158,
"tip": 10,
"status": "unassigned",
"who_cancelled": "SA",
"cancellation_notes": "The showing was cancelled because...",
"reposted": true,
"message_count": 0,
"counter_proposal_count": 0,
"reschedulable": true,
"rescheduling_requested": true,
"repostable": true,
"counter_proposable": true,
"who_schedules": "showing_agent",
"schedule_details": "The showing has already been scheduled, the code is...",
"amendable": true,
"outstanding_amendment": true,
"review_allowed": true,
"no_show_eligible": true,
"showing_type": "standard",
"original_showing_id": 111,
"external_id": "abc-123",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"nar_buyer_agreement": true,
"address": {"id": 123,
"line1": "123 Main St",
"line2": "Apt 1",
"city": "Denver",
"state": "CO",
"zip": "80202",
"latitude": 39.7392358,
"longitude": -104.990251
},
"user": {"id": 456,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent": {"id": 123,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent_cancellation": {"id": 123,
"showing_id": 456,
"reason": "unavailable",
"cancel_type": "cancel_one",
"notes": "I have a scheduling conflict",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"initiating_agent_cancellation": {"id": 123,
"showing_id": 456,
"cancel_type": "cancel_one",
"notes": "The buyer is no longer interested",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"showing_issues": [{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}
],
"tenants": [{"id": 123,
"full_name": "Christopher Robbins",
"phone": 7205551234,
"tenant_type": "individual"
}
]
}
]

Create Showing(s)

Create a new Showing or multiple Showings

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

object (ShowingRequest)

showing_type

required

integer

0 - standard, 1 - open_house, 2 - inspection, 3 - appraisal, 4 - rental, 5 - rental_open_house, 8 - property_data_collection. Note, the exact string value are also accepted.

buyer_name

required

string

The buyer's name

buyer_phone

required

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

required

integer

0 - individual, 1 - couple, 2 - family

buyer_external_id

string

An external identifier for the buyer from the calling/external system

met_buyer

integer

0 - unknown, 1 - no, 2 - yes

price

required

integer

The amount willing to pay for each showing in the group

notes

string <= 2000 characters

Private Showing notes visible to the accepting Showing Agent.

public_notes

string <= 2000 characters

Public Showing notes visible to all users.

nar_buyer_agreement

boolean

true - yes, the buyer has a NAR buyer agreement, false - no the buyer does not have a NAR buyer agreement, null - it is unknown or undisclosed if the buyer has a NAR buyer agreement

preferred_agent_1_email

string

preferred_agent_2_email

string

preferred_agent_3_email

string

access_information

required

string

How to access the property (Open House, Inspection, Appraisals only). In responses, for brokerage-organization users, URLs and North American phone numbers are auto-wrapped in <a> tags (HTML is sanitized); other users receive raw text.

time_zone

string

The timezone of the showing - 'Alaska', 'Arizona', 'Central Time (US & Canada)', 'Eastern Time (US & Canada)', 'Hawaii', 'Indiana (East)', 'Mountain Time (US & Canada)', 'Pacific Time (US & Canada)'

external_app_url

string

A link into the calling/external app for this showing request. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

object (ShowingRequestPropertyWrapper)

object (ShowingRequestProperty)

showing_at(1i) required	string The year of the showing
showing_at(2i) required	string The month of the showing
showing_at(3i) required	string The day of the showing
showing_at(4i) required	string The hour of the showing
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing
duration	number The length of the appointment in hours (Open House, Inspection, Appraisals only)
mls	string The MLS identifier of the property, if available
line1 required	string
line2	string
city required	string
state required	string
zip required	string
who_schedules required	integer 0 - showing_agent, 1 - buyers_agent
schedule_details	string
external_id	string An id to associate with the showing from the calling/external system

object (ShowingRequestProperty)

showing_at(1i) required	string The year of the showing
showing_at(2i) required	string The month of the showing
showing_at(3i) required	string The day of the showing
showing_at(4i) required	string The hour of the showing
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing
duration	number The length of the appointment in hours (Open House, Inspection, Appraisals only)
mls	string The MLS identifier of the property, if available
line1 required	string
line2	string
city required	string
state required	string
zip required	string
who_schedules required	integer 0 - showing_agent, 1 - buyers_agent
schedule_details	string
external_id	string An id to associate with the showing from the calling/external system

Responses

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"showing_request": {"showing_type": 0,
"buyer_name": "Christopher Robbins",
"buyer_phone": 7205551234,
"buyer_type": 0,
"buyer_external_id": "buyer-abc-123",
"met_buyer": 0,
"price": 0,
"notes": "Private Showing notes visible to the accepting Showing Agent",
"public_notes": "Public Showing notes visible to all users",
"nar_buyer_agreement": true,
"preferred_agent_1_email": "string",
"preferred_agent_2_email": "string",
"preferred_agent_3_email": "string",
"access_information": "How to access the property (Open House, Inspection, Appraisals only)",
"time_zone": "Mountain Time (US & Canada)",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"showing_request_properties_attributes": {"0": {"showing_at(1i)": "2023",
"showing_at(2i)": "12",
"showing_at(3i)": "30",
"showing_at(4i)": "16",
"showing_at(5i)": "0",
"duration": 1.5,
"mls": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"who_schedules": 0,
"schedule_details": "string",
"external_id": "string"
},
"1": {"showing_at(1i)": "2023",
"showing_at(2i)": "12",
"showing_at(3i)": "30",
"showing_at(4i)": "16",
"showing_at(5i)": "0",
"duration": 1.5,
"mls": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"who_schedules": 0,
"schedule_details": "string",
"external_id": "string"
}
}
}
}

Response samples

Content type

application/json

{"message": "string"
}

Accepted Showing by Id

Get the details of a showing where the user is the Showing Agent.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id

required

integer

Responses

Response Schema: application/json

integer

The id of the showing

showing_request_id

integer

The id of the showing request

showing_at

string

The date and time of the showing

duration

number

The duration of the showing

mls

string

The MLS number of the showing

notes

string

The private notes of the showing (visible to only the initiating agent and showing agent)

public_notes

string

The public notes of the showing

access_information

string

Instructions for accessing the property.

showing_group

string

The id of the showing group

buyer_name

string

The name of the buyer

buyer_phone

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

string

Enum: "individual" "couple" "family"

The type of buyer

buyer_external_id

string

An external identifier for the buyer from the calling/external system

price

integer

The price of the showing

payout

integer

The payout of the showing

paid_group_amount

integer

The total payout amount of all showings in the group

tip

integer

The tip of the showing

status

string

The status of the showing

who_cancelled

string

Enum: "SA" "BA"

Which user cancelled the showing

cancellation_notes

string

The notes of the cancellation

reposted

boolean

The reposted status of the showing

message_count

integer

The message count of the showing

counter_proposal_count

integer

The counter proposal count of the showing

reschedulable

boolean

If the showing is rescheduleable or not

rescheduling_requested

boolean

If the a showing rescheduling is requested or not

repostable

boolean

If the showing is repostable or not

counter_proposable

boolean

If the showing is counter proposable or not

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the showing

schedule_details

string

The details of the schedule

amendable

boolean

If the showing is amendable or not

outstanding_amendment

boolean

If the showing has an outstanding amendment or not

review_allowed

boolean

If the showing is reviewable or not

no_show_eligible

boolean

If the showing is no show eligible or not

showing_type

string

The type of showing

original_showing_id

integer

The id of the original showing

external_id

string

The external id of the showing

external_app_url

string

A link into the calling/external app for this showing. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

nar_buyer_agreement

boolean

The nar buyer agreement status of the showing

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object (ShowingAgentResponse)

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Array of objects (Tenant)

Array

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Response samples

Content type

application/json

{"id": 123,
"showing_request_id": 456,
"showing_at": "2020-10-22T13:00:00.000-06:00",
"duration": 2.5,
"mls": "12120009",
"notes": "Here are the details...",
"public_notes": "We're looking for you to do the following...",
"access_information": "Lockbox code 1234, call (555) 123-4567 on arrival",
"showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
"buyer_name": "Sally Ride",
"buyer_phone": 7205551234,
"buyer_type": "individual",
"buyer_external_id": "buyer-abc-123",
"price": 100,
"payout": 79,
"paid_group_amount": 158,
"tip": 10,
"status": "unassigned",
"who_cancelled": "SA",
"cancellation_notes": "The showing was cancelled because...",
"reposted": true,
"message_count": 0,
"counter_proposal_count": 0,
"reschedulable": true,
"rescheduling_requested": true,
"repostable": true,
"counter_proposable": true,
"who_schedules": "showing_agent",
"schedule_details": "The showing has already been scheduled, the code is...",
"amendable": true,
"outstanding_amendment": true,
"review_allowed": true,
"no_show_eligible": true,
"showing_type": "standard",
"original_showing_id": 111,
"external_id": "abc-123",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"nar_buyer_agreement": true,
"address": {"id": 123,
"line1": "123 Main St",
"line2": "Apt 1",
"city": "Denver",
"state": "CO",
"zip": "80202",
"latitude": 39.7392358,
"longitude": -104.990251
},
"user": {"id": 456,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent": {"id": 123,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent_cancellation": {"id": 123,
"showing_id": 456,
"reason": "unavailable",
"cancel_type": "cancel_one",
"notes": "I have a scheduling conflict",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"initiating_agent_cancellation": {"id": 123,
"showing_id": 456,
"cancel_type": "cancel_one",
"notes": "The buyer is no longer interested",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"showing_issues": [{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}
],
"tenants": [{"id": 123,
"full_name": "Christopher Robbins",
"phone": 7205551234,
"tenant_type": "individual"
}
]
}

Showing Opportunities

All Showing opportunities that match the Showing Agent preferences.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Responses

Response Schema: application/json

Array

integer

The id of the showing

showing_request_id

integer

The id of the showing request

showing_at

string

The date and time of the showing

duration

number

The duration of the showing

mls

string

The MLS number of the showing

notes

string

The private notes of the showing (visible to only the initiating agent and showing agent)

public_notes

string

The public notes of the showing

access_information

string

Instructions for accessing the property.

showing_group

string

The id of the showing group

buyer_name

string

The name of the buyer

buyer_phone

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

string

Enum: "individual" "couple" "family"

The type of buyer

buyer_external_id

string

An external identifier for the buyer from the calling/external system

price

integer

The price of the showing

payout

integer

The payout of the showing

paid_group_amount

integer

The total payout amount of all showings in the group

tip

integer

The tip of the showing

status

string

The status of the showing

who_cancelled

string

Enum: "SA" "BA"

Which user cancelled the showing

cancellation_notes

string

The notes of the cancellation

reposted

boolean

The reposted status of the showing

message_count

integer

The message count of the showing

counter_proposal_count

integer

The counter proposal count of the showing

reschedulable

boolean

If the showing is rescheduleable or not

rescheduling_requested

boolean

If the a showing rescheduling is requested or not

repostable

boolean

If the showing is repostable or not

counter_proposable

boolean

If the showing is counter proposable or not

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the showing

schedule_details

string

The details of the schedule

amendable

boolean

If the showing is amendable or not

outstanding_amendment

boolean

If the showing has an outstanding amendment or not

review_allowed

boolean

If the showing is reviewable or not

no_show_eligible

boolean

If the showing is no show eligible or not

showing_type

string

The type of showing

original_showing_id

integer

The id of the original showing

external_id

string

The external id of the showing

external_app_url

string

A link into the calling/external app for this showing. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

nar_buyer_agreement

boolean

The nar buyer agreement status of the showing

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object (ShowingAgentResponse)

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Array of objects (Tenant)

Array

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Response samples

Content type

application/json

[{"id": 123,
"showing_request_id": 456,
"showing_at": "2020-10-22T13:00:00.000-06:00",
"duration": 2.5,
"mls": "12120009",
"notes": "Here are the details...",
"public_notes": "We're looking for you to do the following...",
"access_information": "Lockbox code 1234, call (555) 123-4567 on arrival",
"showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
"buyer_name": "Sally Ride",
"buyer_phone": 7205551234,
"buyer_type": "individual",
"buyer_external_id": "buyer-abc-123",
"price": 100,
"payout": 79,
"paid_group_amount": 158,
"tip": 10,
"status": "unassigned",
"who_cancelled": "SA",
"cancellation_notes": "The showing was cancelled because...",
"reposted": true,
"message_count": 0,
"counter_proposal_count": 0,
"reschedulable": true,
"rescheduling_requested": true,
"repostable": true,
"counter_proposable": true,
"who_schedules": "showing_agent",
"schedule_details": "The showing has already been scheduled, the code is...",
"amendable": true,
"outstanding_amendment": true,
"review_allowed": true,
"no_show_eligible": true,
"showing_type": "standard",
"original_showing_id": 111,
"external_id": "abc-123",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"nar_buyer_agreement": true,
"address": {"id": 123,
"line1": "123 Main St",
"line2": "Apt 1",
"city": "Denver",
"state": "CO",
"zip": "80202",
"latitude": 39.7392358,
"longitude": -104.990251
},
"user": {"id": 456,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent": {"id": 123,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent_cancellation": {"id": 123,
"showing_id": 456,
"reason": "unavailable",
"cancel_type": "cancel_one",
"notes": "I have a scheduling conflict",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"initiating_agent_cancellation": {"id": 123,
"showing_id": 456,
"cancel_type": "cancel_one",
"notes": "The buyer is no longer interested",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"showing_issues": [{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}
],
"tenants": [{"id": 123,
"full_name": "Christopher Robbins",
"phone": 7205551234,
"tenant_type": "individual"
}
]
}
]

Showings by Buyer External ID

Get a list of all showings where the authenticated user is the Initiating Agent, filtered by buyer_external_id.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

query Parameters

buyer_external_id required	string The external identifier for the buyer to filter showings by
page	integer Page number for pagination
per_page	integer Number of results per page (default 15)

Responses

Response Schema: application/json

Array

integer

The id of the showing

showing_request_id

integer

The id of the showing request

showing_at

string

The date and time of the showing

duration

number

The duration of the showing

mls

string

The MLS number of the showing

notes

string

The private notes of the showing (visible to only the initiating agent and showing agent)

public_notes

string

The public notes of the showing

access_information

string

Instructions for accessing the property.

showing_group

string

The id of the showing group

buyer_name

string

The name of the buyer

buyer_phone

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

string

Enum: "individual" "couple" "family"

The type of buyer

buyer_external_id

string

An external identifier for the buyer from the calling/external system

price

integer

The price of the showing

payout

integer

The payout of the showing

paid_group_amount

integer

The total payout amount of all showings in the group

tip

integer

The tip of the showing

status

string

The status of the showing

who_cancelled

string

Enum: "SA" "BA"

Which user cancelled the showing

cancellation_notes

string

The notes of the cancellation

reposted

boolean

The reposted status of the showing

message_count

integer

The message count of the showing

counter_proposal_count

integer

The counter proposal count of the showing

reschedulable

boolean

If the showing is rescheduleable or not

rescheduling_requested

boolean

If the a showing rescheduling is requested or not

repostable

boolean

If the showing is repostable or not

counter_proposable

boolean

If the showing is counter proposable or not

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the showing

schedule_details

string

The details of the schedule

amendable

boolean

If the showing is amendable or not

outstanding_amendment

boolean

If the showing has an outstanding amendment or not

review_allowed

boolean

If the showing is reviewable or not

no_show_eligible

boolean

If the showing is no show eligible or not

showing_type

string

The type of showing

original_showing_id

integer

The id of the original showing

external_id

string

The external id of the showing

external_app_url

string

A link into the calling/external app for this showing. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

nar_buyer_agreement

boolean

The nar buyer agreement status of the showing

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object (ShowingAgentResponse)

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Array of objects (Tenant)

Array

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Response Schema: application/json

message

string

Response samples

Content type

application/json

[{"id": 123,
"showing_request_id": 456,
"showing_at": "2020-10-22T13:00:00.000-06:00",
"duration": 2.5,
"mls": "12120009",
"notes": "Here are the details...",
"public_notes": "We're looking for you to do the following...",
"access_information": "Lockbox code 1234, call (555) 123-4567 on arrival",
"showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
"buyer_name": "Sally Ride",
"buyer_phone": 7205551234,
"buyer_type": "individual",
"buyer_external_id": "buyer-abc-123",
"price": 100,
"payout": 79,
"paid_group_amount": 158,
"tip": 10,
"status": "unassigned",
"who_cancelled": "SA",
"cancellation_notes": "The showing was cancelled because...",
"reposted": true,
"message_count": 0,
"counter_proposal_count": 0,
"reschedulable": true,
"rescheduling_requested": true,
"repostable": true,
"counter_proposable": true,
"who_schedules": "showing_agent",
"schedule_details": "The showing has already been scheduled, the code is...",
"amendable": true,
"outstanding_amendment": true,
"review_allowed": true,
"no_show_eligible": true,
"showing_type": "standard",
"original_showing_id": 111,
"external_id": "abc-123",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"nar_buyer_agreement": true,
"address": {"id": 123,
"line1": "123 Main St",
"line2": "Apt 1",
"city": "Denver",
"state": "CO",
"zip": "80202",
"latitude": 39.7392358,
"longitude": -104.990251
},
"user": {"id": 456,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent": {"id": 123,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent_cancellation": {"id": 123,
"showing_id": 456,
"reason": "unavailable",
"cancel_type": "cancel_one",
"notes": "I have a scheduling conflict",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"initiating_agent_cancellation": {"id": 123,
"showing_id": 456,
"cancel_type": "cancel_one",
"notes": "The buyer is no longer interested",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"showing_issues": [{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}
],
"tenants": [{"id": 123,
"full_name": "Christopher Robbins",
"phone": 7205551234,
"tenant_type": "individual"
}
]
}
]

Showing Requests

Get a list of all showings where the user is the Initiating Agent.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Responses

Response Schema: application/json

Array

integer

The id of the showing

showing_request_id

integer

The id of the showing request

showing_at

string

The date and time of the showing

duration

number

The duration of the showing

mls

string

The MLS number of the showing

notes

string

The private notes of the showing (visible to only the initiating agent and showing agent)

public_notes

string

The public notes of the showing

access_information

string

Instructions for accessing the property.

showing_group

string

The id of the showing group

buyer_name

string

The name of the buyer

buyer_phone

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

string

Enum: "individual" "couple" "family"

The type of buyer

buyer_external_id

string

An external identifier for the buyer from the calling/external system

price

integer

The price of the showing

payout

integer

The payout of the showing

paid_group_amount

integer

The total payout amount of all showings in the group

tip

integer

The tip of the showing

status

string

The status of the showing

who_cancelled

string

Enum: "SA" "BA"

Which user cancelled the showing

cancellation_notes

string

The notes of the cancellation

reposted

boolean

The reposted status of the showing

message_count

integer

The message count of the showing

counter_proposal_count

integer

The counter proposal count of the showing

reschedulable

boolean

If the showing is rescheduleable or not

rescheduling_requested

boolean

If the a showing rescheduling is requested or not

repostable

boolean

If the showing is repostable or not

counter_proposable

boolean

If the showing is counter proposable or not

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the showing

schedule_details

string

The details of the schedule

amendable

boolean

If the showing is amendable or not

outstanding_amendment

boolean

If the showing has an outstanding amendment or not

review_allowed

boolean

If the showing is reviewable or not

no_show_eligible

boolean

If the showing is no show eligible or not

showing_type

string

The type of showing

original_showing_id

integer

The id of the original showing

external_id

string

The external id of the showing

external_app_url

string

A link into the calling/external app for this showing. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

nar_buyer_agreement

boolean

The nar buyer agreement status of the showing

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object (ShowingAgentResponse)

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Array of objects (Tenant)

Array

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Response samples

Content type

application/json

[{"id": 123,
"showing_request_id": 456,
"showing_at": "2020-10-22T13:00:00.000-06:00",
"duration": 2.5,
"mls": "12120009",
"notes": "Here are the details...",
"public_notes": "We're looking for you to do the following...",
"access_information": "Lockbox code 1234, call (555) 123-4567 on arrival",
"showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
"buyer_name": "Sally Ride",
"buyer_phone": 7205551234,
"buyer_type": "individual",
"buyer_external_id": "buyer-abc-123",
"price": 100,
"payout": 79,
"paid_group_amount": 158,
"tip": 10,
"status": "unassigned",
"who_cancelled": "SA",
"cancellation_notes": "The showing was cancelled because...",
"reposted": true,
"message_count": 0,
"counter_proposal_count": 0,
"reschedulable": true,
"rescheduling_requested": true,
"repostable": true,
"counter_proposable": true,
"who_schedules": "showing_agent",
"schedule_details": "The showing has already been scheduled, the code is...",
"amendable": true,
"outstanding_amendment": true,
"review_allowed": true,
"no_show_eligible": true,
"showing_type": "standard",
"original_showing_id": 111,
"external_id": "abc-123",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"nar_buyer_agreement": true,
"address": {"id": 123,
"line1": "123 Main St",
"line2": "Apt 1",
"city": "Denver",
"state": "CO",
"zip": "80202",
"latitude": 39.7392358,
"longitude": -104.990251
},
"user": {"id": 456,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent": {"id": 123,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent_cancellation": {"id": 123,
"showing_id": 456,
"reason": "unavailable",
"cancel_type": "cancel_one",
"notes": "I have a scheduling conflict",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"initiating_agent_cancellation": {"id": 123,
"showing_id": 456,
"cancel_type": "cancel_one",
"notes": "The buyer is no longer interested",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"showing_issues": [{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}
],
"tenants": [{"id": 123,
"full_name": "Christopher Robbins",
"phone": 7205551234,
"tenant_type": "individual"
}
]
}
]

Showing Request by Id

Get the details of a showing where the user is the Initiating Agent.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_request_id

required

integer

Responses

Response Schema: application/json

integer

The id of the showing

showing_request_id

integer

The id of the showing request

showing_at

string

The date and time of the showing

duration

number

The duration of the showing

mls

string

The MLS number of the showing

notes

string

The private notes of the showing (visible to only the initiating agent and showing agent)

public_notes

string

The public notes of the showing

access_information

string

Instructions for accessing the property.

showing_group

string

The id of the showing group

buyer_name

string

The name of the buyer

buyer_phone

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

string

Enum: "individual" "couple" "family"

The type of buyer

buyer_external_id

string

An external identifier for the buyer from the calling/external system

price

integer

The price of the showing

payout

integer

The payout of the showing

paid_group_amount

integer

The total payout amount of all showings in the group

tip

integer

The tip of the showing

status

string

The status of the showing

who_cancelled

string

Enum: "SA" "BA"

Which user cancelled the showing

cancellation_notes

string

The notes of the cancellation

reposted

boolean

The reposted status of the showing

message_count

integer

The message count of the showing

counter_proposal_count

integer

The counter proposal count of the showing

reschedulable

boolean

If the showing is rescheduleable or not

rescheduling_requested

boolean

If the a showing rescheduling is requested or not

repostable

boolean

If the showing is repostable or not

counter_proposable

boolean

If the showing is counter proposable or not

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the showing

schedule_details

string

The details of the schedule

amendable

boolean

If the showing is amendable or not

outstanding_amendment

boolean

If the showing has an outstanding amendment or not

review_allowed

boolean

If the showing is reviewable or not

no_show_eligible

boolean

If the showing is no show eligible or not

showing_type

string

The type of showing

original_showing_id

integer

The id of the original showing

external_id

string

The external id of the showing

external_app_url

string

A link into the calling/external app for this showing. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

nar_buyer_agreement

boolean

The nar buyer agreement status of the showing

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object (ShowingAgentResponse)

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Array of objects (Tenant)

Array

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Response samples

Content type

application/json

{"id": 123,
"showing_request_id": 456,
"showing_at": "2020-10-22T13:00:00.000-06:00",
"duration": 2.5,
"mls": "12120009",
"notes": "Here are the details...",
"public_notes": "We're looking for you to do the following...",
"access_information": "Lockbox code 1234, call (555) 123-4567 on arrival",
"showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
"buyer_name": "Sally Ride",
"buyer_phone": 7205551234,
"buyer_type": "individual",
"buyer_external_id": "buyer-abc-123",
"price": 100,
"payout": 79,
"paid_group_amount": 158,
"tip": 10,
"status": "unassigned",
"who_cancelled": "SA",
"cancellation_notes": "The showing was cancelled because...",
"reposted": true,
"message_count": 0,
"counter_proposal_count": 0,
"reschedulable": true,
"rescheduling_requested": true,
"repostable": true,
"counter_proposable": true,
"who_schedules": "showing_agent",
"schedule_details": "The showing has already been scheduled, the code is...",
"amendable": true,
"outstanding_amendment": true,
"review_allowed": true,
"no_show_eligible": true,
"showing_type": "standard",
"original_showing_id": 111,
"external_id": "abc-123",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"nar_buyer_agreement": true,
"address": {"id": 123,
"line1": "123 Main St",
"line2": "Apt 1",
"city": "Denver",
"state": "CO",
"zip": "80202",
"latitude": 39.7392358,
"longitude": -104.990251
},
"user": {"id": 456,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent": {"id": 123,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent_cancellation": {"id": 123,
"showing_id": 456,
"reason": "unavailable",
"cancel_type": "cancel_one",
"notes": "I have a scheduling conflict",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"initiating_agent_cancellation": {"id": 123,
"showing_id": 456,
"cancel_type": "cancel_one",
"notes": "The buyer is no longer interested",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"showing_issues": [{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}
],
"tenants": [{"id": 123,
"full_name": "Christopher Robbins",
"phone": 7205551234,
"tenant_type": "individual"
}
]
}

Cancel Showing

You may cancel an existing showing for which you have initiated.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id

required

integer

Responses

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"message": "Showing successfully canceled."
}

Initiating Agent Cancel

Cancel a showing as the initiating agent (buyer's agent). The authenticated user must be the initiating agent on the showing.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id

required

integer

Request Body schema: application/json
required

object

cancel_type required	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes required	string Notes about why the showing is being cancelled

Responses

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"initiating_agent_cancellation": {"cancel_type": "cancel_one",
"notes": "The buyer is no longer interested"
}
}

Response samples

Content type

application/json

{"message": "Showing successfully canceled."
}

Counter Proposals

Get all counter proposals for a specific showing.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id

required

integer

query Parameters

include_rejected

boolean

Whether to include rejected counter proposals in the response. Default is false.

Responses

Response Schema: application/json

Array

id	integer The id of the counter proposal
showing_at	string The date and time of the proposed showing
time_zone	string The timezone of the new proposed showing time
payout	integer The proposed payout of the counter proposal
price	integer The corresponding price of the proposed payout of the counter proposal
notes	string The notes of the counter proposal
user_name	string The first name and last initial of the user who created the counter proposal
user_stars	float The star rating of the user who created the counter proposal
rejected_at	string The date and time the counter proposal was rejected
rejection_reason	string The reason the counter proposal was rejected

Response samples

Content type

application/json

[{"id": 123,
"showing_at": "2024-07-30T13:00:00.000-06:00",
"time_zone": "Eastern Time (US & Canada)",
"payout": 79,
"price": 100,
"notes": "I could do this showing, but for a higher price.",
"user_name": "Richard F",
"user_stars": 4.5,
"rejected_at": "2024-07-29T13:00:00.000-06:00",
"rejection_reason": "The price is too high."
}
]

Showing Feedback

Get a list of all Showing feedbacks for this request

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Responses

Response Schema: application/json

showing_id

string

ID of the specific showing this feedback is for

showing_address

string

Address of the showing this feedback is for

showing_external_id

string

An ID to associate the showing with the external system

Array of objects (Showing Feedback Details)

Array

question_key	string Question key for this feedback question
question	string Question text for this feedback question
raw_response	string Original response value for this feedback question
human_readable_response	string Human readable response for this feedback question

Response samples

Content type

application/json

{"showing_id": "123",
"showing_address": "362 W 12th St. Denver CO, 80123",
"showing_external_id": "abc-1234-ext",
"feedback_responses": [{"question_key": "rental_completed",
"question": "Was the rental showing completed?",
"raw_response": "maybe",
"human_readable_response": "Maybe or N/A"
}
]
}

Accept Counter-Proposal

Accept a counter-proposal for a showing. The authenticated user must be authorized to accept the counter-proposal.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id

required

integer

The id of the showing.

Request Body schema: application/json
required

counter_proposal_id

required

integer

The id of the counter-proposal to accept.

Responses

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"counter_proposal_id": 456
}

Response samples

Content type

application/json

{"message": "Counter-proposal accepted!"
}

Reject Counter-Proposal

Reject a counter-proposal for a showing. The authenticated user must be authorized to reject the counter-proposal.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id

required

integer

The id of the showing.

Request Body schema: application/json
required

counter_proposal_id required	integer The id of the counter-proposal to reject.
rejection_reason	string Optional reason for rejecting the counter-proposal.

Responses

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"counter_proposal_id": 456,
"rejection_reason": "The proposed time does not work for my client."
}

Response samples

Content type

application/json

{"message": "Counter-proposal rejected"
}

List Showing Issues

List all issues reported against a showing. The authenticated user must be the requesting user on the showing, or an organization admin in that user's organization.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id

required

integer

The id of the showing.

Responses

Response Schema: application/json

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Response samples

Content type

application/json

[{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}
]

Report Showing Issue

Report an issue with a showing as the initiating agent (buyer's agent). The authenticated user must be the buyer's agent on the showing, the showing must be in completed status, and the report must be submitted within 24 hours of the showing time.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id

required

integer

The id of the showing.

Request Body schema: application/json
required

required

object

issue_type required	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue being reported.
notes required	string <= 400 characters Description of the issue. Maximum 400 characters.

Responses

Response Schema: application/json

message	string
showing_issue_id	integer The id of the newly created showing issue. Use this id to resolve the issue later via the Resolve Showing Issue endpoint.

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"showing_issue": {"issue_type": "sa_no_show",
"notes": "The showing agent did not arrive at the property."
}
}

Response samples

Content type

application/json

{"message": "Showing marked as a no-show",
"showing_issue_id": 123
}

Get Showing Issue

Retrieve a single issue reported against a showing. The authenticated user must be the requesting user on the showing, or an organization admin in that user's organization.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id required	integer The id of the showing.
id required	integer The id of the showing issue.

Responses

Response Schema: application/json

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}

Resolve Showing Issue

Update a showing issue's resolution state. The default action (type=resolved, or type omitted) marks the issue resolved, which on incomplete issues releases the related payment hold so the initiating agent transfer can proceed on the next payout cycle.

Passing type=showing_agent_issue marks the issue as a showing agent issue instead, which removes it from the unresolved queue but blocks the related payment permanently. The authenticated user must be the initiating agent on the showing.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id required	integer The id of the showing.
id required	integer The id of the showing issue to update.

query Parameters

type	string Enum: "resolved" "showing_agent_issue" The resolution type. Defaults to `resolved` when omitted.

Responses

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"message": "Showing issue marked as resolved."
}

Reschedule Showing

Create a reschedule request for a showing for which you are either the initiating agent or showing agent.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

object

showing_id	integer The id of the showing to reschedule. Your user can be either the initiating agent or the showing agent.
showing_at(1i)	string The year of the showing
showing_at(2i)	string The month of the showing
showing_at(3i)	string The day of the showing
showing_at(4i)	string The hour of the showing
showing_at(5i)	string The minute of the showing
notes	string Notes for the other agent to know why a reschedule request is being made.
rejection_reason	string Required when rejecting a reschedule request. Explains why the proposed time was declined.

Responses

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"showing_rescheduling": {"showing_id": 123,
"showing_at(1i)": "2024",
"showing_at(2i)": "12",
"showing_at(3i)": "30",
"showing_at(4i)": "16",
"showing_at(5i)": "0",
"notes": "I would like to reschedule this showing because...",
"rejection_reason": "I already have another showing at that time."
}
}

Response samples

Content type

application/json

{"message": "Requested to reschedule showing"
}

Reschedule Accept/Decline

Accept or Reject a rescheduling request for a showing.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_rescheduling_id

required

integer

Request Body schema: application/json
required

status

required

string

Enum: "accept" "decline"

Whether to accept or decline the rescheduling request.

Responses

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"status": "accept"
}

Response samples

Content type

application/json

{"message": "Accepted rescheduling"
}

Showing Acceptance Prediction

Get a prediction of whether a showing will be accepted based on the showing request parameters.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

object (ShowingRequest)

showing_type

required

integer

0 - standard, 1 - open_house, 2 - inspection, 3 - appraisal, 4 - rental, 5 - rental_open_house, 8 - property_data_collection. Note, the exact string value are also accepted.

buyer_name

required

string

The buyer's name

buyer_phone

required

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

required

integer

0 - individual, 1 - couple, 2 - family

buyer_external_id

string

An external identifier for the buyer from the calling/external system

met_buyer

integer

0 - unknown, 1 - no, 2 - yes

price

required

integer

The amount willing to pay for each showing in the group

notes

string <= 2000 characters

Private Showing notes visible to the accepting Showing Agent.

public_notes

string <= 2000 characters

Public Showing notes visible to all users.

nar_buyer_agreement

boolean

true - yes, the buyer has a NAR buyer agreement, false - no the buyer does not have a NAR buyer agreement, null - it is unknown or undisclosed if the buyer has a NAR buyer agreement

preferred_agent_1_email

string

preferred_agent_2_email

string

preferred_agent_3_email

string

access_information

required

string

time_zone

string

The timezone of the showing - 'Alaska', 'Arizona', 'Central Time (US & Canada)', 'Eastern Time (US & Canada)', 'Hawaii', 'Indiana (East)', 'Mountain Time (US & Canada)', 'Pacific Time (US & Canada)'

external_app_url

string

A link into the calling/external app for this showing request. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

object (ShowingRequestPropertyWrapper)

object (ShowingRequestProperty)

showing_at(1i) required	string The year of the showing
showing_at(2i) required	string The month of the showing
showing_at(3i) required	string The day of the showing
showing_at(4i) required	string The hour of the showing
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing
duration	number The length of the appointment in hours (Open House, Inspection, Appraisals only)
mls	string The MLS identifier of the property, if available
line1 required	string
line2	string
city required	string
state required	string
zip required	string
who_schedules required	integer 0 - showing_agent, 1 - buyers_agent
schedule_details	string
external_id	string An id to associate with the showing from the calling/external system

object (ShowingRequestProperty)

showing_at(1i) required	string The year of the showing
showing_at(2i) required	string The month of the showing
showing_at(3i) required	string The day of the showing
showing_at(4i) required	string The hour of the showing
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing
duration	number The length of the appointment in hours (Open House, Inspection, Appraisals only)
mls	string The MLS identifier of the property, if available
line1 required	string
line2	string
city required	string
state required	string
zip required	string
who_schedules required	integer 0 - showing_agent, 1 - buyers_agent
schedule_details	string
external_id	string An id to associate with the showing from the calling/external system

Responses

Response Schema: application/json

prediction	number The acceptance probability between 0 and 1
warnings	Array of strings

Request samples

Payload

Content type

application/json

{"showing_request": {"showing_type": 0,
"buyer_name": "Christopher Robbins",
"buyer_phone": 7205551234,
"buyer_type": 0,
"buyer_external_id": "buyer-abc-123",
"met_buyer": 0,
"price": 0,
"notes": "Private Showing notes visible to the accepting Showing Agent",
"public_notes": "Public Showing notes visible to all users",
"nar_buyer_agreement": true,
"preferred_agent_1_email": "string",
"preferred_agent_2_email": "string",
"preferred_agent_3_email": "string",
"access_information": "How to access the property (Open House, Inspection, Appraisals only)",
"time_zone": "Mountain Time (US & Canada)",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"showing_request_properties_attributes": {"0": {"showing_at(1i)": "2023",
"showing_at(2i)": "12",
"showing_at(3i)": "30",
"showing_at(4i)": "16",
"showing_at(5i)": "0",
"duration": 1.5,
"mls": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"who_schedules": 0,
"schedule_details": "string",
"external_id": "string"
},
"1": {"showing_at(1i)": "2023",
"showing_at(2i)": "12",
"showing_at(3i)": "30",
"showing_at(4i)": "16",
"showing_at(5i)": "0",
"duration": 1.5,
"mls": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"who_schedules": 0,
"schedule_details": "string",
"external_id": "string"
}
}
}
}

Response samples

Content type

application/json

{"prediction": 0.85,
"warnings": ["Only the first property in the request is being used for prediction.",
"Only standard and rental showing types are supported for prediction. Assuming a standard showing type..."
]
}

Messages

API endpoints related to Messages

List Messages

Get all messages on a Showing. The authenticated user must be either the requesting user or the showing agent on the Showing.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id

required

integer

The id of the showing.

Responses

Response Schema: application/json

Array

id	integer The id of the message.
body	string The message text.
user_id	integer The id of the user that sent the message.
created_by	string The full name of the user that sent the message.
created_at	string <date-time> When the message was created.

Response Schema: application/json

message

string

Response samples

Content type

application/json

[{"id": 123,
"body": "On my way to the showing now.",
"user_id": 456,
"created_by": "Jane Agent",
"created_at": "2026-05-06T14:30:00.000Z"
}
]

Create Message

Send a message to the other user on a Showing. The authenticated user must be either the requesting user or the showing agent. Sending a message triggers an SMS notification to the other user and may trigger an organization auto-responder reply.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

showing_id

required

integer

The id of the showing.

Request Body schema: application/json
required

required

object

body

required

string <= 1200 characters

The message text. Must be present and 1200 characters or fewer.

Responses

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"message": {"body": "On my way to the showing now."
}
}

Response samples

Content type

application/json

{"message": "Successfully added message to showing."
}

Tasks

API endpoints related to Tasks

Create a Task List

Create a new Task List

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

object (TaskRequest)

price

required

integer

The amount willing to pay for each showing in the group

notes

string <= 2000 characters

public_notes

string <= 2000 characters

preferred_agent_1_email

string

preferred_agent_2_email

string

preferred_agent_3_email

string

time_zone

string

The timezone of the showing - 'Alaska', 'Arizona', 'Central Time (US & Canada)', 'Eastern Time (US & Canada)', 'Hawaii', 'Indiana (East)', 'Mountain Time (US & Canada)', 'Pacific Time (US & Canada)'

object (TaskRequestPropertyWrapper)

object (TaskRequestProperty)

task_type required	string Enum: "Drop off/Pick up" "Condition Report" "Photography/Videography" "Property Check" "Key Box Installation" "Other" The type of task
showing_at(1i) required	string The year of the showing
showing_at(2i) required	string The month of the showing
showing_at(3i) required	string The day of the showing
showing_at(4i) required	string The hour of the showing
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing
showing_ends_at(1i) required	string The year of the showing
showing_ends_at(2i) required	string The month of the showing
showing_ends_at(3i) required	string The day of the showing
showing_ends_at(4i) required	string The hour of the showing
showing_ends_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing
line1 required	string
line2	string
city required	string
state required	string
zip required	string
alt_line1	string
alt_line2	string
alt_city	string
alt_state	string
alt_zip	string
schedule_details	string
external_id	string An id to associate with the showing from the calling/external system

object (TaskRequestProperty)

task_type required	string Enum: "Drop off/Pick up" "Condition Report" "Photography/Videography" "Property Check" "Key Box Installation" "Other" The type of task
showing_at(1i) required	string The year of the showing
showing_at(2i) required	string The month of the showing
showing_at(3i) required	string The day of the showing
showing_at(4i) required	string The hour of the showing
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing
showing_ends_at(1i) required	string The year of the showing
showing_ends_at(2i) required	string The month of the showing
showing_ends_at(3i) required	string The day of the showing
showing_ends_at(4i) required	string The hour of the showing
showing_ends_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing
line1 required	string
line2	string
city required	string
state required	string
zip required	string
alt_line1	string
alt_line2	string
alt_city	string
alt_state	string
alt_zip	string
schedule_details	string
external_id	string An id to associate with the showing from the calling/external system

Responses

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"showing_request": {"price": 0,
"notes": "Private Task notes visible to the accepting Showing Agent",
"public_notes": "Public Task notes visible to all agents",
"preferred_agent_1_email": "string",
"preferred_agent_2_email": "string",
"preferred_agent_3_email": "string",
"time_zone": "Mountain Time (US & Canada)",
"showing_request_properties_attributes": {"0": {"task_type": "Drop off/Pick up",
"showing_at(1i)": "2023",
"showing_at(2i)": "12",
"showing_at(3i)": "30",
"showing_at(4i)": "16",
"showing_at(5i)": "0",
"showing_ends_at(1i)": "2023",
"showing_ends_at(2i)": "12",
"showing_ends_at(3i)": "30",
"showing_ends_at(4i)": "16",
"showing_ends_at(5i)": "0",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"alt_line1": "string",
"alt_line2": "string",
"alt_city": "string",
"alt_state": "string",
"alt_zip": "string",
"schedule_details": "string",
"external_id": "string"
},
"1": {"task_type": "Drop off/Pick up",
"showing_at(1i)": "2023",
"showing_at(2i)": "12",
"showing_at(3i)": "30",
"showing_at(4i)": "16",
"showing_at(5i)": "0",
"showing_ends_at(1i)": "2023",
"showing_ends_at(2i)": "12",
"showing_ends_at(3i)": "30",
"showing_ends_at(4i)": "16",
"showing_ends_at(5i)": "0",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip": "string",
"alt_line1": "string",
"alt_line2": "string",
"alt_city": "string",
"alt_state": "string",
"alt_zip": "string",
"schedule_details": "string",
"external_id": "string"
}
}
}
}

Response samples

Content type

application/json

{"message": "string"
}

Accept a Task List

Mark a Task List as Accepted

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

task_id

required

integer

Request Body schema: application/json
required

status

required

string

Enum: "approve" "reject"

Whether to approve or reject the task.

Responses

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"status": "approve"
}

Response samples

Content type

application/json

{"message": "Task Accepted"
}

Rentals

API endpoints related to Rentals

Rental Requests

Get a paginated list of all rental showings initiated by the authenticated user.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

query Parameters

page

integer

Responses

Response Schema: application/json

Array

integer

The id of the showing

showing_request_id

integer

The id of the showing request

showing_at

string

The date and time of the showing

duration

number

The duration of the showing

mls

string

The MLS number of the showing

notes

string

The private notes of the showing (visible to only the initiating agent and showing agent)

public_notes

string

The public notes of the showing

access_information

string

Instructions for accessing the property.

showing_group

string

The id of the showing group

buyer_name

string

The name of the buyer

buyer_phone

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

string

Enum: "individual" "couple" "family"

The type of buyer

buyer_external_id

string

An external identifier for the buyer from the calling/external system

price

integer

The price of the showing

payout

integer

The payout of the showing

paid_group_amount

integer

The total payout amount of all showings in the group

tip

integer

The tip of the showing

status

string

The status of the showing

who_cancelled

string

Enum: "SA" "BA"

Which user cancelled the showing

cancellation_notes

string

The notes of the cancellation

reposted

boolean

The reposted status of the showing

message_count

integer

The message count of the showing

counter_proposal_count

integer

The counter proposal count of the showing

reschedulable

boolean

If the showing is rescheduleable or not

rescheduling_requested

boolean

If the a showing rescheduling is requested or not

repostable

boolean

If the showing is repostable or not

counter_proposable

boolean

If the showing is counter proposable or not

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the showing

schedule_details

string

The details of the schedule

amendable

boolean

If the showing is amendable or not

outstanding_amendment

boolean

If the showing has an outstanding amendment or not

review_allowed

boolean

If the showing is reviewable or not

no_show_eligible

boolean

If the showing is no show eligible or not

showing_type

string

The type of showing

original_showing_id

integer

The id of the original showing

external_id

string

The external id of the showing

external_app_url

string

A link into the calling/external app for this showing. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

nar_buyer_agreement

boolean

The nar buyer agreement status of the showing

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object (ShowingAgentResponse)

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Array of objects (Tenant)

Array

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Response samples

Content type

application/json

[{"id": 123,
"showing_request_id": 456,
"showing_at": "2020-10-22T13:00:00.000-06:00",
"duration": 2.5,
"mls": "12120009",
"notes": "Here are the details...",
"public_notes": "We're looking for you to do the following...",
"access_information": "Lockbox code 1234, call (555) 123-4567 on arrival",
"showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
"buyer_name": "Sally Ride",
"buyer_phone": 7205551234,
"buyer_type": "individual",
"buyer_external_id": "buyer-abc-123",
"price": 100,
"payout": 79,
"paid_group_amount": 158,
"tip": 10,
"status": "unassigned",
"who_cancelled": "SA",
"cancellation_notes": "The showing was cancelled because...",
"reposted": true,
"message_count": 0,
"counter_proposal_count": 0,
"reschedulable": true,
"rescheduling_requested": true,
"repostable": true,
"counter_proposable": true,
"who_schedules": "showing_agent",
"schedule_details": "The showing has already been scheduled, the code is...",
"amendable": true,
"outstanding_amendment": true,
"review_allowed": true,
"no_show_eligible": true,
"showing_type": "standard",
"original_showing_id": 111,
"external_id": "abc-123",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"nar_buyer_agreement": true,
"address": {"id": 123,
"line1": "123 Main St",
"line2": "Apt 1",
"city": "Denver",
"state": "CO",
"zip": "80202",
"latitude": 39.7392358,
"longitude": -104.990251
},
"user": {"id": 456,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent": {"id": 123,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent_cancellation": {"id": 123,
"showing_id": 456,
"reason": "unavailable",
"cancel_type": "cancel_one",
"notes": "I have a scheduling conflict",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"initiating_agent_cancellation": {"id": 123,
"showing_id": 456,
"cancel_type": "cancel_one",
"notes": "The buyer is no longer interested",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"showing_issues": [{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}
],
"tenants": [{"id": 123,
"full_name": "Christopher Robbins",
"phone": 7205551234,
"tenant_type": "individual"
}
]
}
]

Create Rental

You may create one or more rental showing(s) using this action. It takes a JSON object containing the parameters of the showing.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

object (RentalShowingRequest)

tenant_name

required

string

The tenant's name

tenant_phone

required

string

The tenant's phone number (exactly 10 digits, no spaces or special characters)

tenant_type

required

integer

0 - individual, 1 - couple, 2 - family

price

required

integer

The amount willing to pay for each showing in the group

public_notes

string <= 2000 characters

Public Showing notes visible to all users.

notes

string <= 2000 characters

Private Showing notes visible to the accepting Showing Agent.

access_information

required

string

How to access the property.

preferred_agent_1_email

string

preferred_agent_2_email

string

preferred_agent_3_email

string

time_zone

string

The timezone of the showing - 'Alaska', 'Arizona', 'Central Time (US & Canada)', 'Eastern Time (US & Canada)', 'Hawaii', 'Indiana (East)', 'Mountain Time (US & Canada)', 'Pacific Time (US & Canada)'

external_id

string

An id to associate with the showing from the calling/external system

object (RentalShowingRequestPropertyWrapper)

object (RentalShowingRequestProperty)

showing_at(1i) required	string The year of the showing - e.g. "2023"
showing_at(2i) required	string The month of the showing - e.g. "12"
showing_at(3i) required	string The day of the showing - e.g. "30"
showing_at(4i) required	string The hour of the showing - e.g. "16"
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing - e.g. "15"
line1 required	string
line2	string
city required	string
state required	string
zip required	string

object (RentalShowingRequestProperty)

showing_at(1i) required	string The year of the showing - e.g. "2023"
showing_at(2i) required	string The month of the showing - e.g. "12"
showing_at(3i) required	string The day of the showing - e.g. "30"
showing_at(4i) required	string The hour of the showing - e.g. "16"
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing - e.g. "15"
line1 required	string
line2	string
city required	string
state required	string
zip required	string

Responses

Response Schema: application/json

integer

The id of the showing

showing_request_id

integer

The id of the showing request

showing_at

string

The date and time of the showing

duration

number

The duration of the showing

mls

string

The MLS number of the showing

notes

string

The private notes of the showing (visible to only the initiating agent and showing agent)

public_notes

string

The public notes of the showing

access_information

string

Instructions for accessing the property.

showing_group

string

The id of the showing group

buyer_name

string

The name of the buyer

buyer_phone

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

string

Enum: "individual" "couple" "family"

The type of buyer

buyer_external_id

string

An external identifier for the buyer from the calling/external system

price

integer

The price of the showing

payout

integer

The payout of the showing

paid_group_amount

integer

The total payout amount of all showings in the group

tip

integer

The tip of the showing

status

string

The status of the showing

who_cancelled

string

Enum: "SA" "BA"

Which user cancelled the showing

cancellation_notes

string

The notes of the cancellation

reposted

boolean

The reposted status of the showing

message_count

integer

The message count of the showing

counter_proposal_count

integer

The counter proposal count of the showing

reschedulable

boolean

If the showing is rescheduleable or not

rescheduling_requested

boolean

If the a showing rescheduling is requested or not

repostable

boolean

If the showing is repostable or not

counter_proposable

boolean

If the showing is counter proposable or not

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the showing

schedule_details

string

The details of the schedule

amendable

boolean

If the showing is amendable or not

outstanding_amendment

boolean

If the showing has an outstanding amendment or not

review_allowed

boolean

If the showing is reviewable or not

no_show_eligible

boolean

If the showing is no show eligible or not

showing_type

string

The type of showing

original_showing_id

integer

The id of the original showing

external_id

string

The external id of the showing

external_app_url

string

A link into the calling/external app for this showing. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

nar_buyer_agreement

boolean

The nar buyer agreement status of the showing

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object (ShowingAgentResponse)

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Array of objects (Tenant)

Array

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Request samples

Payload

Content type

application/json

{"showing_request": {"tenant_name": "Christopher Robbins",
"tenant_phone": 7205551234,
"tenant_type": 0,
"price": 0,
"public_notes": "Public Showing notes visible to all users",
"notes": "Private Showing notes visible to the accepting Showing Agent",
"access_information": "How to access the property",
"preferred_agent_1_email": "[email protected]",
"preferred_agent_2_email": "[email protected]",
"preferred_agent_3_email": "[email protected]",
"time_zone": "Mountain Time (US & Canada)",
"external_id": "string",
"showing_request_properties_attributes": {"0": {"showing_at(1i)": "string",
"showing_at(2i)": "string",
"showing_at(3i)": "string",
"showing_at(4i)": "string",
"showing_at(5i)": "0",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"1": {"showing_at(1i)": "string",
"showing_at(2i)": "string",
"showing_at(3i)": "string",
"showing_at(4i)": "string",
"showing_at(5i)": "0",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip": "string"
}
}
}
}

Response samples

Content type

application/json

{"id": 123,
"showing_request_id": 456,
"showing_at": "2020-10-22T13:00:00.000-06:00",
"duration": 2.5,
"mls": "12120009",
"notes": "Here are the details...",
"public_notes": "We're looking for you to do the following...",
"access_information": "Lockbox code 1234, call (555) 123-4567 on arrival",
"showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
"buyer_name": "Sally Ride",
"buyer_phone": 7205551234,
"buyer_type": "individual",
"buyer_external_id": "buyer-abc-123",
"price": 100,
"payout": 79,
"paid_group_amount": 158,
"tip": 10,
"status": "unassigned",
"who_cancelled": "SA",
"cancellation_notes": "The showing was cancelled because...",
"reposted": true,
"message_count": 0,
"counter_proposal_count": 0,
"reschedulable": true,
"rescheduling_requested": true,
"repostable": true,
"counter_proposable": true,
"who_schedules": "showing_agent",
"schedule_details": "The showing has already been scheduled, the code is...",
"amendable": true,
"outstanding_amendment": true,
"review_allowed": true,
"no_show_eligible": true,
"showing_type": "standard",
"original_showing_id": 111,
"external_id": "abc-123",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"nar_buyer_agreement": true,
"address": {"id": 123,
"line1": "123 Main St",
"line2": "Apt 1",
"city": "Denver",
"state": "CO",
"zip": "80202",
"latitude": 39.7392358,
"longitude": -104.990251
},
"user": {"id": 456,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent": {"id": 123,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent_cancellation": {"id": 123,
"showing_id": 456,
"reason": "unavailable",
"cancel_type": "cancel_one",
"notes": "I have a scheduling conflict",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"initiating_agent_cancellation": {"id": 123,
"showing_id": 456,
"cancel_type": "cancel_one",
"notes": "The buyer is no longer interested",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"showing_issues": [{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}
],
"tenants": [{"id": 123,
"full_name": "Christopher Robbins",
"phone": 7205551234,
"tenant_type": "individual"
}
]
}

Cancel Rental

You may cancel an existing rental showing.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

rental_id

required

integer

Responses

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"message": "Rental successfully canceled."
}

Add Tenant to Rental

Add an additional tenant to an existing rental. A rental supports up to two total tenants (the original tenant plus one additional tenant). Tenants may be added any time after creation, up to the showing_at time.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

rental_id

required

integer

Request Body schema: application/json
required

object (RentalTenant)

tenant_name required	string The tenant's name
tenant_phone required	string The tenant's phone number (exactly 10 digits, no spaces or special characters)
tenant_type required	integer 0 - individual, 1 - couple, 2 - family

Responses

Response Schema: application/json

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"tenant": {"tenant_name": "Christopher Robbins",
"tenant_phone": 7205551234,
"tenant_type": 0
}
}

Response samples

Content type

application/json

{"id": 123,
"full_name": "Christopher Robbins",
"phone": 7205551234,
"tenant_type": "individual"
}

Remove Tenant from Rental

Remove an additional tenant from an existing rental. No notification is sent when a tenant is removed.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

rental_id required	integer
id required	integer

Responses

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Response samples

Content type

application/json

{"message": "Tenant removed."
}

Rental Request by Id

Get a serialized rental showing object by its id, initiated by the authenticated user.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

rental_id

required

integer

query Parameters

page

integer

Responses

Response Schema: application/json

integer

The id of the showing

showing_request_id

integer

The id of the showing request

showing_at

string

The date and time of the showing

duration

number

The duration of the showing

mls

string

The MLS number of the showing

notes

string

The private notes of the showing (visible to only the initiating agent and showing agent)

public_notes

string

The public notes of the showing

access_information

string

Instructions for accessing the property.

showing_group

string

The id of the showing group

buyer_name

string

The name of the buyer

buyer_phone

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

string

Enum: "individual" "couple" "family"

The type of buyer

buyer_external_id

string

An external identifier for the buyer from the calling/external system

price

integer

The price of the showing

payout

integer

The payout of the showing

paid_group_amount

integer

The total payout amount of all showings in the group

tip

integer

The tip of the showing

status

string

The status of the showing

who_cancelled

string

Enum: "SA" "BA"

Which user cancelled the showing

cancellation_notes

string

The notes of the cancellation

reposted

boolean

The reposted status of the showing

message_count

integer

The message count of the showing

counter_proposal_count

integer

The counter proposal count of the showing

reschedulable

boolean

If the showing is rescheduleable or not

rescheduling_requested

boolean

If the a showing rescheduling is requested or not

repostable

boolean

If the showing is repostable or not

counter_proposable

boolean

If the showing is counter proposable or not

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the showing

schedule_details

string

The details of the schedule

amendable

boolean

If the showing is amendable or not

outstanding_amendment

boolean

If the showing has an outstanding amendment or not

review_allowed

boolean

If the showing is reviewable or not

no_show_eligible

boolean

If the showing is no show eligible or not

showing_type

string

The type of showing

original_showing_id

integer

The id of the original showing

external_id

string

The external id of the showing

external_app_url

string

A link into the calling/external app for this showing. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

nar_buyer_agreement

boolean

The nar buyer agreement status of the showing

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object (ShowingAgentResponse)

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Array of objects (Tenant)

Array

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Response samples

Content type

application/json

{"id": 123,
"showing_request_id": 456,
"showing_at": "2020-10-22T13:00:00.000-06:00",
"duration": 2.5,
"mls": "12120009",
"notes": "Here are the details...",
"public_notes": "We're looking for you to do the following...",
"access_information": "Lockbox code 1234, call (555) 123-4567 on arrival",
"showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
"buyer_name": "Sally Ride",
"buyer_phone": 7205551234,
"buyer_type": "individual",
"buyer_external_id": "buyer-abc-123",
"price": 100,
"payout": 79,
"paid_group_amount": 158,
"tip": 10,
"status": "unassigned",
"who_cancelled": "SA",
"cancellation_notes": "The showing was cancelled because...",
"reposted": true,
"message_count": 0,
"counter_proposal_count": 0,
"reschedulable": true,
"rescheduling_requested": true,
"repostable": true,
"counter_proposable": true,
"who_schedules": "showing_agent",
"schedule_details": "The showing has already been scheduled, the code is...",
"amendable": true,
"outstanding_amendment": true,
"review_allowed": true,
"no_show_eligible": true,
"showing_type": "standard",
"original_showing_id": 111,
"external_id": "abc-123",
"external_app_url": "https://partner.example.com/showings/abc-123",
"external_app_icon_path": "partners/app_icons/opendoor.png",
"nar_buyer_agreement": true,
"address": {"id": 123,
"line1": "123 Main St",
"line2": "Apt 1",
"city": "Denver",
"state": "CO",
"zip": "80202",
"latitude": 39.7392358,
"longitude": -104.990251
},
"user": {"id": 456,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent": {"id": 123,
"email": "[email protected]",
"profile": {"first_name": "Richard",
"last_name": "Feynman",
"phone1": 7205551234,
"company": "Properties Inc.",
"agent_id": "AN12345678",
"license_state": "CO",
"agent_type": "showing_agent",
"avatar": "base64encodedstring",
"eula": true
}
},
"showing_agent_cancellation": {"id": 123,
"showing_id": 456,
"reason": "unavailable",
"cancel_type": "cancel_one",
"notes": "I have a scheduling conflict",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"initiating_agent_cancellation": {"id": 123,
"showing_id": 456,
"cancel_type": "cancel_one",
"notes": "The buyer is no longer interested",
"created_at": "2024-07-30T13:00:00.000-06:00"
},
"showing_issues": [{"id": 123,
"issue_type": "incomplete",
"notes": "The showing agent did not arrive at the property.",
"resolved?": false,
"resolved_at": "string",
"showing_agent_issue?": false,
"created_at": "2024-07-30T13:00:00.000-06:00",
"updated_at": "2024-07-30T13:00:00.000-06:00"
}
],
"tenants": [{"id": 123,
"full_name": "Christopher Robbins",
"phone": 7205551234,
"tenant_type": "individual"
}
]
}

Property Data Collection

API endpoints related to Property Data Collection appointments. These use the same underlying /showings endpoint as a standard showing, but with showing_type set to property_data_collection. They are documented separately for clarity.

Create Property Data Collection

Create a new PDC (Property Data Collection) appointment.

This is the same underlying endpoint as POST /showings, but with showing_type set to property_data_collection.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

object (PropertyDataCollectionRequest)

showing_type

required

string

Value: "property_data_collection"

Must be property_data_collection for this endpoint. The integer equivalent (8) is also accepted.

price

required

integer

The amount willing to pay for the property data collection appointment.

access_information

required

string

Instructions the showing agent will need in order to access the property and complete the data collection workflow.

notes

string <= 2000 characters

Private notes visible to the accepting Showing Agent.

public_notes

string <= 2000 characters

Public notes visible to all users.

time_zone

string

The timezone of the appointment - 'Alaska', 'Arizona', 'Central Time (US & Canada)', 'Eastern Time (US & Canada)', 'Hawaii', 'Indiana (East)', 'Mountain Time (US & Canada)', 'Pacific Time (US & Canada)'. If omitted, the initiating user's default timezone is used.

required

object (PropertyDataCollectionRequestPropertyWrapper)

object (PropertyDataCollectionRequestProperty)

showing_at(1i) required	string The year of the appointment
showing_at(2i) required	string The month of the appointment
showing_at(3i) required	string The day of the appointment
showing_at(4i) required	string The hour of the appointment
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the appointment
duration required	number The length of the appointment in hours.
line1 required	string The first line of the property address.
line2	string The second line of the property address.
city required	string
state required	string
zip required	string
external_id	string An id to associate with the appointment from the calling/external system.

Responses

Response Schema: application/json

message

string

A human-readable success message.

Array of objects (Property Data Collection Showing)

The newly-created property data collection showings.

Array

integer

The id of the showing.

showing_request_id

integer

The id of the showing request.

showing_at

string

The date and time of the appointment.

time_zone

string

The timezone of the appointment.

duration

number

The duration of the appointment, in hours.

mls

string or null

The MLS number of the property, if available.

notes

string

Private notes, visible only to the initiating agent and showing agent.

public_notes

string

Public notes, visible to all users.

access_information

string

Instructions for accessing the property and completing the data collection workflow.

showing_group

string or null

The id of the showing group, if part of one.

buyer_name

string or null

Unused for property data collection appointments.

buyer_phone

string or null

Unused for property data collection appointments.

buyer_type

string or null

Unused for property data collection appointments.

buyer_external_id

string or null

Unused for property data collection appointments.

met_buyer

string

Unused for property data collection appointments.

price

integer

The price of the appointment.

payout

integer

The payout to the showing agent.

charge_amount

number

The total amount (in dollars) charged to the initiating agent.

Array of objects

Line-item breakdown of the charge, with amounts in cents.

Array

description	string
amount	integer

transfer_amount

number

The total amount (in dollars) transferred to the showing agent.

Array of objects

Line-item breakdown of the transfer, with amounts in cents.

Array

description	string
amount	integer

paid_group_amount

integer

The total payout amount of all showings in the group.

tip

integer

status

string

Enum: "unassigned" "unconfirmed" "confirmed" "completed" "cancelled" "expired" "no_show" "processing_payment" "paid" "cancelled_with_payment" "unassigned_with_preferred" "refunded" "in_progress"

The status of the appointment.

who_cancelled

string

cancellation_notes

string

reposted

boolean

message_count

integer

counter_proposal_count

integer

reschedulable

boolean

rescheduling_requested

boolean

repostable?

boolean

counter_proposable?

boolean

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the appointment. Always showing_agent for property data collection.

schedule_details

string

amendable?

boolean

outstanding_amendment?

boolean

review_allowed?

boolean

no_show_eligible?

boolean

showing_type

string

Value: "property_data_collection"

The type of showing. Always property_data_collection for this endpoint.

feedback_available?

boolean

photos_visible?

boolean

photos_editable?

boolean

standard_tz_identifier

string

IANA timezone identifier for the appointment.

counter_proposal_exists?

boolean

counter_proposal_rejected?

boolean or null

cannot_confirm_before

string

The earliest time the showing agent may confirm the appointment.

calendar_addable?

boolean

original_showing_id

integer or null

The id of the original showing if this is a reposted appointment.

external_id

string

The external id supplied when the appointment was created.

agent_checked_in?

boolean

agent_checked_in_at

string or null

agent_checked_out?

boolean

agent_checked_out_at

string or null

checkin_enabled?

boolean

nar_buyer_agreement

boolean or null

Unused for property data collection appointments.

accepted_at

string or null

The time the appointment was accepted by a showing agent.

showing_agent_visible

boolean

requesting_agent_visible

boolean

max_photos

integer

duplicatable?

boolean

should_mask_agent_email?

boolean

True when the buyers agent's organization masks agent emails and the viewing user is not the buyers agent.

prefers_contact_via_messaging?

boolean

True when the buyers agent's organization prefers communication through the message center and the viewing user is not the buyers agent.

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (Showing Agent)

The showing agent assigned to the appointment, or null if unassigned.

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

showing_photos

Array of objects

tasks

Array of objects

supplemental_documents

Array of objects

Videos attached to the showing.

Array

id	integer
title	string
url	string

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"showing_request": {"showing_type": "property_data_collection",
"price": 50,
"access_information": "Access information for the showing...",
"notes": "Private notes...",
"public_notes": "Public notes...",
"showing_request_properties_attributes": {"0": {"showing_at(1i)": "2026",
"showing_at(2i)": "04",
"showing_at(3i)": "16",
"showing_at(4i)": "14",
"showing_at(5i)": "30",
"duration": 0.5,
"line1": "123 Main St",
"city": "Denver",
"state": "CO",
"zip": "80202",
"external_id": "ext-id-abc1234"
}
}
}
}

Response samples

Content type

application/json

{"message": "New property data collection successfully created.",
"body": [{"id": 1231,
"showing_request_id": 1257,
"showing_at": "2026-04-16T14:30:00.000-06:00",
"time_zone": "Mountain Time (US & Canada)",
"duration": 0.5,
"access_information": "Access information for the showing...",
"notes": "Private notes...",
"public_notes": "Public notes...",
"price": 50,
"payout": 32,
"charge_amount": 49,
"charge_details": [{"description": "Showing cost",
"amount": 5000
},
{"description": "Platinum member discount",
"amount": -100
}
],
"transfer_amount": 32,
"transfer_details": [{"description": "Showing payout",
"amount": 3200
}
],
"paid_group_amount": 32,
"status": "unassigned",
"showing_type": "property_data_collection",
"external_id": "ext-id-abc1234",
"standard_tz_identifier": "America/Denver",
"address": {"id": 1490,
"line1": "123 Main St",
"city": "Denver",
"state": "CO",
"zip": "80202",
"latitude": 39.6403007,
"longitude": -106.3736102
}
}
]
}

Users

API endpoints related to Users

Mark a User as a Favorite

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

type	string Enum: "add" "remove" If "add" is given, the user will be added as a favorite. If "remove" is given, the user will be removed as a favorite.

Responses

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"type": "add"
}

Response samples

Content type

application/json

{"message": "[email protected] added to your favorite agents!"
}

Mark a User as Blocked

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

type	string Enum: "add" "remove" If "add" is given, the user will be added as a blocked user for your account. If "remove" is given, the user will be removed as a blocked user.

Responses

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"type": "add"
}

Response samples

Content type

application/json

{"message": "[email protected] successfully blocked"
}

Add a User to an Organization

Add a new user to an organization with the specified user details.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json

object

email required	string The email address of the user to add to the organization
first_name required	string The first name of the user
last_name required	string The last name of the user
phone1 required	string The user's phone number (exactly 10 digits, no spaces or special characters)
license_state required	string The state where the user holds their license
agent_id required	string The license number of the user
agent_type required	string Enum: "initiating_agent" "showing_agent" "both" The type of agent
time_zone required	string Enum: "Alaska" "Arizona" "Central Time (US & Canada)" "Eastern Time (US & Canada)" "Hawaii" "Indiana (East)" "Mountain Time (US & Canada)" "Pacific Time (US & Canada)" The timezone of the user

Responses

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"user": {"email": "[email protected]",
"first_name": "Christopher",
"last_name": "Robbins",
"phone1": 7205551234,
"license_state": "CO",
"agent_id": "LIC12345678",
"agent_type": "both",
"time_zone": "Pacific Time (US & Canada)"
}
}

Response samples

Content type

application/json

{"message": "Successfully added user to organization."
}

Remove a User from an Organization

Remove a user from an organization, by email address.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

required

string

The email address of the user to remove from the organization.

Responses

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

Content type

application/json

{"message": "Successfully removed user from organization."
}

Consumers

API endpoints related to Consumers

Create Consumer

Create a consumer account under the authenticated brokerage.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

object

email	string The consumer's email
first_name	string The consumer's first name
last_name	string The consumer's last name
phone1	string The consumer's phone

Responses

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"user": {"email": "[email protected]",
"first_name": "Person",
"last_name": "McPerson",
"phone1": "5554441111"
}
}

Response samples

Content type

application/json

{"message": "Consumer successfully created."
}

Create Consumer Showing

You may create one or more consumer showing(s) using this action. It takes a JSON object containing the parameters of the showing.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

consumer

string

The consumer's email

object

buyer_type

integer

How the consumer will be showing up to the showing (individual, couple, family)

price

integer

Something

public_notes

string

Something

time_zone

string

Something

object (RentalShowingRequestPropertyWrapper)

object (RentalShowingRequestProperty)

showing_at(1i) required	string The year of the showing - e.g. "2023"
showing_at(2i) required	string The month of the showing - e.g. "12"
showing_at(3i) required	string The day of the showing - e.g. "30"
showing_at(4i) required	string The hour of the showing - e.g. "16"
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing - e.g. "15"
line1 required	string
line2	string
city required	string
state required	string
zip required	string

object (RentalShowingRequestProperty)

showing_at(1i) required	string The year of the showing - e.g. "2023"
showing_at(2i) required	string The month of the showing - e.g. "12"
showing_at(3i) required	string The day of the showing - e.g. "30"
showing_at(4i) required	string The hour of the showing - e.g. "16"
showing_at(5i) required	string Enum: "0" "15" "30" "45" The minute of the showing - e.g. "15"
line1 required	string
line2	string
city required	string
state required	string
zip required	string

Responses

Response Schema: application/json

integer

The id of the showing

showing_request_id

integer

The id of the showing request

showing_at

string

The date and time of the showing

duration

number

The duration of the showing

mls

string

The MLS number of the showing

notes

string

The private notes of the showing (visible to only the initiating agent and showing agent)

public_notes

string

The public notes of the showing

access_information

string

Instructions for accessing the property.

showing_group

string

The id of the showing group

buyer_name

string

The name of the buyer

buyer_phone

string

The buyer's phone number (exactly 10 digits, no spaces or special characters)

buyer_type

string

Enum: "individual" "couple" "family"

The type of buyer

buyer_external_id

string

An external identifier for the buyer from the calling/external system

price

integer

The price of the showing

payout

integer

The payout of the showing

paid_group_amount

integer

The total payout amount of all showings in the group

tip

integer

The tip of the showing

status

string

The status of the showing

who_cancelled

string

Enum: "SA" "BA"

Which user cancelled the showing

cancellation_notes

string

The notes of the cancellation

reposted

boolean

The reposted status of the showing

message_count

integer

The message count of the showing

counter_proposal_count

integer

The counter proposal count of the showing

reschedulable

boolean

If the showing is rescheduleable or not

rescheduling_requested

boolean

If the a showing rescheduling is requested or not

repostable

boolean

If the showing is repostable or not

counter_proposable

boolean

If the showing is counter proposable or not

who_schedules

string

Enum: "showing_agent" "buyers_agent"

Which user schedules the showing

schedule_details

string

The details of the schedule

amendable

boolean

If the showing is amendable or not

outstanding_amendment

boolean

If the showing has an outstanding amendment or not

review_allowed

boolean

If the showing is reviewable or not

no_show_eligible

boolean

If the showing is no show eligible or not

showing_type

string

The type of showing

original_showing_id

integer

The id of the original showing

external_id

string

The external id of the showing

external_app_url

string

A link into the calling/external app for this showing. When present, it is surfaced as a button on the showing views and can be rendered by the native app.

external_app_icon_path

string

The path to the partner app icon, derived from the organization's settings. Read-only; provided so the native app can render the partner icon alongside the external app link.

nar_buyer_agreement

boolean

The nar buyer agreement status of the showing

object (AddressResponse)

id	integer The id of the address
line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address
latitude	number The latitude of the address
longitude	number The longitude of the address

object (UserResponse)

integer

The id of the user

string

The email of the user

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object (ShowingAgentResponse)

integer

The id of the showing agent

string

The email of the showing agent

object (ProfileResponse)

first_name	string The first name of the user
last_name	string The last name of the user
phone1	string The user's phone number (exactly 10 digits, no spaces or special characters)
company	string The company of the user
agent_id	string The agent id of the user
license_state	string The license state of the user
agent_type	string The agent type of the user
avatar	string The avatar of the user
eula	boolean The EULA status of the user

object or null (ShowingAgentCancellationResponse)

Details about a cancellation made by the showing agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
reason	string Enum: "seller_cancelled" "unavailable" "other" "counter_proposal" "initiating_agent_requested" The reason for the cancellation
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

object or null (InitiatingAgentCancellationResponse)

Details about a cancellation made by the initiating agent

id	integer The id of the cancellation
showing_id	integer The id of the showing
cancel_type	string Enum: "cancel_one" "cancel_all" Whether to cancel one showing or all showings in the group
notes	string Additional notes about the cancellation
created_at	string When the cancellation was created

Array of objects (Showing Issue)

Issues reported against the showing, including those reported through the web UI. Use an issue's id to resolve it via the Resolve Showing Issue endpoint.

Array

id	integer The id of the showing issue. Use this to resolve the issue.
issue_type	string Enum: "sa_no_show" "buyer_no_show" "unsatisfactory_showing" "showing_canceled" "incomplete" "other" The type of issue reported.
notes	string Description of the issue.
resolved?	boolean True when the issue has been resolved.
resolved_at	string or null When the issue was resolved, or null if unresolved.
showing_agent_issue?	boolean True when the issue has been deemed a showing agent issue.
created_at	string When the issue was reported.
updated_at	string When the issue was last updated.

Array of objects (Tenant)

Array

id	integer The id of the tenant. Use this id to remove the tenant later via the Remove Tenant from Rental endpoint.
full_name	string
phone	string
tenant_type	string

Request samples

Payload

Content type

application/json

{"consumer": "[email protected]",
"showing_request": {"buyer_type": 0,
"price": 99,
"public_notes": "Public notes...",
"time_zone": "Eastern Time (US & Canada)",
"showing_request_properties_attributes": {"0": {"showing_at(1i)": "string",
"showing_at(2i)": "string",
"showing_at(3i)": "string",
"showing_at(4i)": "string",
"showing_at(5i)": "0",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"1": {"showing_at(1i)": "string",
"showing_at(2i)": "string",
"showing_at(3i)": "string",
"showing_at(4i)": "string",
"showing_at(5i)": "0",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"zip": "string"
}
}
}
}

Response samples

Content type

application/json

{"message": "Showing successfully created."
}

Referrals

API endpoints related to Referrals

Referral Requests

Create a new referral request

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Request Body schema: application/json
required

client_type

required

string

Enum: "buyer" "seller" "both"

The type of client

first_name

required

string

The first name of the referral client

last_name

required

string

The last name of the referral client

required

string

The email of the referral client

phone

required

string

The referred person's phone number (exactly 10 digits, no spaces or special characters)

target_price_range

required

string

Enum: "$100,000 - $200,000" "$200,001 - $300,000" "$300,001 - $400,000" "$400,001 - $500,000" "$500,001 - $600,000" "$600,001 - $700,000" "$700,001 - $800,000" "$800,001 - $900,000" "$900,001 - $1,000,000" "$1,000,001+"

The price range of the referral property, either buying or selling

mortgage_status

required

string

Enum: "Unknown / Has Not Applied" "Prequalified" "Preapproved" "Cash Buyer"

The buyer's mortgage status

min_beds

required

integer

Enum: 0 1 2 3 4 5 6 7

The minimum number of bedrooms in the desired referral property

min_baths

required

integer

Enum: 1 2 3 4 5 6 7

The minimum number of bathrooms in the desired referral property

details

string

An detailed explanation of the referral, from one agent to the other.

required

object (Address)

line1	string The first line of the address
line2	string The second line of the address
city	string The city of the address
state	string The state of the address
zip	string The zip code of the address

Responses

Response Schema: application/json

message

string

Response Schema: application/json

message

string

Request samples

Payload

Content type

application/json

{"client_type": "buyer",
"first_name": "Christopher",
"last_name": "Robbins",
"email": "[email protected]",
"phone": 7205551234,
"target_price_range": "$800,001 - $900,000",
"mortgage_status": "Unknown / Has Not Applied",
"min_beds": 3,
"min_baths": 2,
"details": "My client looking for a 3 bedroom, 2 bath home in the Denver area.",
"address": {"line1": "123 Main St",
"line2": "Apt 1",
"city": "Denver",
"state": "CO",
"zip": "80202"
}
}

Response samples

Content type

application/json

{"message": "Referral successfully created."
}

Price Suggestions

API Endpoints related to Showing Price Suggestions

Retrieve Price Suggestions

Get a suggested Showing price based on Showing Type, Zip and Duration

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

query Parameters

showing_type required	string The type of showing for which to get price suggestions. Ex/ standard, open_house, etc.
zip required	string The zip code for which to get price suggestions.
duration required	number The duration of the showing in hours.

Responses

Response Schema: application/json

suggested_price	number The suggested price in dollars.
price_suggestion_algorithm	string The algorithm used to generate the price suggestion.

Response samples

Content type

application/json

{"suggested_price": 80,
"price_suggestion_algorithm": "zip_average"
}

Reports

API endpoints to list and download Organization reports

List Available Reports

Return the list of reports the authenticated organization admin can download. Includes all standard reports applicable to the organization (subject to billing type and organization type restrictions) plus any custom reports assigned to the organization.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Responses

Response Schema: application/json

Array

id	integer The unique identifier of the report, used to download it.
name	string The human-readable name of the report.
description	string A short description of what the report contains.
standard	boolean True for reports available to all eligible organizations; false for reports custom-assigned to this organization.

Response samples

Content type

application/json

[{"id": 1,
"name": "Showings",
"description": "A list of showings that involve one or more of your agents.",
"standard": true
},
{"id": 7,
"name": "Agent Performance",
"description": "A custom report tailored to your organization.",
"standard": false
}
]

Download a Report

Download a report as a CSV file. The authenticated user must be an Organization Admin and must have access to the requested report (any standard report applicable to the organization, or a custom report assigned to the organization).

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

path Parameters

required

integer

The ID of the report to download (from GET /organizations/reports/).

query Parameters

start_date	string <date> Optional start of the report date range (YYYY-MM-DD). Only applied by reports that filter by date.
end_date	string <date> Optional end of the report date range (YYYY-MM-DD). Only applied by reports that filter by date.

Responses

Response Schema: text/csv

string <binary>

Webhooks

Showami webhooks

Showing Webhook

A webhook to receive showing data on any change of status for any showing that your user has initiated.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

header Parameters

X-Webhook-Signature

string

Example: sha256=4f1c0c3f0e9a2bb5...

HMAC-SHA256 signature of the raw request body, formatted sha256=<hex>, where the hash is HMAC-SHA256(signing_secret, raw_request_body). Present only when the receiving organization has enabled webhook signing.

Request Body schema: application/json

A serialized showing object

object

id	integer The id of the showing
showing_at	string The date and time of the showing
mls	string The MLS number of the property
notes	string Notes about the showing
showing_group	string The id of the showing group
buyer_name	string The name of the buyer
buyer_phone	string The buyer's phone number (exactly 10 digits, no spaces or special characters)
buyer_type	string The type of buyer
buyer_external_id	string An external identifier for the buyer from the calling/external system
status	string Enum: "unassigned" "unconfirmed" "confirmed" "completed" "cancelled" "expired" "no_show" "processing_payment" "paid" "cancelled_with_payment" "unassigned_with_preferred" "refunded" "in_progress" "closed_without_payment" The status of the showing
external_id	string An id to associate with the showing from the calling/external system

event_name

string

Enum: "showing_created" "showing_updated"

The name of the event

occurred_at

string <date-time>

The time the event occurred, in ISO 8601 format. Stable across delivery retries.

Responses

Request samples

Payload

Content type

application/json

{"body": {"showing": {"id": 123,
"showing_at": "2024-07-30T13:00:00.000-06:00",
"mls": "1234",
"notes": "Some notes...",
"showing_group": "6f2ds225-facd-99c5-84d0-cd98f221233",
"buyer_name": "Richard Feynman",
"buyer_phone": 7205551234,
"buyer_type": "individual",
"buyer_external_id": "buyer-abc-123",
"status": "unassigned",
"external_id": "asdf-1234"
},
"event_name": "showing_created",
"occurred_at": "2024-07-30T13:00:00.000-06:00"
}
}

Showing Rescheduling Webhook

A webhook to receive create/update of a reschedule showing request for a showing that you are associated with.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

header Parameters

X-Webhook-Signature

string

Example: sha256=4f1c0c3f0e9a2bb5...

Request Body schema: application/json

A serialized showing_rescheduling object

object

id	integer The id of the showing reschedule request
showing_id	integer The id of the showing to reschedule
showing_at	string The date and time of the requested showing time
requested_by	string The name of the user requesting the reschedule
notes	string Notes about the showing reschedule
rejection_reason	string The reason provided when the reschedule request was declined.
status	string Enum: "requested" "accepted" "rejected" The status of the reschedule request
buyer_external_id	string The external ID of the buyer from the associated showing

event_name

string

Enum: "showing_rescheduling_created" "showing_rescheduling_updated"

The name of the event

occurred_at

string <date-time>

The time the event occurred, in ISO 8601 format. Stable across delivery retries.

Responses

Request samples

Payload

Content type

application/json

{"body": {"showing_rescheduling": {"id": 123,
"showing_id": 456,
"showing_at": "2024-07-30T13:00:00.000-06:00",
"requested_by": "Richard Feynman",
"notes": "Notes explaining why a reschedule is requested",
"rejection_reason": "I have another showing at that time.",
"status": "requested",
"buyer_external_id": "buyer-1234"
},
"event_name": "showing_rescheduling_created",
"occurred_at": "2024-07-30T13:00:00.000-06:00"
}
}

Message Webhook

A webhook to receive notification of a new message on any showing that your user has initiated.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

header Parameters

X-Webhook-Signature

string

Example: sha256=4f1c0c3f0e9a2bb5...

Request Body schema: application/json

A serialized message object

object

id	integer The id of the message
showing_id	integer The id of the showing this message is associated with
user_id	integer The id of the user who sent the message
body	string The message body

event_name

string

Value: "message_created"

The name of the event

occurred_at

string <date-time>

The time the event occurred, in ISO 8601 format. Stable across delivery retries.

Responses

Request samples

Payload

Content type

application/json

{"body": {"message": {"id": 123,
"showing_id": 456,
"user_id": 789,
"body": "Hi there, thanks for ..."
},
"event_name": "message_created",
"occurred_at": "2024-07-30T13:00:00.000-06:00"
}
}

Showing Feedback Webhook

A webhook to receive notification of a new showing feedback on any showing that your user has initiated.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

header Parameters

X-Webhook-Signature

string

Example: sha256=4f1c0c3f0e9a2bb5...

Request Body schema: application/json

A serialized Showing Feedback object

object

integer

The id of the showing_feedback

showing_request_id

integer

The id of the showing request this feedback is associated with

Array of objects (Showing Feedback)

Array

showing_id

string

ID of the specific showing this feedback is for

showing_address

string

Address of the showing this feedback is for

showing_external_id

string

An ID to associate the showing with the external system

Array of objects (Showing Feedback Details)

Array

question_key	string Question key for this feedback question
question	string Question text for this feedback question
raw_response	string Original response value for this feedback question
human_readable_response	string Human readable response for this feedback question

event_name

string

Value: "showing_feedback_created"

The name of the event

occurred_at

string <date-time>

The time the event occurred, in ISO 8601 format. Stable across delivery retries.

Responses

Request samples

Payload

Content type

application/json

{"body": {"showing_feedback": {"id": 123,
"showing_request_id": 456,
"responses": [{"showing_id": "123",
"showing_address": "362 W 12th St. Denver CO, 80123",
"showing_external_id": "abc-1234-ext",
"feedback_responses": [{"question_key": "rental_completed",
"question": "Was the rental showing completed?",
"raw_response": "maybe",
"human_readable_response": "Maybe or N/A"
}
]
}
]
},
"event_name": "showing_feedback_created",
"occurred_at": "2024-07-30T13:00:00.000-06:00"
}
}

Counter Proposal Webhook

A webhook to receive notification of a new showing counter-proposal for any showing that your user has initiated.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

header Parameters

X-Webhook-Signature

string

Example: sha256=4f1c0c3f0e9a2bb5...

Request Body schema: application/json

A serialized Counter Proposal object

object

id	integer The id of the counter_proposal
showing_at	string The date and time of the proposed showing
user_name	string The first name and last initial of the user who created the counter_proposal
user_stars	float The star rating of the user who created the counter_proposal
time_zone	string The timezone of the new proposed showing time
payout	integer The proposed payout of the counter_proposal
price	integer The corresponding price of the proposed payout of the counter_proposal
notes	string The notes of the counter_proposal

event_name

string

Value: "counter_proposal_created"

The name of the event

occurred_at

string <date-time>

The time the event occurred, in ISO 8601 format. Stable across delivery retries.

Responses

Request samples

Payload

Content type

application/json

{"body": {"counter_proposal": {"id": 123,
"showing_at": "2024-07-30T13:00:00.000-06:00",
"user_name": "Richard F",
"user_stars": 4.5,
"time_zone": "Eastern Time (US & Canada)",
"payout": 79,
"price": 100,
"notes": "I could do this showing, but for a higher price."
},
"event_name": "counter_proposal_created",
"occurred_at": "2024-07-30T13:00:00.000-06:00"
}
}

Agent Check-In Webhook

A webhook to receive notification of a showing agent checking in to or out of any showing that your user has initiated.

Authorizations:

(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

header Parameters

X-Webhook-Signature

string

Example: sha256=4f1c0c3f0e9a2bb5...

Request Body schema: application/json

A serialized agent_checkin object

object

id	integer The id of the agent check-in
showing_id	integer The id of the showing the check-in belongs to
user_id	integer The id of the user (showing agent) who checked in or out
event_type	string Enum: "showing_checkin" "showing_checkout" Whether the agent checked in to or out of the showing
latitude	number <float> The latitude where the check-in occurred
longitude	number <float> The longitude where the check-in occurred
checkout_notes	string Notes left by the agent at checkout
created_at	string <date-time> The time the check-in was recorded
showing_external_id	string The external id of the showing the check-in belongs to
has_photo	boolean Whether a check-in photo was attached

event_name

string

Value: "agent_checkin_created"

The name of the event

occurred_at

string <date-time>

The time the event occurred, in ISO 8601 format. Stable across delivery retries.

Responses

Request samples

Payload

Content type

application/json

{"body": {"agent_checkin": {"id": 123,
"showing_id": 456,
"user_id": 789,
"event_type": "showing_checkin",
"latitude": 39.6403,
"longitude": -106.3742,
"checkout_notes": "Buyer loved the kitchen.",
"created_at": "2024-07-30T13:00:00.000-06:00",
"showing_external_id": "asdf-1234",
"has_photo": true
},
"event_name": "agent_checkin_created",
"occurred_at": "2024-07-30T13:00:00.000-06:00"
}
}

Showami (1.0)

API key access levels

Authentication

Authenticate with API

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Response Schema: application/json

Request samples

Response samples

Refresh Access Token

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Response Schema: application/json

Request samples

Response samples

Showings

Accepted Showings

Authorizations:

Responses

Response Schema: application/json

Response samples

Create Showing(s)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Accepted Showing by Id

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Showing Opportunities

Authorizations:

Responses

Response Schema: application/json

Response samples

Showings by Buyer External ID

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response samples

Showing Requests

Authorizations:

Responses

Response Schema: application/json

Response samples

Showing Request by Id

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Cancel Showing

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response samples

Initiating Agent Cancel

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Response Schema: application/json

Response Schema: application/json

Request samples

Response samples

Counter Proposals

Authorizations:

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required