Create an organization
curl --request POST \
--url http://localhost:3500/v1/organizations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('http://localhost:3500/v1/organizations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/organizations"
payload = { "name": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"logo_url": "<string>",
"settings": {
"currency": "<string>",
"timezone": "<string>",
"language": "en",
"require_mfa": true,
"agreement_defaults": {
"alerts": {
"flag_undercharges": true,
"flag_uncovered_items": true
}
},
"conversion_workflow": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued"
}
},
"access": {
"role": "admin",
"configured_level": "read",
"effective_level": "read"
},
"members_count": 1,
"capabilities": {
"can_delete": true,
"can_manage_members": true,
"supported_roles": [
"admin"
]
},
"member_limit": 123
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The operation conflicts with the current organization state. Refresh before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Organizations
Create an organization
Creates a Clerk organization with initial membership and billing defaults. This operation is not idempotent. After an uncertain response, list your organizations before creating another.
Create an organization
curl --request POST \
--url http://localhost:3500/v1/organizations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('http://localhost:3500/v1/organizations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/organizations"
payload = { "name": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"logo_url": "<string>",
"settings": {
"currency": "<string>",
"timezone": "<string>",
"language": "en",
"require_mfa": true,
"agreement_defaults": {
"alerts": {
"flag_undercharges": true,
"flag_uncovered_items": true
}
},
"conversion_workflow": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued"
}
},
"access": {
"role": "admin",
"configured_level": "read",
"effective_level": "read"
},
"members_count": 1,
"capabilities": {
"can_delete": true,
"can_manage_members": true,
"supported_roles": [
"admin"
]
},
"member_limit": 123
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The operation conflicts with the current organization state. Refresh before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
Clerk session with an active organization.
Body
application/json
Response
Usable organization.
Required string length:
1 - 255Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
x >= 0Show child attributes
Show child attributes
Synchronized Clerk membership capacity for display. Null means unlimited; omitted until synchronized. Clerk enforces the current limit when changing membership.