Clerk · Schema

Clerk Organization

Clerk Organization object.

AuthenticationAuthorizationB2B SaaSCIAMIdentity ManagementMFAOAuthOpenID ConnectOrganizationsPasskeysSAMLSecuritySessionsSSOUser Management

Properties

Name	Type	Description
object	string
id	string
name	string
slug	string
image_url	string
has_image	boolean
members_count	integer
missing_member_with_elevated_permissions	boolean
pending_invitations_count	integer
max_allowed_memberships	integer
admin_delete_enabled	boolean
public_metadata	object
private_metadata	object
created_by	string
created_at	integer	Unix timestamp of creation.
updated_at	integer	Unix timestamp of last update.
last_active_at	integer	Unix timestamp of last activity.
role_set_key	string	The key of the [role set](https://clerk.com/docs/guides/organizations/control-access/role-sets) assigned to this organization.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clerk-com/main/json-schema/clerk-organization-schema.json",
  "title": "Clerk Organization",
  "description": "Clerk Organization object.",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "organization"
      ]
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "image_url": {
      "type": "string"
    },
    "has_image": {
      "type": "boolean"
    },
    "members_count": {
      "type": "integer"
    },
    "missing_member_with_elevated_permissions": {
      "type": "boolean"
    },
    "pending_invitations_count": {
      "type": "integer"
    },
    "max_allowed_memberships": {
      "type": "integer"
    },
    "admin_delete_enabled": {
      "type": "boolean"
    },
    "public_metadata": {
      "type": "object",
      "additionalProperties": true
    },
    "private_metadata": {
      "type": "object",
      "additionalProperties": true
    },
    "created_by": {
      "type": "string"
    },
    "created_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of creation.\n"
    },
    "updated_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of last update.\n"
    },
    "last_active_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of last activity.\n"
    },
    "role_set_key": {
      "type": "string",
      "description": "The key of the [role set](https://clerk.com/docs/guides/organizations/control-access/role-sets) assigned to this organization.\n",
      "nullable": true
    }
  },
  "required": [
    "object",
    "id",
    "name",
    "slug",
    "has_image",
    "max_allowed_memberships",
    "admin_delete_enabled",
    "public_metadata",
    "created_at",
    "updated_at"
  ]
}