API Reference version 2

View user

GET/v2/user/{id_or_email}

Get a user's details.

Authentication required, with scope view_group.
Accessible by group clients, users.

Path parameters

Type Parameter Description Required?
string id_or_email

The id, email address, or mention name (beginning with an '@') of the user to view.

Required
200 application/json
Type Property Description Required?
string xmpp_jid

XMPP/Jabber ID of the user.

Required
boolean is_deleted

Whether the user has been deleted or not.

Required
string name

User's full name

Required
string last_active

The date in ISO-8601 when the user was last active

May be null.

Required
string title

User's title

Required
object presence

Presence information for the user

May be null.

Required
string status

The status message of the user

integer idle

The number of seconds this user has been idle

string show

The status to show for the user

Valid values: away, chat, dnd, xa.

object client

Information about the client connected to HipChat. Only shown if the client is currently online.

string version

The version of the client they are using to connect to HipChat.

May be null.

Required
string type

The client they are using to connect to HipChat.

May be null.

Required
boolean is_online

If the user is currently online or not

Required
string created

The date in ISO-8601 when the user was created

Required
integer id

User's ID

Required
string mention_name

User's @mention name

Required
string version

An etag-like random version string.

Required
array roles

The list of roles for the user

Required
boolean is_group_admin

Whether or not this user is an admin of the group.

Defaults to false.

Required
string timezone

The desired user timezone

Required
boolean is_guest

Whether or not this user is a guest or registered user.

Defaults to false.

Required
string email

User's email

May be null.

Required
string photo_url

URL to user's photo. 125px on the longest side.

May be null.

Required