Get User

Request

GET /v2/users/4 HTTP/1.1
Authorization: Bearer oauth_token

Path Parameters

/v2/users/{userId}

Response

HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=2E013749EF224A5C38253AEB71191688; Path=/; HttpOnly
Content-Type: application/hal+json

{
  "id" : 4,
  "firstName" : "Vernon",
  "lastName" : "Bear",
  "email" : "bear@acme.com",
  "role" : "owner",
  "timezone" : "America/New_York",
  "photoUrl" : "http://somesite.com/images/avatar.jpg",
  "createdAt" : "2011-04-01T03:18:33Z",
  "updatedAt" : "2012-07-24T20:18:33Z",
  "type" : "user",
  "mention" : "vernon",
  "initials" : "VB",
  "jobTitle" : "Honey Master",
  "phone" : "555-2368",
  "alternateEmails" : [ "bear@forest.com" ],
  "_links" : {
    "self" : {
      "href" : "..."
    }
  }
}

Response fields

Path Type Description
id Number Unique identifier
firstName String First name of the User
lastName String Last name of the User
email String Email address
createdAt String UTC time when this user was created.
updatedAt String UTC time when this user was modified.
role String Role of this user. Accepted values are:
owner
admin
user
light user
timezone String User’s timezone
type String User type - team or user
photoUrl String The user’s photo, if one exists
initials String Users’s initials
mention String Mention handle - it can be used to mention users in the thread body using the @mention format
jobTitle String User’s job title
phone String User’s phone
alternateEmails Array Additional emails
↑Back to top
© Help Scout 2024