Get Organization

Developing

Develop Env

http://localhost:3000/api

GET

/orgs/{orgId}

organization

Maintainer:Abdelrhman Moataz

Purpose

Retrieve full organization object and settings for admin console or integrations.

Auth / Scope

org:read (token must carry org_id claim matching orgId), or system admin.

Notes

Use this endpoint to prefill admin UI.

For performance, use fields param to return only necessary pieces.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200Success

application/json

Body

🟠404Not Found

🟠403Forbidden

🔴500Server Error

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://localhost:3000/api/orgs/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "status": "ok",
    "message": "Organiaztion found successfully",
    "data": {
        "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
        },
        "retentionPolicy": {
            "transcripts": "730d",
            "recordings": "365d",
            "chatLogs": "365d",
            "userData": "1825d",
            "examData": "3650d"
        },
        "allowedDomains": [
            "cognita.edu"
        ],
        "featureFlags": {
            "realTimeTranslation": true
        }
    }
}

Modified at 2025-10-16 11:46:22

Create Organization

Get Organizations

Get Organization

Purpose#

Auth / Scope#

Notes#

Request

Responses

Purpose

Auth / Scope

Notes