Skip to main content

Interface: FilesListArguments

Defined in: packages/web-api/src/types/request/files.ts:94

Extends​

  • TokenOverridable.TraditionalPagingEnabled.OptionalTeamAssignable

Properties​

channel?​

optional channel: string;

Defined in: packages/web-api/src/types/request/files.ts:96

Description​

Filter files appearing in a specific channel, indicated by its ID.

count?​

optional count: number;

Defined in: packages/web-api/src/types/request/common.ts:33

Description​

Number of items to return per page. Defaults to 20

Inherited from​

TraditionalPagingEnabled.count

page?​

optional page: number;

Defined in: packages/web-api/src/types/request/common.ts:35

Description​

Page number of results to return. Defaults to 1.

Inherited from​

TraditionalPagingEnabled.page

show_files_hidden_by_limit?​

optional show_files_hidden_by_limit: boolean;

Defined in: packages/web-api/src/types/request/files.ts:101

Description​

Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.

team_id?​

optional team_id: string;

Defined in: packages/web-api/src/types/request/common.ts:70

Description​

If using an org token, team_id is required.

Inherited from​

OptionalTeamAssignable.team_id

token?​

optional token: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token

ts_from?​

optional ts_from: string;

Defined in: packages/web-api/src/types/request/files.ts:103

Description​

Filter files created after this timestamp (inclusive).

ts_to?​

optional ts_to: string;

Defined in: packages/web-api/src/types/request/files.ts:105

Description​

Filter files created before this timestamp (inclusive).

types?​

optional types: string;

Defined in: packages/web-api/src/types/request/files.ts:111

Description​

Filter files by type. Pass multiple values for types argument by comma-seperating the values. The default value is all, which does not filter the list. Available types are all, spaces, snippets, images, gdocs, zips and pdfs.

user?​

optional user: string;

Defined in: packages/web-api/src/types/request/files.ts:113

Description​

Filter files created by a single user.