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

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

Function: listOrganizations()

listOrganizations(options, auth): Promise<ListOrganizationsResult>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/organization.ts:97

Lists organizations accessible to the authenticated user.

Parameters

options

ListOrganizationsOptions

List options including pagination

auth

AuthStrategy

Authentication strategy (ApiKeyStrategy)

Returns

Promise<ListOrganizationsResult>

Paginated list of organizations

Throws

Error if request fails

Example

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

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

const result = await listOrganizations({}, auth);
console.log(`Found ${result.count} organizations`);

for (const org of result.organizations) {
  console.log(`- ${org.name} (${org.slug})`);
}

Released under the Apache-2.0 License.