Skip to main content

users.profile.get method

Facts​

DescriptionRetrieve a user's profile information, including their custom status.
Method Access
GET https://slack.com/api/users.profile.get
Scopes
Content types
application/x-www-form-urlencoded
application/json
Rate LimitsTier 4: 100+ per minute

Arguments​

Required arguments

tokenstringRequired

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example: xxxx-xxxxxxxxx-xxxx

Optional arguments

include_labelsbooleanOptional

Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.

Default: false
Example: true
userstringOptional

User to retrieve profile info for

Usage info​

Use this method to retrieve a user's profile information.

If you're frequently calling users.profile.get on behalf of a team or user, we recommend caching labels retrieved from team.profile.get. Using the include_labels parameter will severely rate-limit requests to this method.

Response​

Typical success response

{
  "ok": true,
  "profile": {
    "title": "Head of Coffee Production",
    "phone": "",
    "skype": "",
    "real_name": "John Smith",
    "real_name_normalized": "John Smith",
    "display_name": "john",
    "display_name_normalized": "john",
    "fields": {
      "Xf0111111": {
        "value": "Barista",
        "alt": ""
      },
      "Xf0222222": {
        "value": "2022-04-11",
        "alt": ""
      },
      "Xf0333333": {
        "value": "https://example.com",
        "alt": ""
      }
    },
    "status_text": "Watching cold brew steep",
    "status_emoji": ":coffee:",
    "status_emoji_display_info": [],
    "status_expiration": 0,
    "avatar_hash": "123xyz",
    "start_date": "2022-03-21",
    "email": "johnsmith@example.com",
    "pronouns": "they/them/theirs",
    "huddle_state": "default_unset",
    "huddle_state_expiration_ts": 0,
    "first_name": "john",
    "last_name": "smith",
    "image_24": "https://.../...-24.png",
    "image_32": "https://.../...-32.png",
    "image_48": "https://.../...-48.png",
    "image_72": "https://.../...-72.png",
    "image_192": "https://.../....-192png",
    "image_512": "https://.../...-512.png"
  }
}

Typical error response

{
  "ok": false,
  "error": "user_not_found"
}

The following fields are the default fields of a user's workspace profile. A user may have additional custom fields, though! Use team.profile.get to view all the workspace's custom profile fields.

FieldTypeDescription
avatar_hashString
display_nameStringThe display name the user has chosen to identify themselves by in their workspace profile. Do not use this field as a unique identifier for a user, as it may change at any time. Instead, use id and team_id in concert.
display_name_normalizedStringThe display_name field, but with any non-Latin characters filtered out.
emailStringA valid email address. It cannot have spaces, and it must have an @ and a domain. It cannot be in use by another member of the same team. Changing a user's email address will send an email to both the old and new addresses, and also post a slackbot message to the user informing them of the change. This field can only be changed by admins for users on paid teams. When using an OAuth Access Token (that starts with xoxp-) to retrieve one's own profile details, the email field will not be returned in the response if the token does not have the users:read.email scope.
fieldsObjectAll the custom profile fields for the user.
first_nameStringThe user's first name. The name slackbot cannot be used. Updating first_name will update the first name within real_name.
image_*StringThese various fields will contain https URLs that point to square ratio, web-viewable images (GIFs, JPEGs, or PNGs) that represent different sizes of a user's profile picture.
last_nameStringThe user's last name. The name slackbot cannot be used. Updating last_name will update the second name within real_name.
phoneStringThe user's phone number, in any format.
pronounsStringThe pronouns the user prefers to be addressed by.
real_nameStringThe user's first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared.
real_name_normalizedStringThe real_name field, but with any non-Latin characters filtered out.
skypeStringA shadow from a bygone era. It will always be an empty string and cannot be set otherwise.
start_dateStringThe date the person joined the organization. Only available if Slack Atlas is enabled.
status_emojiStringThe displayed emoji that is enabled for the Slack team, such as :train:.
status_expirationIntegerthe Unix timestamp of when the status will expire. Providing 0 or omitting this field results in a custom status that will not expire.
status_textStringThe displayed text of up to 100 characters. We strongly encourage brevity. See custom status for more info.
teamStringThe ID of the workspace the user is in.
titleStringThe user's title.
Bot users may contain an always_active profile field, indicating whether the bot user is active in a way that overrides traditional presence rules.

Email addresses​

Accessing Email Addresses

The users:read.email OAuth scope is now required to access the email field in user objects returned by the users.list and users.info web API methods. users:read is no longer a sufficient scope for this data field. Learn more.

If the Email Display setting is unchecked in your Slack Admin settings, users.profile.get does not return an email value.

Errors​

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok parameter in the response.

Error
Description
access_denied

Access to a resource specified in the request is denied.

accesslimited

Access to this method is limited on the current network

account_inactive

Authentication token is for a deleted user or workspace when using a bot token.

deprecated_endpoint

The endpoint has been deprecated.

ekm_access_denied

Administrators have suspended the ability to post a message.

enterprise_is_restricted

The method cannot be called from an Enterprise.

fatal_error

The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.

internal_error

The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

invalid_arg_name

The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.

invalid_arguments

The method was called with invalid arguments.

invalid_array_arg

The method was passed an array as an argument. Please only input valid strings.

invalid_auth

Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.

invalid_charset

The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

invalid_form_data

The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

invalid_post_type

The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

method_deprecated

The method has been deprecated.

missing_post_type

The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

missing_scope

The token used is not granted the specific scope permissions required to complete this request.

no_permission

The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.

not_allowed_token_type

The token type used in this request is not allowed.

not_authed

No authentication token provided.

org_login_required

The workspace is undergoing an enterprise migration and will not be available until migration is complete.

ratelimited

You are attempting to call this method too frequently.

ratelimited

The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

request_timeout

The method was called via a POST request, but the POST data was either missing or truncated.

service_unavailable

The service is temporarily unavailable

team_access_not_granted

The token used is not granted the specific workspace access required to complete this request.

team_added_to_org

The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

token_expired

Authentication token has expired

token_revoked

The token being used is not valid.

token_revoked

Authentication token is for a deleted user or workspace or the app has been removed when using a user token.

two_factor_setup_required

Two factor setup is required.

user_not_found

Value passed for user was invalid.