1. Workspace
Cognita
  • Introduction
  • Auth
    • register
      POST
    • login
      POST
    • callback
      GET
    • profile
      GET
    • verify email
      POST
    • refresh
      POST
    • logout
      POST
    • forgot password
      POST
    • reset password
      POST
    • request reset password
      POST
    • update-profile
      PATCH
  • Meetings
    • Transcripts
      • Retrieve transcripts for a meeting
    • upload init
    • Get meeting details
  • Transcription
    • live
    • Get Transcript segments
    • Create translation for transcript
  • Organization
    • Billing
      • Get Billing Details
      • Update Plan
    • Org
      • Create Organization
      • Get Organization
      • Get Organizations
      • update organization
      • update settings
      • Delete Organization
      • get organization settings
      • Suspend
      • Resume
    • Retention
      • Set Retention Policy
      • Get Retention Policy
      • Update Retention Policy
    • Domains
      • Allowed Domains
      • Allowed Domains
      • Domain verfying
  • Workspaces
    • Org
      • Get Organization Workspaces
    • Workspace
      • Create Workspace
      • Get Workspace
      • Update Workspace
      • Delete Workspace
    • Users
      • Get Workspace Members
      • Delete Member from Workspace
    • Meetings
      • Start a meeting in workspace
  • configurations
    • feature-flags
    • configs
    • tenant-defaults
  • Schemas
    • Organization
      • OrganizationSettings
      • FeatureFlags
      • RetentionPolicy
      • Organization
      • CreateOrgRequestBody
    • Billing & Subscriptions
      • BillingAccount
      • SubscriptionEntitlements
      • SubscriptionPlan
      • Subscription
      • PaymentMethod
      • Invoice
      • UsageRecords
      • Bill
    • Roles & permissions
      • Permissions
    • Workspace
      • Workspaces
    • Meeting & Recordings
      • Meetings
    • Trascriptions & Summaries
    • Integrations
    • Notifications & Audit logs
    • AI Services
    • Localization
    • Auth & Users
      • user
      • AccessToken
    • ErrorResponse
    • SuccessResponse
    • DeviceInfo
    • Session
  1. Workspace

Workspaces

{
    "id": "string",
    "Org": {
        "orgId": "string",
        "name": "string",
        "orgType": "string",
        "billingAccountId": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "retentionPolicy": {
            "transcripts": "string",
            "recordings": "string",
            "chatLogs": "string",
            "userData": "string",
            "examData": "string"
        },
        "settings": {
            "timezone": "2019-08-24T14:15:22.123Z",
            "defaultLanguage": "string",
            "complianceMode": "string",
            "recordingConsent": "string",
            "aiSummaries": "string",
            "educationMode": true,
            "dlpEnabled": true,
            "translationEnabled": true,
            "realTimeSummaries": true,
            "lmsIntegration": "string",
            "retentionAlerts": true
        },
        "billingPlan": "string",
        "isSuspended": true,
        "suspensionReason": null,
        "suspensionDate": null,
        "trialEndDate": "string",
        "allowedDomains": [
            "http://example.com"
        ],
        "featureFlags": {
            "realTimeTranslation": true,
            "roleAwareSummaries": true,
            "examGeneration": true,
            "meetingEnergyDashboard": true
        }
    },
    "Subscription": {
        "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
        "status": "string",
        "plan": {
            "planId": "string",
            "name": "string",
            "type": "string",
            "pricePerMonth": 0,
            "currency": "string",
            "entitlements": {
                "maxMeetingsPerMonth": 0,
                "aiSummary": true,
                "recordingStorageGb": 0
            }
        },
        "billingCycle": "string",
        "startDate": "string",
        "endDate": "string",
        "renewalDate": "string",
        "trialEnd": null,
        "autoRenew": true,
        "billingAccount": {
            "billingAccountId": "string",
            "provider": "string",
            "status": "string",
            "currency": "string",
            "billingEmail": "string",
            "createdAt": "string"
        },
        "payer": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "email": "user@example.com",
            "name": "string",
            "avatarUrl": "http://example.com",
            "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
            "isVerified": false,
            "status": "active",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "languageCode": "656ecce5-9abb-42da-8ab4-58104b4a1e1b",
            "preference": "string"
        }
    },
    "name": "string",
    "description": "string",
    "visibility": "string"
}
Built with