Interface: UsersListArguments
Extends
TokenOverridable.CursorPaginationEnabled.LocaleAware.OptionalTeamAssignable
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
include_locale?
optional include_locale: boolean;
Description
Set this to true to receive the locale with the response.
Inherited from
LocaleAware.include_locale
Defined in
packages/web-api/src/types/request/common.ts:51
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
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