Download OpenAPI specification:
The Showami API for creating, accepting, and updating showings and rentals.
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
object | |||||
| |||||
| access_token | string Access Tokens expire 24 hours after issue |
| refresh_token | string |
| message | string |
{
}{- "access_token": "lmn456",
- "refresh_token": "xyz890"
}Generate fresh Access Token from valid Refresh Token. This also cycles the Refresh token and returns a new one.
| refresh_token | string |
| access_token | string Access Tokens expire 24 hours after issue |
| refresh_token | string |
| message | string |
{- "refresh_token": "abc123"
}{- "access_token": "lmn456",
- "refresh_token": "xyz890"
}Get a list of all Showings where the authenticated user is the Showing Agent.
| 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) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (UserResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (ShowingAgentResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
[- {
- "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": {
- "id": 123,
- "line1": "123 Main St",
- "line2": "Apt 1",
- "city": "Denver",
- "state": "CO",
- "zip": "80202",
- "latitude": 39.7392358,
- "longitude": -104.990251
}, - "user": {
- "id": 456,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}, - "showing_agent": {
- "id": 123,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}
}
]Create a new Showing or multiple Showings
object (ShowingRequest) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message | string |
{- "showing_request": {
- "showing_type": 0,
- "buyer_name": "Person McPerson",
- "buyer_phone": "5554441111",
- "buyer_type": 0,
- "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)",
- "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"
}
}
}
}{- "message": "string"
}Get the details of a showing where the user is the Showing Agent.
| showing_id required | integer |
| 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) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (UserResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (ShowingAgentResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
{- "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": {
- "id": 123,
- "line1": "123 Main St",
- "line2": "Apt 1",
- "city": "Denver",
- "state": "CO",
- "zip": "80202",
- "latitude": 39.7392358,
- "longitude": -104.990251
}, - "user": {
- "id": 456,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}, - "showing_agent": {
- "id": 123,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}
}All Showing opportunities that match the Showing Agent preferences.
| 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) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (UserResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (ShowingAgentResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
[- {
- "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": {
- "id": 123,
- "line1": "123 Main St",
- "line2": "Apt 1",
- "city": "Denver",
- "state": "CO",
- "zip": "80202",
- "latitude": 39.7392358,
- "longitude": -104.990251
}, - "user": {
- "id": 456,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}, - "showing_agent": {
- "id": 123,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}
}
]Get a list of all showings where the user is the Initiating Agent.
| 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) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (UserResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (ShowingAgentResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
[- {
- "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": {
- "id": 123,
- "line1": "123 Main St",
- "line2": "Apt 1",
- "city": "Denver",
- "state": "CO",
- "zip": "80202",
- "latitude": 39.7392358,
- "longitude": -104.990251
}, - "user": {
- "id": 456,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}, - "showing_agent": {
- "id": 123,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}
}
]Get the details of a showing where the user is the Initiating Agent.
| showing_request_id required | integer |
| 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) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (UserResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (ShowingAgentResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
{- "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": {
- "id": 123,
- "line1": "123 Main St",
- "line2": "Apt 1",
- "city": "Denver",
- "state": "CO",
- "zip": "80202",
- "latitude": 39.7392358,
- "longitude": -104.990251
}, - "user": {
- "id": 456,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}, - "showing_agent": {
- "id": 123,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}
}You may cancel an existing showing for which you have initiated.
| showing_id required | integer |
| message | string |
| message | string |
{- "message": "Showing successfully canceled."
}Get a list of all Showing feedbacks for this request
| 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
| |||||||||
{- "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"
}
]
}Create a reschedule request for a showing for which you are either the initiating agent or showing agent.
object | |||||||||||||||
| |||||||||||||||
| message | string |
{- "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..."
}
}{- "message": "Requested to reschedule showing"
}Accept or Reject a rescheduling request for a showing.
| showing_rescheduling_id required | integer |
| status required | string Enum: "accept" "decline" Whether to accept or decline the rescheduling request. |
| message | string |
| message | string |
{- "status": "accept"
}{- "message": "Accepted rescheduling"
}Get a prediction of whether a showing will be accepted based on the showing request parameters.
object (ShowingRequest) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| prediction | number The acceptance probability between 0 and 1 |
| warnings | Array of strings |
{- "showing_request": {
- "showing_type": 0,
- "buyer_name": "Person McPerson",
- "buyer_phone": "5554441111",
- "buyer_type": 0,
- "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)",
- "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"
}
}
}
}{- "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..."
]
}Create a new Task List
object (TaskRequest) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message | string |
| message | string |
{- "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"
}
}
}
}{- "message": "string"
}Mark a Task List as Accepted
| task_id required | integer |
| status required | string Enum: "approve" "reject" Whether to approve or reject the task. |
| message | string |
| message | string |
{- "status": "approve"
}{- "message": "Task Accepted"
}Get a paginated list of all rental showings initiated by the authenticated user.
| page | integer |
| 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) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (UserResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (ShowingAgentResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
[- {
- "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": {
- "id": 123,
- "line1": "123 Main St",
- "line2": "Apt 1",
- "city": "Denver",
- "state": "CO",
- "zip": "80202",
- "latitude": 39.7392358,
- "longitude": -104.990251
}, - "user": {
- "id": 456,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}, - "showing_agent": {
- "id": 123,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}
}
]You may create one or more rental showing(s) using this action. It takes a JSON object containing the parameters of the showing.
object (RentalShowingRequest) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (UserResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (ShowingAgentResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
{- "showing_request": {
- "tenant_name": "Person McPerson",
- "tenant_phone": "5554441111",
- "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",
- "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"
}
}
}
}{- "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": {
- "id": 123,
- "line1": "123 Main St",
- "line2": "Apt 1",
- "city": "Denver",
- "state": "CO",
- "zip": "80202",
- "latitude": 39.7392358,
- "longitude": -104.990251
}, - "user": {
- "id": 456,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}, - "showing_agent": {
- "id": 123,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}
}You may cancel an existing rental showing.
| rental_id required | integer |
| message | string |
{- "message": "Rental successfully canceled."
}Get a serialized rental showing object by its id, initiated by the authenticated user.
| rental_id required | integer |
| page | integer |
| 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) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (UserResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (ShowingAgentResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
{- "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": {
- "id": 123,
- "line1": "123 Main St",
- "line2": "Apt 1",
- "city": "Denver",
- "state": "CO",
- "zip": "80202",
- "latitude": 39.7392358,
- "longitude": -104.990251
}, - "user": {
- "id": 456,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}, - "showing_agent": {
- "id": 123,
- "profile": {
- "first_name": "Richard",
- "last_name": "Feynman",
- "phone1": "5551231234",
- "company": "Properties Inc.",
- "agent_id": "AN12345678",
- "license_state": "CO",
- "agent_type": "showing_agent",
- "avatar": "base64encodedstring",
- "eula": true
}
}
}Mark a user as a favorite
| 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. |
| message | string |
{- "type": "add"
}{- "message": "[email protected] added to your favorite agents!"
}Mark a user as blocked
| 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. |
| message | string |
{- "type": "add"
}{- "message": "[email protected] successfully blocked"
}Add a new user to an organization with the specified user details.
object | |||||||||||||||||
| |||||||||||||||||
| message | string |
{- "user": {
- "first_name": "Jason",
- "last_name": "Smith",
- "phone1": "9998887777",
- "license_state": "CO",
- "agent_id": "LIC12345678",
- "agent_type": "both",
- "time_zone": "Pacific Time (US & Canada)"
}
}{- "message": "Successfully added user to organization."
}Remove a user from an organization, by email address.
| email required | string The email address of the user to remove from the organization. |
| message | string |
{- "email": "string"
}{- "message": "Successfully removed user from organization."
}Create a consumer account under the authenticated brokerage.
object | |||||||||
| |||||||||
| message | string |
{- "user": {
- "first_name": "Person",
- "last_name": "McPerson",
- "phone1": "5554441111"
}
}{- "message": "Consumer successfully created."
}You may create one or more consumer showing(s) using this action. It takes a JSON object containing the parameters of the showing.
| consumer | string The consumer's email | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (UserResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object (ShowingAgentResponse) | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
{- "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"
}
}
}
}{- "message": "Showing successfully created."
}Create a new referral request
| 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) | ||||||||||
| |||||||||||
| message | string |
| message | string |
{- "client_type": "buyer",
- "first_name": "Person",
- "last_name": "McPerson",
- "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": {
- "line1": "123 Main St",
- "line2": "Apt 1",
- "city": "Denver",
- "state": "CO",
- "zip": "80202"
}
}{- "message": "Referral successfully created."
}Get a suggested Showing price based on Showing Type, Zip and Duration
| 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. |
| suggested_price | number The suggested price in dollars. |
| price_suggestion_algorithm | string The algorithm used to generate the price suggestion. |
{- "suggested_price": 80,
- "price_suggestion_algorithm": "zip_average"
}A webhook to receive showing data on any change of status for any showing that your user has initiated.
A serialized showing object
object | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
{- "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": "5554441111",
- "buyer_type": "individual",
- "status": "unassigned",
- "external_id": "asdf-1234"
}, - "event_name": "showing_created"
}
}A webhook to receive create/update of a reschedule showing request for a showing that you are associated with.
A serialized showing_rescheduling object
object | |||||||||||||||||||
| |||||||||||||||||||
{- "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",
- "status": "requested"
}, - "event_name": "showing_rescheduling_created"
}
}A webhook to receive notification of a new message on any showing that your user has initiated.
A serialized message object
object | |||||||||||||||
| |||||||||||||||
{- "body": {
- "message": {
- "id": 123,
- "showing_id": 456,
- "user_id": 789,
- "body": "Hi there, thanks for ..."
}, - "event_name": "message_created"
}
}A webhook to receive notification of a new showing feedback on any showing that your user has initiated.
A serialized Showing Feedback object
object | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
{- "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"
}
}A webhook to receive notification of a new showing counter-proposal for any showing that your user has initiated.
A serialized Counter Proposal object
object | |||||||||||||||||||||||
| |||||||||||||||||||||||
{- "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"
}
}