Skip to main content
Docs

The Backend OrganizationInvitation object

The Backend OrganizationInvitation object is similar to the OrganizationInvitation object as it's the model around an organization invitation. However, the Backend OrganizationInvitation object is different in that it's used in the Backend API and is not directly accessible from the Frontend API.

Properties

  • Name
    createdAt
    Type
    number
    Description

    The date when the invitation was first created.

  • Name
    emailAddress
    Type
    string
    Description

    The email address of the user who is invited to the Organization.

  • Name
    expiresAt
    Type
    number
    Description

    The date when the invitation expires.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the OrganizationInvitation.

  • Name
    organizationId
    Type
    string
    Description

    The ID of the Organization that the user is invited to.

  • Name
    privateMetadata
    Type
    OrganizationInvitationPrivateMetadata
    Description

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

  • Name
    publicMetadata
    Type
    OrganizationInvitationPublicMetadata
    Description

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

  • Name
    publicOrganizationData?
    Type
    null | PublicOrganizationDataJSON
    Description

    Public data about the organization that the user is invited to.

  • Name
    role
    Type
    string
    Description

    The role of the invited user.

  • Name
    roleName
    Type
    string
    Description

    The name of the role of the invited user.

  • Name
    status?
    Type
    "expired" | "revoked" | "pending" | "accepted"
    Description

    The status of the invitation.

  • Name
    updatedAt
    Type
    number
    Description

    The date when the invitation was last updated.

  • Name
    url
    Type
    null | string
    Description

    The URL that the user can use to accept the invitation.

PublicOrganizationDataJSON

  • Name
    has_image
    Type
    boolean
    Description

    Whether the organization has a profile image.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the resource.

  • Name
    image_url?
    Type
    string
    Description

    Holds the default organization profile image. Compatible with Clerk's Image Optimization.

  • Name
    name
    Type
    string
    Description

    The name of the organization.

  • Name
    object
    Type
    ObjectType
    Description

    The type of the resource.

  • Name
    slug
    Type
    string
    Description

    The slug of the organization.

Feedback

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

Last updated on