Rooms: GetRoomUsers

This method returns a list of users associated with a room.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room.

accountIdstring

(Required) The id of the account.

Optional Query Parameters
countinteger

(Optional) The number of results to return. This 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.

filterstring

(Optional) A search filter that returns users by the beginning of the user's first name, last name, or email address. You can enter the beginning of the name or email only to return all of the users whose names or email addresses begin with the text that you entered.

Note: You do not enter a wildcard (*) at the end of the name or email fragment.

sortstring

(Optional) The order in which to return results. Valid values are:

  • firstNameAsc: Sort on first name in ascending order.
  • firstNameDesc: Sort on first name in descending order.
  • lastNameAsc: Sort on last name in ascending order.
  • lastNameDesc: Sort on last name in descending order. This is the default value.

Responses

CodeDescriptionReference
200

The room user was successfully retrieved.

RoomUsersResult
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError
404

The room was not found.

SDK Method

Rooms::GetRoomUsers

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.

RoomUsersResult

This complex type contains details about the users associated with a room.

users[RoomUserSummary]

An array of RoomUser 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.

RoomUserSummary

Contains details about a room user.

userIdinteger

The id of the user.

emailstring

The user's email address.

firstNamestring

The user's first name.

lastNamestring

The user's last name.

transactionSideIdstring

The id of the transaction side. Valid values are:

  • buy
  • sell
  • listbuy
  • refi

roleIdinteger

In Rooms v6, this is the id of the company role assigned to the user.

You can assign external roles to users who aren't a part of your organization.

Note: If you are using Rooms v6, you must enter a roleId in requests. If you are using Rooms v5, you must enter a value for the titleId property instead.

titleIdinteger

In Rooms Version 5, this is the id of the custom job title for a Manager role within your company. For example, your company might have the custom job titles "Transaction Coordinator" and "Office Manager".

Note: If you are using Rooms Version 5, you must enter a titleId when using the Users::InviteClassicManager method. (The titleId property is empty for Agent users on Rooms Version 5.) If you are using Rooms Version 6, use the Users::InviteUser method with the roleId property instead.

}} />