Create Organization

Developing

Develop Env

http://localhost:3000/api

POST

orgs/

organization

Maintainer:Abdelrhman Moataz

Purpose

Create a new organization (used by onboarding automation or platform admins).

Auth / Scope

system:admin OR enterprise provisioning token.
Only system-level or cloud admin flows should be allowed.

Headers

Content-Type: application/json

Authorization: Bearer <SYS_ADMIN_TOKEN>

Idempotency-Key: <uuid> (recommended)

X-Request-ID: <uuid> (recommended)

Idempotency & retries

Use Idempotency-Key for retries: same key returns same created org or 409 if conflict.

Rate limits

Provisioning calls are limited (e.g., 10/min per system token). On 429 respect Retry-After.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠409Bad Request

🟠403Forbidden

🔴500Server Error

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://localhost:3000/apiorgs/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Cognita Education Group",
    "orgType": "education",
    "billingAccountId": "cus_87654321xyz",
    "settings": {
        "timezone": "America/Los_Angeles",
        "defaultLanguage": "en-US",
        "complianceMode": "ferpa",
        "recordingConsent": "required",
        "aiSummaries": "enhanced",
        "educationMode": true,
        "dlpEnabled": true,
        "translationEnabled": true,
        "realTimeSummaries": true,
        "lmsIntegration": "canvas",
        "retentionAlerts": true
    },
    "retentionPolicy": {
        "transcripts": "730d",
        "recordings": "365d",
        "chatLogs": "365d",
        "userData": "1825d",
        "examData": "3650d"
    },
    "allowedDomains": [
        "cognita.edu",
        "school-district.k12"
    ],
    "featureFlags": {
        "realTimeTranslation": true,
        "roleAwareSummaries": true,
        "examGeneration": true,
        "meetingEnergyDashboard": false,
        "breakoutRooms": true,
        "aiAttendee": false
    },
    "payerUserId": "u-9f8e7d6c-5b4a-3210-fedc-ba9876543210"
}'

Response Example

200 - Success

{
  "message": "Organization created successfully",
  "data": {
    "orgId": "a1b2c3d4-5678-90ef-1234-567890abcdef",
    "name": "Cognita Education Group",
    "orgType": "education",
    "billingAccountId": "cus_87654321xyz",
    "payerUserId": "u-9f8e7d6c-5b4a-3210-fedc-ba9876543210",
    "createdAt": "2025-10-22T14:30:00Z",
    "updatedAt": "2025-10-22T14:30:00Z",
    "retentionPolicy": {
      "transcripts": "730d",
      "recordings": "365d",
      "chatLogs": "365d",
      "userData": "1825d",
      "examData": "3650d"
    },
    "settings": {
      "timezone": "America/Los_Angeles",
      "defaultLanguage": "en-US",
      "complianceMode": "ferpa",
      "recordingConsent": "required",
      "aiSummaries": "enhanced",
      "educationMode": true,
      "dlpEnabled": true,
      "translationEnabled": true,
      "realTimeSummaries": true,
      "lmsIntegration": "canvas",
      "retentionAlerts": true
    },
    "billingPlan": "enterprise_edu",
    "isSuspended": false,
    "suspensionReason": null,
    "suspensionDate": null,
    "trialEndDate": "2026-01-22T00:00:00Z",
    "allowedDomains": [
      "cognita.edu",
      "school-district.k12"
    ],
    "featureFlags": {
      "realTimeTranslation": true,
      "roleAwareSummaries": true,
      "examGeneration": true,
      "meetingEnergyDashboard": false,
      "breakoutRooms": true,
      "aiAttendee": false
    }
  }
}

Modified at 2025-10-22 01:55:14

Update Plan

Get Organization

Create Organization

Purpose#

Auth / Scope#

Headers#

Idempotency & retries#