Sample - Slack Web API
GET/users.profile.get

Get a user's profile

Retrieves a user's profile information. Omit user to retrieve the authenticated user's profile, or provide a user ID to retrieve another user's profile, and set include_labels when custom-field labels are needed.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
tokenstringrequired
Authentication token with the `users.profile:read` scope.
include_labelsbooleanoptional
Set to true to include labels for IDs in custom profile fields.
userstringoptional
Identifier of the user whose profile to retrieve. Defaults to the authenticated user's profile when omitted.

2 status codes
200Returns an object containing `ok` set to true and the requested profile object in `profile`, including standard and custom profile fields.
okbooleanrequired
Allowed:true
profileobjectrequired
defaultTypical error response
callstackstringoptional
Note: PHP callstack is only visible in dev/qa
errorstringrequired
Allowed:user_not_foundnot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_data
okbooleanrequired
Allowed:false

Error handling

token must carry the users.profile:read scope. When supplied, user must identify a user, and include_labels must be a boolean.