Skip to main content

Interface: AdminConversationsGetTeamsArguments

Defined in: packages/web-api/src/types/request/admin/conversations.ts:116

Extends

  • ChannelID.TokenOverridable.CursorPaginationEnabled

Properties

channel_id

channel_id: string;

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

Description

Encoded channel ID.

Inherited from

ChannelID.channel_id

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

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

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