users.profile.get

Documentation Tester

Retrieves a user's profile information.

Supported token types:

workspace user

Expected scopes:

users.profile:read read

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

Arguments

This method has the URL https://slack.com/api/users.profile.get and follows the Slack Web API calling conventions.

Present these parameters as part of an application/x-www-form-urlencoded querystring or POST body. application/json is not currently accepted.

Argument	Example	Required	Description
`token`	`xxxx-xxxxxxxxx-xxxx`	Required	Authentication token bearing required scopes.
`include_labels`	`true`	Optional, default=false	Include labels for each ID in custom profile fields
`user`	`W1234567890`	Optional	User to retrieve profile info for

If you're frequently calling users.profile.get on behalf of a team or user, we recommend caching labels retrieved from team.profile.get. Please only use the include_labels parameter with users.profile.get sparingly.

The include_labels parameter is heavily rate-limited.

Response

The response contains a profile item with an array of key:value pairs.

We hope you find the first_name, last_name, email attributes self-explanatory.

The user's custom-set "current status" can be found in the status_text and status_emoji attributes. See custom status for more.

The image_ keys hold links to the different sizes we support for the user's profile image from 24x24 to 1024x1024 pixels. A link to the image in its original size is stored in image_original.

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

For a description of the fields key, see the users.profile.set method.

{
    "ok": true,
    "profile": {
        "status_text": "riding a train",
        "status_emoji": ":mountain_railway:",
        "first_name": "John",
        "last_name": "Smith",
        "email": "john@smith.com",
        "skype": "johnsmith",
        "image_24": "https://s3.amazonaws.com/slack-files/avatars/2015-11-16/123456_24.jpg",
        "image_32": "https://s3.amazonaws.com/slack-files/avatars/2015-11-16/123456_32.jpg",
        "image_48": "https://s3.amazonaws.com/slack-files/avatars/2015-11-16/123456_48.jpg",
        "image_72": "https://s3.amazonaws.com/slack-files/avatars/2015-11-16/123456_72.jpg",
        "image_192": "https://s3.amazonaws.com/slack-files/avatars/2015-11-16/123456_192.jpg",
        "image_512": "https://s3.amazonaws.com/slack-files/avatars/2015-11-16/123456_512.jpg",
        "image_1024": "https://s3.amazonaws.com/slack-files/avatars/2015-11-16/123456_1024.jpg",
        "image_original": "https://s3.amazonaws.com/slack-files/avatars/2015-11-16/123456_original.jpg",
        "fields": {
            "Xf06054AAA": {
                "value": "San Francisco",
                "alt": "Giants, yo!",
                "label": "Favorite Baseball Team"
            },
            "Xf06054BBB": {
                "value": "Barista",
                "alt": "I make the coffee & the tea!",
                "label": "Position"
            }
        }
    }
}

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 params in the response.

Error	Description
`user_not_found`	Value passed for `user` was invalid.
`not_authed`	No authentication token provided.
`invalid_auth`	Invalid authentication token.
`account_inactive`	Authentication token is for a deleted user or workspace.
`user_is_bot`	This method cannot be called by a bot user.
`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_array_arg`	The method was passed a PHP-style array argument (e.g. with a name like `foo[7]`). These are never valid with the Slack API.
`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/x-www-form-urlencoded` `multipart/form-data` `text/plain`.
`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.
`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.
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning	Description
`missing_charset`	The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.