Go to Slack

user type

A user object contains information about a team member.

{
    "id": "U023BECGF",
    "name": "bobby",
    "deleted": false,
    "color": "9f69e7",
    "profile": {
        "avatar_hash": "ge3b51ca72de",
        "status_emoji": ":mountain_railway:",
        "status_text": "riding a train",
        "first_name": "Bobby",
        "last_name": "Tables",
        "real_name": "Bobby Tables",
        "email": "bobby@slack.com",
        "skype": "my-skype-name",
        "phone": "+1 (123) 456 7890",
        "image_24": "https:\/\/...",
        "image_32": "https:\/\/...",
        "image_48": "https:\/\/...",
        "image_72": "https:\/\/...",
        "image_192": "https:\/\/...",
        "image_512": "https:\/\/..."
    },
    "is_admin": true,
    "is_owner": true,
    "is_primary_owner": true,
    "is_restricted": false,
    "is_ultra_restricted": false,
    "updated": 1490054400,
    "has_2fa": false,
    "two_factor_type": "sms"
}

The id field is a string identifier for this team member. It is only unique to the team containing the user. Use this field instead of the name field when storing related data or when specifying the user in API requests. Though the ID field usually begins with U, it is also possible to encounter user IDs beginning with W. We recommend considering the string an opaque value. Read more about recent changes to user ID strings.

The name parameter indicates the username for this user, without a leading @ sign.

For deactivated users, deleted will be true.

The color field is used in some clients to display a colored username.

The profile hash contains as much information as the user has supplied in the default profile fields: first_name, last_name, real_name, email, skype, and the image_* fields. Only the image_* fields are guaranteed to be included. Data that has not been supplied may not be present at all, may be null or may contain the empty string (""). A user's custom profile fields may be discovered using users.profile.get.

The image_* fields will always contain https URLs to square, web-viewable images (GIFs, JPEGs or PNGs).

The updated field is a unix timestamp when the user was last updated.

The has_2fa field describes whether two-step verification is enabled for this user. This field will always be displayed if you are looking at your own user information. If you are looking at another user's information this field will only be displayed if you are Team Admin or owner.

The two_factor_type field is either app or sms. It will only be present if has_2fa is true.

Bot users may contain a always_active field under profile, indicating whether the bot user is active in a way that overrides traditional presence rules. The presence docs tell the whole story.

Enterprise Grid user objects

Users belonging to an Enterprise Grid workspace have a enterprise_user node attached containing these fields:

  • id - this user's ID, which might start with U or W; IDs beginning with U are unique only to a team/workspace. IDs beginning with W are unique for an entire Enterprise Grid organization and may represent the user on multiple teams within it.
  • enterprise_id - the unique ID for this particular Enterprise Organization
  • enterprise_name - the name of this umbrella organization
  • is_admin - a boolean value indicating whether this user administers this enterprise
  • is_owner - a boolean value indicating whether this user is the owner of this enterprise
  • teams - an array of team IDs within the containing enterprise that the user is a member of

Some enterprise grid users also have a kind of dual identity — a local team-centric user ID beginning with U as well as a enterprise wide user ID beginning with W, called the enterprise user ID.

In most cases these IDs can be used interchangeably but we strongly prefer using the enterprise user ID whenever possible.

See our Enterprise grid documentation for more detail.