Organization methods

These are all methods on the Clerk class that allow you to create, modify, or read information about Organizations.

`getOrganization()`

The getOrganization method is used to get the information of an organization programatically.


function getOrganization(organizationId: string): Promise<Organization | undefined>;

`getOrganization()` params

Name	Type	Description
`organizationId`	`string`	The ID of the organization to be found.

`getOrganization()` returns

Type	Description
`Promise<Organization \| undefined>`	A `Promise` which resolves to the requested `Organization`.

`createOrganization()`

The createOrganization method is used to create an organization programatically.


function createOrganization(params: CreateOrganizationParams): Promise<Organization>;

`CreateOrganizationParams`

Name	Type	Description
`name`	`string`	The name of the organization to be created.
`slug?`	`string`	The optional slug of the organization to be created.

`createOrganization()` returns

Type	Description
`Promise<[Organization][org-ref>`	A `Promise` which resolves to the newly created `Organization`.

`createOrganization()` example

index.js
  import Clerk from '@clerk/clerk-js';
 
  // Initialize Clerk with your Clerk publishable key
  const clerk = new Clerk(`{{pub_key}}`);
  await clerk.load();
 
  // Create an organization
  const org = await clerk.createOrganization({
    name: 'My Organization',
    slug: 'my-organization',
  });
 
  // org will be the newly created Organization object
  // you can use org however you would like moving forward,
  // for example, check the org ID:
  console.log(org.id);

index.html
  <script>
    // Get this URL and Publishable Key from the Clerk Dashboard
    const clerkPublishableKey = `{{pub_key}}`;
    const frontendApi = 'https://[your-domain].clerk.accounts.dev';
    const version = '@latest'; // Set to appropriate version
  
    // Creates asynchronous script
    const script = document.createElement('script');
    script.setAttribute('data-clerk-frontend-api', frontendApi);
    script.setAttribute('data-clerk-publishable-key', clerkPublishableKey);
    script.async = true;
    script.src = `${frontendApi}/npm/@clerk/clerk-js${version}/dist/clerk.browser.js`;
  
    // Adds listener to initialize ClerkJS after it's loaded
    script.addEventListener('load', async function () {
      await window.Clerk.load();
      
      // Create an organization
      const org = await window.Clerk.createOrganization({
        name: 'My Organization',
        slug: 'my-organization',
      });
 
      // org will be the newly created Organization object
      // you can use org however you would like moving forward,
      // for example, check the org ID:
      console.log(org.id);
    });
    document.body.appendChild(script);
  </script>

getOrganization()

getOrganization() params

getOrganization() returns

createOrganization()

CreateOrganizationParams

createOrganization() returns

createOrganization() example