Skip to content

Slack: Files schemas

6 Slack schemas with complete fields and constraints.

← Files operations · All schemas

Gets information about a file — response body — comments

FieldTypePresenceDescription and constraints
$arrayRoot
$[]JSONEach item

Gets information about a file — response body — file

FieldTypePresenceDescription and constraints
$objectRoot
channelsarrayOptional
channels[]stringEach item
comments_countJSONOptional
comments_count (anyOf 1)integerAlternative
comments_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdJSONOptional
created (anyOf 1)integerAlternative
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
date_deleteJSONOptional
date_delete (anyOf 1)integerAlternative
date_delete (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
display_as_botbooleanOptional
editablebooleanOptional
editorstringOptional
external_idstringOptional
external_typestringOptional
external_urlstringOptionalFormat: uri
filetypestringOptional
groupsarrayOptional
groups[]stringEach item
has_rich_previewbooleanOptional
idstringOptional
image_exif_rotationJSONOptional
image_exif_rotation (anyOf 1)integerAlternative
image_exif_rotation (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
imsarrayOptional
ims[]stringEach item
is_externalbooleanOptional
is_publicbooleanOptional
is_starredbooleanOptional
is_tombstonedbooleanOptional
last_editorstringOptional
mimetypestringOptional
modestringOptional
namestringOptional
non_owner_editablebooleanOptional
num_starsJSONOptional
num_stars (anyOf 1)integerAlternative
num_stars (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_hJSONOptional
original_h (anyOf 1)integerAlternative
original_h (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_wJSONOptional
original_w (anyOf 1)integerAlternative
original_w (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
permalinkstringOptionalFormat: uri
permalink_publicstringOptionalFormat: uri
pinned_infoModelOptionalExpand Gets information about a file — response body — file pinned info
pinned_toarrayOptional
pinned_to[]stringEach item
pretty_typestringOptional
previewstringOptional
public_url_sharedbooleanOptional
reactionsarrayOptional
reactions[]ModelEach itemExpand Gets information about a file — response body — file reactions item
sharesobjectOptional
shares.privateJSONOptional
shares.publicJSONOptional
sizeJSONOptional
size (anyOf 1)integerAlternative
size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
source_teamstringOptional
statestringOptional
thumb_1024stringOptionalFormat: uri
thumb_1024_hJSONOptional
thumb_1024_h (anyOf 1)integerAlternative
thumb_1024_h (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_1024_wJSONOptional
thumb_1024_w (anyOf 1)integerAlternative
thumb_1024_w (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_160stringOptionalFormat: uri
thumb_360stringOptionalFormat: uri
thumb_360_hJSONOptional
thumb_360_h (anyOf 1)integerAlternative
thumb_360_h (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_360_wJSONOptional
thumb_360_w (anyOf 1)integerAlternative
thumb_360_w (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_480stringOptionalFormat: uri
thumb_480_hJSONOptional
thumb_480_h (anyOf 1)integerAlternative
thumb_480_h (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_480_wJSONOptional
thumb_480_w (anyOf 1)integerAlternative
thumb_480_w (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_64stringOptionalFormat: uri
thumb_720stringOptionalFormat: uri
thumb_720_hJSONOptional
thumb_720_h (anyOf 1)integerAlternative
thumb_720_h (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_720_wJSONOptional
thumb_720_w (anyOf 1)integerAlternative
thumb_720_w (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_80stringOptionalFormat: uri
thumb_800stringOptionalFormat: uri
thumb_800_hJSONOptional
thumb_800_h (anyOf 1)integerAlternative
thumb_800_h (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_800_wJSONOptional
thumb_800_w (anyOf 1)integerAlternative
thumb_800_w (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_960stringOptionalFormat: uri
thumb_960_hJSONOptional
thumb_960_h (anyOf 1)integerAlternative
thumb_960_h (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_960_wJSONOptional
thumb_960_w (anyOf 1)integerAlternative
thumb_960_w (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumb_tinystringOptional
timestampJSONOptional
timestamp (anyOf 1)integerAlternative
timestamp (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
titlestringOptional
updatedJSONOptional
updated (anyOf 1)integerAlternative
updated (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
url_privatestringOptionalFormat: uri
url_private_downloadstringOptionalFormat: uri
userstringOptional
user_teamstringOptional
usernamestringOptional

Referenced models: Gets information about a file — response body — file pinned info, Gets information about a file — response body — file reactions item

Gets information about a file — response body — file pinned info

FieldTypePresenceDescription and constraints
$objectRoot

Gets information about a file — response body — file reactions item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
countJSONOptional
count (anyOf 1)integerAlternative
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptional
usersarrayOptional
users[]stringEach item

Gets information about a file — response body — paging

FieldTypePresenceDescription and constraints
$objectRoot
countJSONOptional
count (anyOf 1)integerAlternative
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageJSONOptional
page (anyOf 1)integerAlternative
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pagesJSONOptional
pages (anyOf 1)integerAlternative
pages (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_pageJSONOptional
per_page (anyOf 1)integerAlternative
per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
spillJSONOptional
spill (anyOf 1)integerAlternative
spill (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONOptional
total (anyOf 1)integerAlternative
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Gets information about a file — response body — response metadata

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1).next_cursorstringOptional
$ (anyOf 2)objectAlternative
$ (anyOf 2).messagesarrayOptional
$ (anyOf 2).messages[]stringEach item
$ (anyOf 2).warningsarrayOptional
$ (anyOf 2).warnings[]stringEach itemKnown values: method_deprecated
$ (anyOf 3)objectAlternative
$ (anyOf 3).messagesarrayOptional
$ (anyOf 3).messages[]stringEach item
$ (anyOf 3).next_cursorstringOptional
$ (anyOf 3).warningsarrayOptional
$ (anyOf 3).warnings[]stringEach itemKnown values: method_deprecated

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.