Skip to main content

Interface: FilesListArguments

Extends

  • TokenOverridable.TraditionalPagingEnabled.OptionalTeamAssignable

Properties

channel?

optional channel: string;

Description

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

Defined in

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


count?

optional count: number;

Description

Number of items to return per page. Defaults to 20

Inherited from

TraditionalPagingEnabled.count

Defined in

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


page?

optional page: number;

Description

Page number of results to return. Defaults to 1.

Inherited from

TraditionalPagingEnabled.page

Defined in

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


show_files_hidden_by_limit?

optional show_files_hidden_by_limit: boolean;

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.

Defined in

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


team_id?

optional team_id: string;

Description

If using an org token, team_id is required.

Inherited from

OptionalTeamAssignable.team_id

Defined in

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


token?

optional token: string;

Description

Overridable authentication token bearing required scopes.

Inherited from

TokenOverridable.token

Defined in

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


ts_from?

optional ts_from: string;

Description

Filter files created after this timestamp (inclusive).

Defined in

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


ts_to?

optional ts_to: string;

Description

Filter files created before this timestamp (inclusive).

Defined in

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


types?

optional types: string;

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.

Defined in

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


user?

optional user: string;

Description

Filter files created by a single user.

Defined in

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