Function: fetchMembers()

function fetchMembers(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  pageInfo: {
   [key: string]: unknown;
     endCursor?: string | null;
     hasNextPage: boolean;
  };
  results: object[];
}>;

Defined in: src/teams/api/teamMembers.ts:13

Returns a set of account IDs who are members of the team, alongside a pagination cursor to retrieve the next page (if available).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ after?: string | null; first?: number; orgId: string; siteId?: string; teamId: string; }	-
parameters.after?	string | null	Pagination cursor, only members after the cursor will be returned
parameters.first?	number	Maximum number of members to be returned
parameters.orgId?	string	The ID of the organisation of the team you are fetching members for.
parameters.siteId?	string	[Optional] The ID of the site you are fetching members for. [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.teamId?	string	The ID of the team you are fetching members for.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; pageInfo: { [key: string]: unknown; endCursor?: string | null; hasNextPage: boolean; }; results: object[]; }>