Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods files.info.json
Raw

priv/docs/methods/files.info.json

{
"args": {
"count": {
"default": "100",
"desc": "",
"required": false,
"type": "integer"
},
"cursor": {
"desc": "Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection of comments. See pagination for more details.",
"example": "dXNlcjpVMDYxTkZUVDI=",
"required": false,
"type": "string"
},
"file": {
"desc": "Specify a file by providing its ID.",
"example": "F2147483862",
"required": true,
"type": "string"
},
"limit": {
"desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. 0",
"example": "20",
"required": false,
"type": "integer"
},
"page": {
"default": "1",
"desc": "",
"required": false,
"type": "integer"
}
},
"desc": "Gets information about a file.",
"errors": {
"canvas_disabled_file_team": "Canvas is disabled on file's team",
"canvas_disabled_user_team": "Canvas is disabled on user's team for connected Channels",
"canvas_globally_disabled": "Canvas is disabled for this team",
"file_deleted": "The requested file has been deleted",
"file_not_found": "Value passed for `file` was invalid",
"not_visible": "Do not have permission to view the file",
"slack_connect_canvas_sharing_blocked": "Admin has disabled sharing of Canvas links in all Slack Connect communications",
"template_not_visible": "Do not have permissions to view this template"
},
"rate_limit": {
"label": "Tier 4: 100+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "files:read",
"url": "https://docs.slack.dev/reference/scopes/files.read"
}
],
"user": [
{
"name": "files:read",
"url": "https://docs.slack.dev/reference/scopes/files.read"
}
]
}
}