Skip to main content
Docs

The Backend Organization object

The Backend Organization object is similar to the object as it holds information about an organization, as well as methods for managing it. However, the Backend Organization object is different in that it is used in the Backend API and is not directly accessible from the Frontend API.

Properties

  • Name
    adminDeleteEnabled
    Type
    boolean
    Description

    Whether the organization allows admins to delete users.

  • Name
    createdAt
    Type
    number
    Description

    The date when the organization was first created.

  • Name
    createdBy?
    Type
    string
    Description

    The ID of the user who created the organization.

  • Name
    hasImage
    Type
    boolean
    Description

    Whether the organization has an image.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the organization.

  • Name
    imageUrl
    Type
    string
    Description

    Holds the organization's logo. Compatible with Clerk's Image Optimization.

  • Name
    maxAllowedMemberships
    Type
    number
    Description

    The maximum number of memberships allowed in the organization.

  • Name
    membersCount?
    Type
    number
    Description

    The number of members in the organization.

  • Name
    name
    Type
    string
    Description

    The name of the organization.

  • Name
    privateMetadata
    Type
    Description

    Metadata that can be read and set only from the Backend API.

  • Name
    publicMetadata
    Type
    null |
    Description

    Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.

  • Name
    slug
    Type
    string
    Description

    The URL-friendly identifier of the user's active organization. If supplied, it must be unique for the instance.

  • Name
    updatedAt
    Type
    number
    Description

    The date when the organization was last updated.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on