Function: queryTeams()

function queryTeams(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  cursor?: string | null;
  entities: object[];
}>;

Defined in: src/teams/api/teams.ts:20

This returns a list of all teams contained under an organization. This may be used as an option to export teams data within your organization. Callers must continue querying with the returned cursor until the cursor is null.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ cursor?: string; orgId: string; siteId: string; size?: number; }	-
parameters.cursor?	string	An optional cursor token to fetch the next page of results. Leave empty for the first request. Callers must continue querying with the returned cursor until the cursor is null.
parameters.orgId?	string	The ID of the organisation the teams are to be retrieved from.
parameters.siteId?	string	The ID of the site to retrieve teams which are site scoped. Please note that if the org is site-scoped, teams will not be included in response if siteId is not provided. [Deprecated] Omitting siteId is deprecated. With the introduction of Units, orgId alone is no longer sufficient to resolve the scope of teams. Always provide a valid siteId to ensure this operation continues to work in the future.
parameters.size?	number	The page size for the number of teams to return (max 300)
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; cursor?: string | null; entities: object[]; }>