Clerk docs

Organization

Used to interact with the an organization and its properties. The current user must be an administrator to access them.

Create Organization

Create an organization and add the current user as admin.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
Request Body schema: application/x-www-form-urlencoded
required
name
string

The organization name. May not contain URLs or HTML.

Responses
200

Returns the response for Client wrapped Organization object.

401

Request was not successful

403

Request was not successful

422

Request was not successful

post/v1/organizations
Request samples
application/x-www-form-urlencoded
name=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Get Organization

Retrieve all properties of an organization that the current user is member of.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

Responses
200

Returns the response for Client wrapped Organization object.

401

Request was not successful

403

Request was not successful

404

Request was not successful

get/v1/organizations/{organization_id}
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Update Organization

Update the given properties of an organization.

The current user must be an admin in the organization.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The id of the organization to update

Request Body schema: application/x-www-form-urlencoded
required
name
string or null

The organization name. May not contain URLs or HTML.

slug
string or null

The organization slug

Responses
200

Returns the response for Client wrapped Organization object.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

patch/v1/organizations/{organization_id}
Request samples
application/x-www-form-urlencoded
name=string&slug=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Delete Organization

Delete the given organization.

The current user must be an admin in the organization.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The id of the organization to delete

Responses
200

Returns a Deleted User object.

403

Request was not successful

404

Request was not successful

delete/v1/organizations/{organization_id}
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}
➔ Next to Invitations