Skip to main content

Interface: AdminConversationsLookupArguments

Extends

  • TeamIDs.TokenOverridable.CursorPaginationEnabled

Properties

cursor?

optional cursor: string;

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

Defined in

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


last_message_activity_before

last_message_activity_before: number;

Description

UNIX timestamp to filter by public channels where the most recent message was sent before this parameter.

Defined in

packages/web-api/src/types/request/admin/conversations.ts:127


limit?

optional limit: number;

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

Defined in

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


max_member_count?

optional max_member_count: number;

Description

Filter by public channels with member count equal to or less than the specified number.

Defined in

packages/web-api/src/types/request/admin/conversations.ts:129


team_ids

team_ids: [string, ...string[]];

Description

A list of team IDs (must include at least one ID).

Inherited from

TeamIDs.team_ids

Defined in

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


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