Skip to main content

Interface: UsersConversationsArguments

Defined in: packages/web-api/src/types/request/users.ts:11

Extends​

  • TokenOverridable.CursorPaginationEnabled.OptionalTeamAssignable

Properties​

cursor?​

optional cursor: string;

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

Description​

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection.

See​

pagination for more detail.

Inherited from​

CursorPaginationEnabled.cursor

exclude_archived?​

optional exclude_archived: boolean;

Defined in: packages/web-api/src/types/request/users.ts:13

Description​

Set to true to exclude archived channels from the list. Default is false.

limit?​

optional limit: number;

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

Description​

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. Must be an integer with a max value of 999. Default is 100.

Inherited from​

CursorPaginationEnabled.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

types?​

optional types: string;

Defined in: packages/web-api/src/types/request/users.ts:18

Description​

Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim and im. Defaults to public_channel.

user?​

optional user: string;

Defined in: packages/web-api/src/types/request/users.ts:23

Description​

Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.