Rooms: GetRooms

This method returns details about the rooms that the current user has permissions to view.

Note: By default, this method only returns open rooms. To return other rooms, use the roomStatus query parameter.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The id of the account.

Optional Query Parameters
countinteger

(Optional) The number of results. When this property is used as a request parameter specifying the number of results to return, the value must be a number between 1 and 100 (default).

startPositioninteger

(Optional) The index position within the total result set from which to start returning values. The default value is 0.

roomStatusstring

(Optional) The status of the room. Valid values are:

  • active: This is the default value.
  • pending
  • open: Includes both active and pending statuses.
  • closed

To return rooms with multiple statuses, enter a comma-separated list of statuses.

Example:

closed,open

officeIdinteger

(Optional) The id of the office.

Responses

CodeDescriptionReference
200

Rooms successfully retrieved.

RoomSummaryList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::GetRooms

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.

RoomSummary

This object contains details about a room.

roomIdinteger

The id of the room.

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.

RoomSummaryList

This complex type contains details about rooms.

rooms[RoomSummary]

An array of roomSummary objects.

resultSetSizeinteger

The number of results returned in this response.

startPositioninteger

The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is 0.

endPositioninteger

The last zero-based index position in the result set.

nextUristring

The URI for the next chunk of records based on the search request. This property is null for the last set of search results.

priorUristring

The URI for the previous chunk of records based on the search request. This property is null for the first set of search results.

}} />