3.0.0
Search…
⌃K
Links

Organizations

Manage organizations via the Backend API

Overview

Organizations related requests allow you to create new organizations for your instance.

Available requests

  • GET /v1/organizations
  • POST /v1/organizations
  • GET /v1/organizations/:id_or_slug
  • DELETE /v1/organizations/:id
  • PATCH /v1/organizations/:id
  • PATCH /v1/organizations/:id/metadata
  • PUT /v1/organizations/:id/logo

Example organization schema

{
"object": "organization",
"id": "org_21Ufcy98STcA11s3QckIwtwHIES",
"logo_url": "https://images.clerk.services/default-logo.png",
"name": "Acme Inc",
"private_metadata": {},
"public_metadata": {},
"slug": "acme-inc",
"created_at": 1638000669544,
"updated_at": 1638000669544
}
get
https://api.clerk.dev
/v1/organizations
Get a list of organizations for an instance
post
https://api.clerk.dev
/v1/organizations
Create an organization
get
https://api.clerk.dev
/v1/organizations/:id_or_slug
Retrieve an organization by ID or slug
delete
https://api.clerk.dev
/v1/organizations/:id
Delete an organization
patch
https://api.clerk.dev
/v1/organizations/:id
Update an organization
patch
https://api.clerk.dev
/v1/organizations/:id/metadata
Merge and update an organization's metadata