Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods users.profile.get.json
Raw

priv/docs/methods/users.profile.get.json

{
"args": {
"include_labels": {
"default": "false",
"desc": "Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.",
"example": "true",
"required": false,
"type": "boolean"
},
"user": {
"desc": "User to retrieve profile info for",
"required": false,
"type": "string"
}
},
"desc": "Retrieve a user's profile information, including their custom status.",
"errors": { "user_not_found": "Value passed for `user` was invalid." },
"rate_limit": {
"label": "Tier 4: 100+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "users.profile:read",
"url": "https://docs.slack.dev/reference/scopes/users.profile.read"
}
],
"user": [
{
"name": "users.profile:read",
"url": "https://docs.slack.dev/reference/scopes/users.profile.read"
}
]
}
}