Users: GetUsers

Returns a list of users associated with an account based on the criteria that you specify.

Request

HTTP request

GET /v2/accounts/{accountId}/users

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The id of the account.

Optional Query Parameters
filterstring

(Optional) Filters results by name and email address. This is a "starts with" filter, which means that you can enter only the beginning of a name or email address.

Note: You do not use a wildcard with this filter.

sortstring

(Optional) Specifies how to sort the results. Valid values are:

  • FirstNameAsc
  • LastNameAsc
  • EmailAsc
  • FirstNameDesc
  • LastNameDesc
  • EmailDesc

defaultOfficeIdinteger

(Optional) Filters for users who have this office id as their default office id.

accessLevelstring

(Optional) Filters for users who have the specified access level. A user's access level and role determine the types of resources and actions that are available to them.

Valid values are:

  • Company: Users with this access level can administer resources across the company.
  • Region: Users with this access level can administer offices and other resources within their regions.
  • Office: Users with this access level can administer resources within their offices.
  • Contributor: Users with this access level can only administer their own resources.

Note: In requests, the values that you may use for this property depend on your permissions and whether you can add users at your access level or lower. This property applies only to Rooms Version 6.

titleIdinteger

(Optional) For Rooms Version 5 only, filters for users whose managers have the specified titleId.

roleIdinteger

(Optional) For Rooms Version 6 only, filters for users who have the specified roleId.

statusstring

(Optional) Filters for users who have the specified status.

Valid values are:

  • Active: The user is active.
  • Pending: The user has been invited but has not yet accepted the invitation.

lockedOnlyboolean

(Optional) When set to true, filters for users whose accounts are locked.

startPositioninteger

(Optional) The starting zero-based index position within the result set from which to begin the response. The default is 0.

countinteger

(Optional) The maximum number of users to return in the response. This value must be a number between 1 and 100 (default).

Responses

CodeDescriptionReference
200

Users information successfully retrieved.

UserSummaryList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Users::GetUsers

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.

UserSummary

Contains details about a 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.

isLockedOutboolean

When set to true, an administrator has locked the user's account. For example, an administrator might want to lock an agent's account after they leave the brokerage until they determine how to transfer the agent's rooms and data to another active user.

statusstring

The user's status. Possible values are:

  • Active
  • Pending

accessLevelstring

The user's level of access to the account. This property determines what the user can see in the system.

In contrast, a user's permissions determine the actions that they can take in a room. For example, a user who has accessLevel set to Company can see all of the rooms associated with their company. However, if they do not have a role for which the Add documents to room permission is set to true, they can't add documents to those rooms.

Valid values are:

  • Company: The user has access to rooms, and if they have permission to manage users, they have access to users across the entire company. What they can do in the rooms and with users is controlled by their permissions. This is the default for the Users::InviteClassicAdmin method.
  • Region: The user has access to rooms and, if they have permission to manage users, they have access to users across their regions.
  • Office: The user has access to rooms and, if they have permission to manage users, they have access to users across their offices.
  • Contributor: The user has access only to their own rooms and those to which they are invited. They cannot perform any user management actions because they do not oversee other users. For example, agents typically have the Contributor access level.

Note: In requests, the values that you may use for this property depend on your permissions and whether you can add users at your access level or lower.

defaultOfficeIdinteger

The id of the user's default office.

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.

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.

profileImageUrlstring

The URL for the user's profile image.

UserSummaryList

Contains a list of users.

userSummaries[UserSummary]

A list of users.

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.

}} />