Rooms: GetRoom

This method returns details about a specific room.

Request

HTTP request

GET /v2/accounts/{accountId}/rooms/{roomId}

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room.

accountIdstring

(Required) The id of the account.

Optional Query Parameters
includeFieldDataboolean

(Optional) When set to true, the response includes the field data from the room. This is the information that appears on the room's Details tab.

Responses

CodeDescriptionReference
200

Room successfully retrieved.

Room
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::GetRoom

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Nullable[FieldData]

Contains the field data associated with a room.

dataobject

A data dictionary of key-value pairs that correspond to the properties of the room and their values. To view a list of the available keys, use the Fields::GetFieldSet method. In the response, the values for apiName indicate the fields or keys that you can specify in this object.

Room

Contains details about a room.

roomIdinteger

The id of the room.

companyIdinteger

The id of the company.

namestring

The name of the room.

officeIdinteger

The id of the office. This is the id that the system generated when you created the office.

createdDatestring

The UTC date and time when the item was created. This is a read-only value that the service assigns.

Example: 2019-07-17T17:45:42.783Z

submittedForReviewDatestring

The UTC DateTime when the room was submitted for review.

Note: In Rooms v5, this is when an agent submitted the room to a manager. In Rooms v6, this is when a member with a role for which the Submit rooms for review permission is set to true submitted the room to a member with a role for which the Review and close rooms permission is set to true.

closedDatestring

The UTC date and time when the room was closed.

rejectedDatestring

The date on which the reviewer rejected the room. For example, a reviewer might reject closing a room if documentation is missing or the details are inaccurate.

createdByUserIdinteger

The id of the user who created the room.

rejectedByUserIdinteger

The id of the user who rejected the room.

closedStatusIdstring

The reason why a room was closed. Possible values are:

  • sold: Property sold.
  • dup: Duplicate room.
  • escrcncl: Escrow canceled.
  • inspctn: Inspection issues.
  • exp: Listing expired.
  • lostbuy: Buyer withdrew.
  • list: Listing withdrawn.
  • newlist: New listing.
  • offrrjct: Offer not accepted.
  • pend: Pending. An agent might use this status to temporarily hide a room from their Active rooms view if they are blocked on a task. When they are ready to reopen the room, they can quickly find it by filtering for rooms in pending status.
  • lstcanc: Listing canceled.
  • lstleave: Listing released.
  • sellwtdw: Seller withdrew.
  • nofin: Buyer unable to finance.
  • disciss: Property disclosure issue.
  • appiss: Appraisal issues.
  • mtgiss: Mortgage issues. Use when details about why the buyer wasn't able to obtain financing are unknown.
  • zoniss: Zoning issues.
  • attiss: Attorney review issues.
  • proplsd: Property leased. Use for the list side of the transaction.
  • tenlease: Tenant signed lease. Use when an agent helps renters find a to lease.

fieldDataNullable[FieldData]

The room details, such as yearBuilt and originalListingAmount. This is the information that appears on a room's Details tab.

}} />