curl --request GET \
--url http://localhost:3500/v1/organizations/{organization_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/organizations/{organization_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/organizations/{organization_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, 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"
}
}Get an organization
Synchronized business identity, local member count, nested settings, caller access and permission-derived capabilities. Reads do not contact Clerk. Slug and logo_url may be null until identity is synchronized. Missing settings are projected without inserts.
curl --request GET \
--url http://localhost:3500/v1/organizations/{organization_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/organizations/{organization_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/organizations/{organization_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, 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
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.
Path Parameters
1 - 255Response
Organization detail.
1 - 255Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.