Docs

You are viewing an archived version of the docs.Go to latest version

getOrganization()

Retrieves a single organization by the organization ID, if the ID is valid. Throws an error if the organization ID is invalid.

const organizationId = 'my-organization-id';

const organization = await clerkClient.organizations.getOrganization({ organizationId });

GetOrganizationParams

  • Name
    organizationId | slug
    Type
    string
    Description

    The ID of the organization to retrieve, or the slug of the organization to retrieve.

Example

getOrganization(slug)

Retrieve an organization by its slug instead of its ID.

const slug = 'my-organization-slug';

const organization = await clerkClient.organizations.getOrganization({ slug });

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on