# Organization object
The `Organization` object holds information about an Organization, as well as methods for managing it.
To use these methods, you must have the **Organizations** feature [enabled in your app's settings in the Clerk Dashboard](https://clerk.com/docs/guides/organizations/configure.md?sdk=nextjs#enable-organizations).
## Example
The following example uses the [useOrganization()](https://clerk.com/docs/nextjs/reference/hooks/use-organization.md) hook to access the active [Organization](https://clerk.com/docs/nextjs/reference/objects/organization.md) object.
filename: app/organization/page.tsx
```tsx
'use client'
import { useOrganization } from '@clerk/nextjs'
export default function Page() {
const { isLoaded, organization } = useOrganization()
if (!isLoaded) return Loading...
return Welcome to {organization?.name}
}
```
## Properties
| Property | Type | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `adminDeleteEnabled` | `boolean` | Whether the Organization allows admins to delete users. |
| `createdAt` | `Date` | The date when the Organization was first created. |
| `hasImage` | `boolean` | Whether the Organization has an image. |
| `id` | `string` | The unique identifier for the Organization. |
| `imageUrl` | `string` | Holds the Organization's logo. Compatible with Clerk's [Image Optimization](https://clerk.com/docs/guides/development/image-optimization.md?sdk=nextjs). |
| `maxAllowedMemberships` | `number` | The maximum number of memberships allowed in the Organization. |
| `membersCount` | `number` | The number of members in the Organization. |
| `name` | `string` | The name of the Organization. |
| `pendingInvitationsCount` | `number` | The number of pending invitations in the Organization. |
| `publicMetadata` | [OrganizationPublicMetadata](https://clerk.com/docs/nextjs/reference/types/metadata.md#organization-public-metadata) | Metadata that can be read from both the [Frontend API](https://clerk.com/docs/reference/frontend-api){{ target: '_blank' }} and [Backend API](https://clerk.com/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. |
| `selfServeSSOEnabled` | `boolean` | Whether the Organization allows self-serve SSO. |
| `slug` | `null | string` | The URL-friendly identifier of the Organization. If supplied, it must be unique for the instance. |
| `updatedAt` | `Date` | The date when the Organization was last updated. |
## Methods
### `addMember()`
Adds a user as a member to an organization. A user can only be added to an organization if they are not already a member of it and if they already exist in the same instance as the organization. Only administrators can add members to an organization.
Returns an [OrganizationMembershipResource](https://clerk.com/docs/nextjs/reference/types/organization-membership.md) object.
```typescript
function addMember(params: AddMemberParams): Promise
```
#### `AddMemberParams`
| Property | Type | Description |
| ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `role` | `string` | The [Role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions.md?sdk=nextjs) that will be assigned to the user. |
| `userId` | `string` | The unique identifier of the user to add as a member. |
### `addPaymentMethod()`
Adds a payment method.
Returns a [BillingPaymentMethodResource](https://clerk.com/docs/nextjs/reference/types/billing-payment-method-resource.md) object.
```typescript
function addPaymentMethod(params: AddPaymentMethodParams): Promise
```
#### `AddPaymentMethodParams`
| Property | Type | Description |
| ---------------------------------------- | ---------- | ------------------------------------------------------------------ |
| `gateway` | `"stripe"` | The payment gateway to use. |
| `paymentToken` | `string` | A token representing payment details, usually from a payment form. |
### `createDomain()`
Creates a new domain.
Returns an [OrganizationDomainResource](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource.md) object.
> You must have [**Verified domains**](https://clerk.com/docs/guides/organizations/add-members/verified-domains.md?sdk=nextjs) enabled in your app's settings in the Clerk Dashboard.
```typescript
function createDomain(domainName: string): Promise
```
#### Parameters
| Parameter | Type | Description |
| ------------ | -------- | --------------------------------- |
| `domainName` | `string` | The name of the domain to create. |
### `destroy()`
Deletes the Organization. Only administrators can delete an Organization.
Deleting an Organization will also delete all memberships and invitations. **This is not reversible.**
```typescript
function destroy(): Promise
```
### `getDomain()`
Gets a domain for an Organization based on the given domain ID.
Returns an [OrganizationDomainResource](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource.md) object.
> You must have [**Verified domains**](https://clerk.com/docs/guides/organizations/add-members/verified-domains.md?sdk=nextjs) enabled in your app's settings in the Clerk Dashboard.
```typescript
function getDomain(domainId: { domainId: string }): Promise
```
#### Parameters
| Parameter | Type | Description |
| ---------- | ---------------------------------- | ------------------------------------------- |
| `domainId` | `{ domainId: string; }` | The unique identifier of the domain to get. |
### `getDomains()`
Gets the list of domains.
Returns a [ClerkPaginatedResponse](https://clerk.com/docs/nextjs/reference/types/clerk-paginated-response.md) of [OrganizationDomainResource](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource.md) objects.
> You must have [**Verified domains**](https://clerk.com/docs/guides/organizations/add-members/verified-domains.md?sdk=nextjs) enabled in your app's settings in the Clerk Dashboard.
```typescript
function getDomains(params?: GetDomainsParams): Promise>
```
#### `GetDomainsParams`
| Property | Type | Description |
| --------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enrollmentMode?` | `"manual_invitation" | "automatic_invitation" | "automatic_suggestion"` | The [enrollment mode](https://clerk.com/docs/guides/organizations/add-members/verified-domains.md?sdk=nextjs#enable-verified-domains) will decide how new users join an organization. |
| `initialPage?` | `number` | A number that specifies which page to fetch. For example, if `initialPage` is set to `10`, it will skip the first 9 pages and fetch the 10th page. Defaults to `1`. |
| `pageSize?` | `number` | A number that specifies the maximum number of results to return per page. Defaults to `10`. |
### `getInvitations()`
Gets the list of invitations.
Returns a [ClerkPaginatedResponse](https://clerk.com/docs/nextjs/reference/types/clerk-paginated-response.md) of [OrganizationInvitationResource](https://clerk.com/docs/nextjs/reference/types/organization-invitation.md) objects.
```typescript
function getInvitations(params?: GetInvitationsParams): Promise>
```
#### `GetInvitationsParams`
| Property | Type | Description |
| --------------------------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `initialPage?` | `number` | A number that specifies which page to fetch. For example, if `initialPage` is set to `10`, it will skip the first 9 pages and fetch the 10th page. Defaults to `1`. |
| `pageSize?` | `number` | A number that specifies the maximum number of results to return per page. Defaults to `10`. |
| `status?` | `("pending" | "accepted" | "revoked" | "expired")[]` | The status of the invitations to get. |
### `getMembershipRequests()`
Gets the list of membership requests.
Returns a [ClerkPaginatedResponse](https://clerk.com/docs/nextjs/reference/types/clerk-paginated-response.md) of [OrganizationMembershipRequestResource](https://clerk.com/docs/nextjs/reference/types/organization-membership-request.md) objects.
> You must have [**Verified domains** and **Automatic suggestion**](https://clerk.com/docs/guides/organizations/add-members/verified-domains.md?sdk=nextjs) enabled in your app's settings in the Clerk Dashboard.
```typescript
function getMembershipRequests(params?: GetMembershipRequestParams): Promise>
```
#### `GetMembershipRequestParams`
| Property | Type | Description |
| --------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `initialPage?` | `number` | A number that specifies which page to fetch. For example, if `initialPage` is set to `10`, it will skip the first 9 pages and fetch the 10th page. Defaults to `1`. |
| `pageSize?` | `number` | A number that specifies the maximum number of results to return per page. Defaults to `10`. |
| `status?` | `"pending" | "accepted" | "revoked" | "expired"` | The status of the membership requests to get. |
### `getMemberships()`
Gets the list of Organization Memberships.
Returns a [ClerkPaginatedResponse](https://clerk.com/docs/nextjs/reference/types/clerk-paginated-response.md) of [OrganizationMembershipResource](https://clerk.com/docs/nextjs/reference/types/organization-membership.md) objects.
```typescript
function getMemberships(params?: GetMembersParams): Promise>
```
#### `GetMembersParams`
| Property | Type | Description |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `initialPage?` | `number` | A number that specifies which page to fetch. For example, if `initialPage` is set to `10`, it will skip the first 9 pages and fetch the 10th page. Defaults to `1`. |
| `pageSize?` | `number` | A number that specifies the maximum number of results to return per page. Defaults to `10`. |
| `query?` | `string` | The query to filter the users by. |
| `role?` | OrganizationCustomRoleKey[] | The [Role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions.md?sdk=nextjs) to filter the users by. |
### `getPaymentMethods()`
Gets a list of payment methods that have been stored.
Returns a [ClerkPaginatedResponse](https://clerk.com/docs/nextjs/reference/types/clerk-paginated-response.md) of [BillingPaymentMethodResource](https://clerk.com/docs/nextjs/reference/types/billing-payment-method-resource.md) objects.
```typescript
function getPaymentMethods(params?: GetPaymentMethodsParams): Promise>
```
#### `GetPaymentMethodsParams`
| Property | Type | Description |
| --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `initialPage?` | `number` | A number that specifies which page to fetch. For example, if `initialPage` is set to `10`, it will skip the first 9 pages and fetch the 10th page. Defaults to `1`. |
| `pageSize?` | `number` | A number that specifies the maximum number of results to return per page. Defaults to `10`. |
### `getRoles()`
Gets the list of [Roles](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions.md?sdk=nextjs) available.
Returns a [ClerkPaginatedResponse](https://clerk.com/docs/nextjs/reference/types/clerk-paginated-response.md) of [RoleResource](https://clerk.com/docs/nextjs/reference/types/role-resource.md) objects and a `has_role_set_migration` status.
When `has_role_set_migration` is `true`, updating Organization membership Roles is not allowed. Learn how to [build a custom flow for managing member Roles in an Organization](https://clerk.com/docs/guides/development/custom-flows/organizations/manage-roles.md?sdk=nextjs).
```typescript
function getRoles(params?: GetRolesParams): Promise
```
#### `GetRolesParams`
| Property | Type | Description |
| --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `initialPage?` | `number` | A number that specifies which page to fetch. For example, if `initialPage` is set to `10`, it will skip the first 9 pages and fetch the 10th page. Defaults to `1`. |
| `pageSize?` | `number` | A number that specifies the maximum number of results to return per page. Defaults to `10`. |
### `initializePaymentMethod()`
Initializes a payment method.
Returns a [BillingInitializedPaymentMethodResource](https://clerk.com/docs/nextjs/reference/types/billing-initialized-payment-method-resource.md) object.
```typescript
function initializePaymentMethod(params: InitializePaymentMethodParams): Promise
```
#### `InitializePaymentMethodParams`
| Property | Type | Description |
| ------------------------------ | ---------- | --------------------------- |
| `gateway` | `"stripe"` | The payment gateway to use. |
### `inviteMember()`
Creates and sends an invitation to the given email address.
Returns an [OrganizationInvitationResource](https://clerk.com/docs/nextjs/reference/types/organization-invitation.md) object.
```typescript
function inviteMember(params: InviteMemberParams): Promise
```
#### `InviteMemberParams`
| Property | Type | Description |
| ---------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `emailAddress` | `string` | The email address of the user to invite. |
| `role` | `string` | The [Role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions.md?sdk=nextjs) that will be assigned to the user. |
### `inviteMembers()`
Creates and sends invitations to the given email addresses.
Returns an array of [OrganizationInvitationResource](https://clerk.com/docs/nextjs/reference/types/organization-invitation.md) objects.
```typescript
function inviteMembers(params: InviteMembersParams): Promise
```
#### `InviteMembersParams`
| Property | Type | Description |
| -------------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `emailAddresses` | `string[]` | The email addresses of the users to invite. |
| `role` | `string` | The [Role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions.md?sdk=nextjs) that will be assigned to the users. |
### `reload()`
Reloads the resource, which is useful when you want to access the latest user data after performing a mutation. To make the updated data immediately available, this method forces a session token refresh instead of waiting for the automatic refresh cycle that could temporarily retain stale information. Learn more about [forcing a token refresh](https://clerk.com/docs/guides/sessions/force-token-refresh.md?sdk=nextjs).
```typescript
function reload(p?: ClerkResourceReloadParams): Promise
```
#### `ClerkResourceReloadParams`
| Property | Type | Description |
| ----------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rotatingTokenNonce?` | `string` | A nonce to use for rotating the user's token. Used in native application OAuth flows to allow the native client to update its JWT once despite changes in its rotating token. |
### `removeMember()`
Removes a member.
Returns an [OrganizationMembershipResource](https://clerk.com/docs/nextjs/reference/types/organization-membership.md) object.
```typescript
function removeMember(userId: string): Promise
```
#### Parameters
| Parameter | Type | Description |
| --------- | -------- | -------------------------------------------- |
| `userId` | `string` | The unique identifier of the user to remove. |
### `setLogo()`
Sets or replaces an Organization's logo.
```typescript
function setLogo(params: SetOrganizationLogoParams): Promise
```
#### `SetOrganizationLogoParams`
| Property | Type | Description |
| ------------------------ | ---------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `file` | `null | string | Blob | File` | The file to set as the Organization's logo. The file must be an image and its size cannot exceed 10MB. |
### `update()`
Updates the current Organization.
```typescript
function update(params: UpdateOrganizationParams): Promise
```
#### `UpdateOrganizationParams`
| Property | Type | Description |
| ------------------------- | -------- | ------------------------------------------------------------------------------------------------- |
| `name` | `string` | The name of the Organization. |
| `slug?` | `string` | The URL-friendly identifier of the Organization. If supplied, it must be unique for the instance. |
### `updateMember()`
Updates a given member.
Returns an [OrganizationMembershipResource](https://clerk.com/docs/nextjs/reference/types/organization-membership.md) object.
```typescript
function updateMember(params: UpdateMembershipParams): Promise
```
#### `UpdateMembershipParams`
| Property | Type | Description |
| ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `role` | `string` | The [Role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions.md?sdk=nextjs) that will be assigned to the user. |
| `userId` | `string` | The unique identifier of the user to update. |
---
## Sitemap
[Overview of all docs pages](https://clerk.com/docs/llms.txt)