Chatter REST API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

User Summary

Property Type Description Filter Group and Version Available Version
additional​Label String An additional label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.” If the user doesn’t have an additional label, the value is null. Small, 30.0 30.0
community​Nickname String User’s nickname in the community Medium, 32.0 32.0
companyName String Name of the company Small, 29.0 23.0
displayName String User’s name that is displayed in the community. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed. Small, 32.0 32.0
firstName String User's first name Small, 29.0 23.0
id String 18-character ID Small, 29.0 23.0
isActive Boolean true if user is active, false otherwise. Small, 29.0 25.0
isChatter​Guest Boolean

This property is no longer available as of version 26.0. Use the userType property instead.

Note

true if user is a Chatter customer, false otherwise		 23.0–26.0
isInThis​Community Boolean true if user is in the same community as the context user; false otherwise. Can be false for record feed @mentions on posts with the scope “All Users.” Small, 29.0 28.0
lastName String User's last name Small, 29.0 23.0
motif Motif Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color.

The motif icon is not the user’s profile photo.

 Small, 29.0 27.0
mySubscription Reference If the context user is following this user, this contains information about the subscription, else returns null Medium, 29.0 23.0
name String Locale-based concatenation of first and last names Small, 29.0 23.0
photo Photo Information about the user's photo Small, 29.0 23.0
recordViewUrl String The URL of the Chatter REST API record view resource for this record, or null if this record does not have a record view layout, or if “Connect Records API” is not enabled for this organization, or if the record type isn’t supported. Small, 30.0 30.0
reputation Reputation Reputation of the user in the community, which is determined by the number of points earned from events and actions performed in the community Big, 32.0 32.0
title String Title of the user Small, 29.0 23.0
type String User Small, 29.0 23.0
url String URL to the user's Chatter profile Small, 29.0 23.0
userType String Specifies the type of user. Valid values are:
  • ChatterGuest—User is an external user in a private group.
  • ChatterOnly—User is a Chatter Free customer.
  • Guest—User is unauthenticated .
  • Internal—User is a standard organization member.
  • Portal—User is an external user in a customer portal, partner portal, or community.
  • System—User is Chatter Expert or a system user.
  • Undefined—User is a user type that is a custom object.
 Medium, 29.0 26.0

Example

If the user's name is Chatter Expert and the return contains mostly null values, it indicates that the Chatter Expert user is either deactivated or taken over by an administrator, or the organization was created before Salesforce introduced the Chatter Expert user. This is a special user that offers tips, tricks, and sample posts to help users get started with Chatter.

Note