Function fetchMembers

fetchMembers(
    client: Client,
    parameters: {
        after?: string | null;
        first?: number;
        orgId: string;
        siteId?: string;
        teamId: string;
    },
    options?: RequestOptions,
): Promise<
    {
        pageInfo: {
            endCursor?: string
            | null;
            hasNextPage: boolean;
            [key: string]: unknown;
        };
        results: { accountId: string; [key: string]: unknown }[];
        [key: string]: unknown;
    },
>
Returns a set of account IDs who are members of the team, alongside a pagination cursor to retrieve the next page (if available).
Parameters
- client: Client
- parameters: {
      after?: string | null;
      first?: number;
      orgId: string;
      siteId?: string;
      teamId: string;
  }
  - Optionalafter?: string | null
    
    Pagination cursor, only members after the cursor will be returned
  - Optionalfirst?: number
    
    Maximum number of members to be returned
  - orgId: string
    
    The ID of the organisation of the team you are fetching members for.
  - OptionalsiteId?: 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.
  - teamId: string
    
    The ID of the team you are fetching members for.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        pageInfo: {
            endCursor?: string
            | null;
            hasNextPage: boolean;
            [key: string]: unknown;
        };
        results: { accountId: string; [key: string]: unknown }[];
        [key: string]: unknown;
    },
>
- Defined in src/teams/api/teamMembers.ts:13

Function fetchMembers

Parameters

`Optional`after?: string | null

`Optional`first?: number

orgId: string

`Optional`siteId?: string

teamId: string

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

Settings

Function fetchMembers

Parameters

Optionalafter?: string | null

Optionalfirst?: number

orgId: string

OptionalsiteId?: string

teamId: string

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

Settings

`Optional`after?: string | null

`Optional`first?: number

`Optional`siteId?: string

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