Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

@salesforce/b2c-tooling-sdk / operations/mrt / listMembers

Function: listMembers()

listMembers(options, auth): Promise<ListMembersResult>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/member.ts:134

Lists members for an MRT project.

Parameters

options

ListMembersOptions

List options including project slug

auth

AuthStrategy

Authentication strategy (ApiKeyStrategy)

Returns

Promise<ListMembersResult>

Paginated list of members

Throws

Error if request fails

Example

typescript
import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
import { listMembers } from '@salesforce/b2c-tooling-sdk/operations/mrt';

const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');

const result = await listMembers({
  projectSlug: 'my-storefront'
}, auth);

for (const member of result.members) {
  console.log(`${member.user}: ${member.role?.name}`);
}

Released under the Apache-2.0 License.