Organizations

Search…

Organizations

Manage organizations via the Backend API

Organizations is a premium feature. Please get in touch if you would like us to enable it for your account. You can contact us at [email protected].
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
1
{
2
    "object": "organization",
3
    "id": "org_21Ufcy98STcA11s3QckIwtwHIES",
4
    "logo_url": "https://images.clerk.services/default-logo.png",
5
    "name": "Acme Inc",
6
    "privateMetadata": {},
7
    "publicMetadata": {},
8
    "slug": "acme-inc",
9
    "created_at": 1638000669544,
10
    "updated_at": 1638000669544
11
}
Copied!
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
put
https://api.clerk.dev
/v1/organizations/:id/logo
Update an organization's logo