Interface TeamsApiListTeamsRequest

Hierarchy

  • TeamsApiListTeamsRequest

Properties

fieldsTeam? filterKeyword? filterMe? include? pageNumber? pageSize? sort?

Properties

Optional fieldsTeam

fieldsTeam?: TeamsField[]

List of fields that need to be fetched.

Optional filterKeyword

filterKeyword?: string

Search query. Can be team name, team handle, or email of team member

Optional filterMe

filterMe?: boolean

When true, only returns teams the current user belongs to

Optional include

include?: ListTeamsInclude[]

Included related resources optionally requested. Allowed enum values: team_links, user_team_permissions

Optional pageNumber

pageNumber?: number

Specific page number to return.

Optional pageSize

pageSize?: number

Size for a given page. The maximum allowed value is 100.

Optional sort

sort?: ListTeamsSort

Specifies the order of the returned teams

Settings

Member Visibility

Theme

Generated using TypeDoc