Showami (1.0)

Download OpenAPI specification:

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

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

Content type
application/json
{}

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

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
id
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

showing_group
string

The id of the showing group

buyer_name
string

The name of the buyer

buyer_phone
string

The phone number of the buyer

buyer_type
string
Enum: "individual" "couple" "family"

The type of buyer

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"

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

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)
id
integer

The id of the user

email
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 primary phone number of the user

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)
id
integer

The id of the showing agent

email
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 primary phone number of the user

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

Response samples

Content type
application/json
[
  • {
    }
]

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. Note, the exact string value are also accepted.

buyer_name
required
string

The buyer's name

buyer_phone
required
string

The buyer's phone

buyer_type
required
integer

0 - individual, 1 - couple, 2 - family

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 <= 1000 characters
public_notes
string <= 1000 characters
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)'

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
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
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

Content type
application/json
{
  • "showing_request": {
    }
}

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
id
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

showing_group
string

The id of the showing group

buyer_name
string

The name of the buyer

buyer_phone
string

The phone number of the buyer

buyer_type
string
Enum: "individual" "couple" "family"

The type of buyer

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"

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

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)
id
integer

The id of the user

email
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 primary phone number of the user

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)
id
integer

The id of the showing agent

email
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 primary phone number of the user

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

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...",
  • "showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
  • "buyer_name": "Sally Ride",
  • "buyer_phone": "5551231234",
  • "buyer_type": "individual",
  • "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",
  • "nar_buyer_agreement": true,
  • "address": {
    },
  • "user": {
    },
  • "showing_agent": {
    }
}

Showing opportunities

All Showing opportunities that match the Showing Agent preferences.

Authorizations:
(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Responses

Response Schema: application/json
Array
id
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

showing_group
string

The id of the showing group

buyer_name
string

The name of the buyer

buyer_phone
string

The phone number of the buyer

buyer_type
string
Enum: "individual" "couple" "family"

The type of buyer

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"

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

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)
id
integer

The id of the user

email
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 primary phone number of the user

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)
id
integer

The id of the showing agent

email
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 primary phone number of the user

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

Response samples

Content type
application/json
[
  • {
    }
]

Showing Requests

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

Authorizations:
(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)

Responses

Response Schema: application/json
Array
id
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

showing_group
string

The id of the showing group

buyer_name
string

The name of the buyer

buyer_phone
string

The phone number of the buyer

buyer_type
string
Enum: "individual" "couple" "family"

The type of buyer

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"

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

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)
id
integer

The id of the user

email
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 primary phone number of the user

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)
id
integer

The id of the showing agent

email
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 primary phone number of the user

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

Response samples

Content type
application/json
[
  • {
    }
]

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
id
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

showing_group
string

The id of the showing group

buyer_name
string

The name of the buyer

buyer_phone
string

The phone number of the buyer

buyer_type
string
Enum: "individual" "couple" "family"

The type of buyer

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"

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

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)
id
integer

The id of the user

email
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 primary phone number of the user

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)
id
integer

The id of the showing agent

email
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 primary phone number of the user

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

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...",
  • "showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
  • "buyer_name": "Sally Ride",
  • "buyer_phone": "5551231234",
  • "buyer_type": "individual",
  • "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",
  • "nar_buyer_agreement": true,
  • "address": {
    },
  • "user": {
    },
  • "showing_agent": {
    }
}

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."
}

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

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",
  • "feedback_responses": [
    ]
}

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.

Responses

Response Schema: application/json
message
string

Request samples

Content type
application/json
{
  • "showing_rescheduling": {
    }
}

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

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. Note, the exact string value are also accepted.

buyer_name
required
string

The buyer's name

buyer_phone
required
string

The buyer's phone

buyer_type
required
integer

0 - individual, 1 - couple, 2 - family

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 <= 1000 characters
public_notes
string <= 1000 characters
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)'

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
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
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

Content type
application/json
{
  • "showing_request": {
    }
}

Response samples

Content type
application/json
{
  • "prediction": 0.85,
  • "warnings": [
    ]
}

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 <= 1000 characters
public_notes
string <= 1000 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

Content type
application/json
{
  • "showing_request": {
    }
}

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

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
id
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

showing_group
string

The id of the showing group

buyer_name
string

The name of the buyer

buyer_phone
string

The phone number of the buyer

buyer_type
string
Enum: "individual" "couple" "family"

The type of buyer

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"

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

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)
id
integer

The id of the user

email
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 primary phone number of the user

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)
id
integer

The id of the showing agent

email
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 primary phone number of the user

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

Response samples

Content type
application/json
[
  • {
    }
]

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

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 <= 1000 characters
notes
string <= 1000 characters
access_information
required
string
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
id
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

showing_group
string

The id of the showing group

buyer_name
string

The name of the buyer

buyer_phone
string

The phone number of the buyer

buyer_type
string
Enum: "individual" "couple" "family"

The type of buyer

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"

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

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)
id
integer

The id of the user

email
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 primary phone number of the user

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)
id
integer

The id of the showing agent

email
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 primary phone number of the user

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

Request samples

Content type
application/json
{
  • "showing_request": {
    }
}

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...",
  • "showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
  • "buyer_name": "Sally Ride",
  • "buyer_phone": "5551231234",
  • "buyer_type": "individual",
  • "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",
  • "nar_buyer_agreement": true,
  • "address": {
    },
  • "user": {
    },
  • "showing_agent": {
    }
}

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."
}

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
id
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

showing_group
string

The id of the showing group

buyer_name
string

The name of the buyer

buyer_phone
string

The phone number of the buyer

buyer_type
string
Enum: "individual" "couple" "family"

The type of buyer

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"

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

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)
id
integer

The id of the user

email
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 primary phone number of the user

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)
id
integer

The id of the showing agent

email
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 primary phone number of the user

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

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...",
  • "showing_group": "40ea31cf-e81b-4c0a-853b-8314b6094aef",
  • "buyer_name": "Sally Ride",
  • "buyer_phone": "5551231234",
  • "buyer_type": "individual",
  • "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",
  • "nar_buyer_agreement": true,
  • "address": {
    },
  • "user": {
    },
  • "showing_agent": {
    }
}

Users

API endpoints related to Users

Mark a user as a favorite

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

Content type
application/json
{
  • "type": "add"
}

Response samples

Content type
application/json
{}

Mark a user as blocked

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

Content type
application/json
{
  • "type": "add"
}

Response samples

Content type
application/json
{}

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 primary phone number of the user.

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: "showing_agent" "buyers_agent" "both"

The type of agent (showing_agent, buyers_agent, or both).

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

Content type
application/json
{
  • "user": {
    }
}

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
email
required
string

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

Responses

Response Schema: application/json
message
string

Request samples

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

Content type
application/json
{
  • "user": {
    }
}

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
id
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

showing_group
string

The id of the showing group

buyer_name
string

The name of the buyer

buyer_phone
string

The phone number of the buyer

buyer_type
string
Enum: "individual" "couple" "family"

The type of buyer

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"

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

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)
id
integer

The id of the user

email
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 primary phone number of the user

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)
id
integer

The id of the showing agent

email
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 primary phone number of the user

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

Request samples

Content type
application/json
{
  • "consumer": "[email protected]",
  • "showing_request": {
    }
}

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"

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

email
required
string

The email of the referral client

phone
required
string

The phone number of the referred Person

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.

desired_commision
required
string
Enum: "15%" "20%" "25%" "30%" "35%"

The desired commission percentage for the referral

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

Content type
application/json
{
  • "client_type": "buyer",
  • "first_name": "Person",
  • "last_name": "McPerson",
  • "email": "[email protected]",
  • "phone": 7776665555,
  • "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.",
  • "desired_commision": "25%",
  • "address": {
    }
}

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"
}

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)
Request Body schema: application/json

A serialized showing object

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 phone number of the buyer

buyer_type
string

The type of buyer

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 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

Responses

Request samples

Content type
application/json
{
  • "body": {
    }
}

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)
Request Body schema: application/json

A serialized showing_rescheduling object

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

status
string
Enum: "requested" "accepted" "rejected"

The status of the reschedule request

event_name
string
Enum: "showing_rescheduling_created" "showing_rescheduling_updated"

The name of the event

Responses

Request samples

Content type
application/json
{
  • "body": {
    }
}

Message Webhook

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

Authorizations:
(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)
Request Body schema: application/json

A serialized message object

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

Responses

Request samples

Content type
application/json
{
  • "body": {
    }
}

Showing Feedback Webhook

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

Authorizations:
(APIKeyHeaderUserEmailHeaderUserTokenHeader) (APIKeyHeaderoAuth2Password)
Request Body schema: application/json

A serialized Showing Feedback object

object
object
id
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

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

Responses

Request samples

Content type
application/json
{
  • "body": {
    }
}

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)
Request Body schema: application/json

A serialized Counter Proposal object

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

Responses

Request samples

Content type
application/json
{
  • "body": {
    }
}