Skip to main content

@slack/web-api / StarsListArguments

Interface: StarsListArguments

Defined in: packages/web-api/src/types/request/stars.ts:20

Extends​

  • TokenOverridable
  • TraditionalPagingEnabled
  • CursorPaginationEnabled
  • OptionalTeamAssignable

Properties​

count?​

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


cursor?​

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?​

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


page?​

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


team_id?​

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?​

token?: string;

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

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token