Path parameters

• orgId string Required

  Id of the organization

• caseId string Required

  Id of the case

Responses

• 201 application/json
  Hide response attributes Show response attributes object

  • data object Required
    Hide data attributes Show data attributes object

    • login object
      Hide login attributes Show login attributes object

      • createdAt string(date-time) Required
      • updatedAt string(date-time) Required
      • id string Required
      • accessToken string Required
      • refreshToken string Required
      • userProfile object Required
        Hide userProfile attributes Show userProfile attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • name string Required
        • email string Required
        • phone array[string] Required
        • isActive boolean Required
        • isEmailVerified boolean Required
        • lastActive string(date-time) Required
        • roles array[string] Required
        • avatar object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide avatar attributes Show avatar attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • providerId string Required
          • convertedName string | null Required
          • convertedProviderId string Required
          • provider string Required
          • size number Required

            Size in bytes

          • transferState number | null Required
        • onboardingStatus string | null Required
        • userType string | null Required
        • firstName string Required
        • lastName string Required
        • initials string Required
        • userOrganizations array[object]
          Hide userOrganizations attributes Show userOrganizations attributes object

          • organization object Required
            Hide organization attributes Show organization attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • slug string Required
            • email string Required
            • contact string Required
            • city string Required
            • state string Required
            • country string Required
            • description string Required
            • phone array[string] Required
            • logo string | null Required
            • isActive boolean Required
            • isPriority boolean
            • activePlan object Required

              The full record on routes that load it; null (or an empty list) on routes that do not.

              Hide activePlan attributes Show activePlan attributes object

              • createdAt string(date-time) Required
              • updatedAt string(date-time) Required
              • id string Required
              • subscription object | null Required

                Not loaded on public routes, so always null there. Only the internal admin organization report loads it.

              • relatedSubscription array[object] | null Required

                Not loaded by any route, so always null or an empty list.
              • organization object | null Required

                Not loaded by any route, so always null.

              • seats number Required
              • seatsUsed number Required
              • devices number Required
              • deviceUsed number Required
              • storage number Required

                Storage in bytes

              • storageUsed number Required

                Storage used in bytes

              • payments array[object] | null Required

                Not loaded by any route, so always null or an empty list.
              • type string Required

                Values are admin, free, limited-access, trial, tier1, tier2, tier3, tier4, tier5, tier6, or tier7.

              • isActive boolean Required
              • isBetweenPlanChanges boolean Required
              • storageInKb number Required
              • storageUsedInKb number Required
              • storageInMb number Required
              • storageUsedInMb number Required
              • storageInGb number Required
              • storageUsedInGb number Required
              • storageInTb number Required
              • storageUsedInTb number Required
              • isFreePlan boolean Required
              • remainingSeats number Required
              • remainingDevices number Required
              • remainingStorage number Required

                Storage left in bytes (storage minus storageUsed).

            • metadata object Required
            • type string Required
            • version string Required

              Values are v1, v2, eu, or ca.

          • permission object Required
            Hide permission attributes Show permission attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • user object Required

              The full record on routes that load it; null (or an empty list) on routes that do not.

              Hide user attributes Show user attributes object

              • createdAt string(date-time) Required
              • updatedAt string(date-time) Required
              • id string Required
              • name string Required
              • email string Required
              • phone array[string] Required
              • isActive boolean Required
              • isEmailVerified boolean Required
              • lastActive string(date-time) Required
              • roles array[string] Required
              • avatar object Required

                The full record on routes that load it; null (or an empty list) on routes that do not.

                Hide avatar attributes Show avatar attributes object

                • createdAt string(date-time) Required
                • updatedAt string(date-time) Required
                • id string Required
                • name string Required
                • providerId string Required
                • convertedName string | null Required
                • convertedProviderId string Required
                • provider string Required
                • size number Required

                  Size in bytes

                • transferState number | null Required
              • onboardingStatus string | null Required
              • userType string | null Required
              • firstName string Required
              • lastName string Required
              • initials string Required
              • userOrganizations array[object]

                Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
            • role string Required

              Values are user, client, employee, billing, full_access, admin, owner, or member.

            • organization object | null Required

              Not loaded by any route, so always null.

            • lastActiveAt string(date-time) | null Required
          • billing object Required

            The org's plan, limits and resolved prices. null when the org is billed by the legacy model — either it has not been migrated to case billing or the feature is off.

            Hide billing attributes Show billing attributes object

            • tier string Required

              Values are public, solo, firm, or firm-plus.

            • tierName string Required
            • billingMode string Required

              Values are payg, per-source, or flat-case.

            • cadence string Required

              Values are monthly or annual.

            • baseFeeCents number Required

              Platform fee for one period at this cadence, in cents

            • paymentMethodOnFile boolean Required
            • supportTier string Required
            • limits object Required
              Hide limits attributes Show limits attributes object

              • seatCap number | null Required

                null = unlimited

              • storageGB number Required
              • perCaseSourceCap number | null Required

                Provisioned, not enforced — display only

            • features array[string] Required

              Feature keys enabled for this tier

            • prices array[object] Required
              Hide prices attributes Show prices attributes object

              • skuKey string Required

                Values are collection.phone, collection.social, collection.email, collection.ai-chat, collection.financial, collection.discord, collection.reddit, collection.linkedin, collection.legal, collection.file, collection.other, case.flat, case.pro-upgrade, addon.kit-rental, addon.laptop-rental, addon.laptop-rental-setup, addon.managed-service, addon.shipping, addon.live-bank, plan.base, source.per, ai.tokens-overage, adjustment.manual, or adjustment.discount.

              • name string Required
              • unitAmountCents number Required

                What this org is charged per unit, in cents

              • included boolean Required

                Bundled by the plan — charged at 0, not billed

              • listAmountCents number | null Required

                What an included item would otherwise have cost

              • overridden boolean Required

                Set by this org's negotiated price rather than the plan's catalog rate

              • recurrence string | null Required

                null for a one-time charge; otherwise how often it repeats

                Values are monthly or semiannual.

              • freeFirstPeriod boolean Required

                First period of a recurring item costs 0

            • overrides object Required

              This org's negotiated exceptions, as stored. An absent SKU means the plan's catalog rate applies — read prices for what is actually charged.

      • appConfig object
        Hide appConfig attributes Show appConfig attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • systemId string Required
        • deviceSettings array[object] | null Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide deviceSettings attributes Show deviceSettings attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • systemId string Required
          • deviceId string Required
          • deviceType string Required

            Values are unknown, android, ios, facebook_dump, instagram_dump, threads_dump, or email.

          • backupPaths array[string] Required
          • defaultBackupPath string Required
          • lastUsedBackupPath string Required
          • device string | null Required

            Id of the device these settings belong to

          • lastBackupAt string(date-time) | null Required
          • lastLocalBackupAt string(date-time) | null Required
          • autoBackupFrequency string Required

            Values are none, daily, weekly, or monthly. Default value is none.

          • deviceMetadata object Required
          • otherSettings object Required
        • defaultBackupPath string Required
        • lastUsedBackupPath string Required
        • otherSettings object Required
        • osDetails object Required
          Hide osDetails attributes Show osDetails attributes object

          • arch string
          • platform string
          • version string
          • type string

            Never sent today: nothing fills it (the OS type is stored and sent as osType).

          • osType string

            Operating system type reported by the desktop app.

          • machine string
          • totalMemory number
          • cpus object
          • extraInformation object
        • lastAppUsedAt string(date-time) Required
        • lastUsedAppVersion string Required
        • defaultSettings object | null Required
      • extractionCodeDetails object
        Hide extractionCodeDetails attributes Show extractionCodeDetails attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • code string Required
        • email string Required
        • name string | null Required
        • phone string | null Required
        • isActive boolean Required
        • label string | null Required
        • config object Required
          Hide config attributes Show config attributes object

          • type string Required

            Values are allow_client, share_all, or auto_share. Default value is allow_client.

          • origin string | null Required
          • ignoreMediaPermissionAndroid boolean
          • dateRange object
            Hide dateRange attributes Show dateRange attributes object

            • start string(date-time) | null Required
            • end string(date-time) | null Required
          • appConfig object
            Hide appConfig attributes Show appConfig attributes object

            • conversionConcurrency array[object] Required
              Hide conversionConcurrency attributes Show conversionConcurrency attributes object

              • mediaType string Required

                Values are images, video, audio, or documents.

              • concurrency array[number] Required
            • compressionConcurrency array[object] Required
              Hide compressionConcurrency attributes Show compressionConcurrency attributes object

              • mediaType string Required

                Values are images, video, audio, or documents.

              • concurrency array[number] Required
            • enableLocalMediaConversion boolean
            • enableLocalMediaCompression boolean
            • enableIosEncryptedBackupExtraction boolean
            • allowOnlyEncryptedIosBackup boolean
            • autoIncludeSafariData boolean
            • autoIncludeNotesData boolean
            • autoIncludeContacts boolean

              Default value is false.

            • shareAction string

              Values are share, export, or share_and_export. Default value is share.

          • enableLocalExport object
            Hide enableLocalExport attributes Show enableLocalExport attributes object

            • formats array[string]
            • defaultConfig object
              Hide defaultConfig attributes Show defaultConfig attributes object

              • chunkType string Required

                Values are year, month, week, day, or none.

              • includeAttachments boolean Required
          • allowClient object
            Hide allowClient attributes Show allowClient attributes object

            • allowSocialApps array[string] Required
            • allowShareAll boolean Required
          • autoShare object
            Hide autoShare attributes Show autoShare attributes object

            • allowClientApproval boolean Required
            • allowAdditionalShare boolean Required
            • searches array[object] Required
              Hide searches attributes Show searches attributes object

              • type string Required

                Values are name, phone, keywords, or email. Default value is name.

              • values array[string] Required
              • apps array[string] Required
              • dateRange object Required
                Hide dateRange attributes Show dateRange attributes object

                • start string(date-time) | null Required
                • end string(date-time) | null Required
              • exactMatch boolean Required
              • include boolean Required
              • conversationType string Required

                Values are all, dm, or group. Default value is all.

          • shareAll object
            Hide shareAll attributes Show shareAll attributes object

            • apps array[string] Required
            • includeAttachments boolean Required
            • dateRange object
              Hide dateRange attributes Show dateRange attributes object

              • start string(date-time) | null Required
              • end string(date-time) | null Required
            • searchesExclude array[object]
              Hide searchesExclude attributes Show searchesExclude attributes object

              • type string Required

                Values are name, phone, keywords, or email. Default value is name.

              • values array[string] Required
              • apps array[string] Required
              • exactMatch boolean Required
              • conversationType string Required

                Values are all, dm, or group. Default value is all.

        • devices array[object] | null Required

          Not loaded by any route, so always null or an empty list.
        • totalDevicesCount number Required
        • dueDate string(date-time) | null
        • sendEmail boolean

          Default value is false.

        • lockedAt string(date-time) | null
        • hasDueDateCrossed boolean Required
        • status string Required
        • reviewStatus string | null Required

          Values are approved, rejected, not_reviewed, or na.

        • reviewMessage string | null Required
        • lastApprovedBy object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide lastApprovedBy attributes Show lastApprovedBy attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • email string Required
          • phone array[string] Required
          • isActive boolean Required
          • isEmailVerified boolean Required
          • lastActive string(date-time) Required
          • roles array[string] Required
          • avatar object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide avatar attributes Show avatar attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • providerId string Required
            • convertedName string | null Required
            • convertedProviderId string Required
            • provider string Required
            • size number Required

              Size in bytes

            • transferState number | null Required
          • onboardingStatus string | null Required
          • userType string | null Required
          • firstName string Required
          • lastName string Required
          • initials string Required
          • userOrganizations array[object]

            Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
        • ocReviewedByOrg object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide ocReviewedByOrg attributes Show ocReviewedByOrg attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • slug string Required
          • email string Required
          • contact string Required
          • city string Required
          • state string Required
          • country string Required
          • description string Required
          • phone array[string] Required
          • logo string | null Required
          • isActive boolean Required
          • isPriority boolean
          • activePlan object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide activePlan attributes Show activePlan attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • subscription object | null Required

              Not loaded on public routes, so always null there. Only the internal admin organization report loads it.

            • relatedSubscription array[object] | null Required

              Not loaded by any route, so always null or an empty list.
            • organization object | null Required

              Not loaded by any route, so always null.

            • seats number Required
            • seatsUsed number Required
            • devices number Required
            • deviceUsed number Required
            • storage number Required

              Storage in bytes

            • storageUsed number Required

              Storage used in bytes

            • payments array[object] | null Required

              Not loaded by any route, so always null or an empty list.
            • type string Required

              Values are admin, free, limited-access, trial, tier1, tier2, tier3, tier4, tier5, tier6, or tier7.

            • isActive boolean Required
            • isBetweenPlanChanges boolean Required
            • storageInKb number Required
            • storageUsedInKb number Required
            • storageInMb number Required
            • storageUsedInMb number Required
            • storageInGb number Required
            • storageUsedInGb number Required
            • storageInTb number Required
            • storageUsedInTb number Required
            • isFreePlan boolean Required
            • remainingSeats number Required
            • remainingDevices number Required
            • remainingStorage number Required

              Storage left in bytes (storage minus storageUsed).

          • metadata object Required
          • type string Required
          • version string Required

            Values are v1, v2, eu, or ca.

        • ocReviewedAt string(date-time) | null Required
        • ocRequired boolean Required

          Default value is true.

        • allowShareAll boolean Required Deprecated
        • metadata object Required
        • logsConfig object Required
        • sources array[object]
          Hide sources attributes Show sources attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • case object | null Required

            Not loaded by any route, so always null.

          • extractionCode object | null Required

            Not loaded by any route, so always null.

          • dataSource object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide dataSource attributes Show dataSource attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • displayName string Required
            • category string Required
            • config object | null Required

              Collection options for this source. The keys below are the ones the code reads, for device sources (ios, android).

              Additional properties are allowed.

              Hide config attributes Show config attributes object | null

              • iosEnableEncryptedBackup boolean
              • iosAllowOnlyEncryptedBackup boolean
              • iosAutoIncludeSafariData boolean
              • iosAutoIncludeNotesData boolean
              • androidIgnoreMediaPermission boolean
              • iosAllApps array[string]
              • iosAllowedApps array[string]
              • androidAllApps array[string]
              • androidAllowedApps array[string]
          • caseDataSource object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide caseDataSource attributes Show caseDataSource attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • case object | null Required

              Not loaded by any route, so always null.

            • dataSource object Required

              The full record on routes that load it; null (or an empty list) on routes that do not.

              Hide dataSource attributes Show dataSource attributes object

              • createdAt string(date-time) Required
              • updatedAt string(date-time) Required
              • id string Required
              • name string Required
              • displayName string Required
              • category string Required
              • config object | null Required

                Collection options for this source. The keys below are the ones the code reads, for device sources (ios, android).

                Additional properties are allowed.

                Hide config attributes Show config attributes object | null

                • iosEnableEncryptedBackup boolean
                • iosAllowOnlyEncryptedBackup boolean
                • iosAutoIncludeSafariData boolean
                • iosAutoIncludeNotesData boolean
                • androidIgnoreMediaPermission boolean
                • iosAllApps array[string]
                • iosAllowedApps array[string]
                • androidAllApps array[string]
                • androidAllowedApps array[string]
            • config object | null Required
          • config object | null Required
        • payment object | null Required
      • caseDetails object

        Sent only by the extraction-code login

        Hide caseDetails attributes Show caseDetails attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • name string Required
        • slug string Required
        • description string | null Required
        • matterId string | null
        • status string Required

          Values are open, closed, archived, or pending.

        • assignStatus string Required

          Values are assigned or unassigned.

        • createdBy object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide createdBy attributes Show createdBy attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • email string Required
          • phone array[string] Required
          • isActive boolean Required
          • isEmailVerified boolean Required
          • lastActive string(date-time) Required
          • roles array[string] Required
          • avatar object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide avatar attributes Show avatar attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • providerId string Required
            • convertedName string | null Required
            • convertedProviderId string Required
            • provider string Required
            • size number Required

              Size in bytes

            • transferState number | null Required
          • onboardingStatus string | null Required
          • userType string | null Required
          • firstName string Required
          • lastName string Required
          • initials string Required
          • userOrganizations array[object]

            Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
        • assignedTo array[string] Required

          Assigned user ids

        • organization object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide organization attributes Show organization attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • slug string Required
          • email string Required
          • contact string Required
          • city string Required
          • state string Required
          • country string Required
          • description string Required
          • phone array[string] Required
          • logo string | null Required
          • isActive boolean Required
          • isPriority boolean
          • activePlan object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide activePlan attributes Show activePlan attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • subscription object | null Required

              Not loaded on public routes, so always null there. Only the internal admin organization report loads it.

            • relatedSubscription array[object] | null Required

              Not loaded by any route, so always null or an empty list.
            • organization object | null Required

              Not loaded by any route, so always null.

            • seats number Required
            • seatsUsed number Required
            • devices number Required
            • deviceUsed number Required
            • storage number Required

              Storage in bytes

            • storageUsed number Required

              Storage used in bytes

            • payments array[object] | null Required

              Not loaded by any route, so always null or an empty list.
            • type string Required

              Values are admin, free, limited-access, trial, tier1, tier2, tier3, tier4, tier5, tier6, or tier7.

            • isActive boolean Required
            • isBetweenPlanChanges boolean Required
            • storageInKb number Required
            • storageUsedInKb number Required
            • storageInMb number Required
            • storageUsedInMb number Required
            • storageInGb number Required
            • storageUsedInGb number Required
            • storageInTb number Required
            • storageUsedInTb number Required
            • isFreePlan boolean Required
            • remainingSeats number Required
            • remainingDevices number Required
            • remainingStorage number Required

              Storage left in bytes (storage minus storageUsed).

          • metadata object Required
          • type string Required
          • version string Required

            Values are v1, v2, eu, or ca.

        • isActive boolean Required
        • priority string Required

          Values are low, medium, high, or urgent.

        • attachedDevices array[string] Required

          Attached device ids

        • totalConversations number Required
        • archivedBy object | null Required

          Not loaded by any route, so always null.

        • exportJobId string | null Required
        • metadata object Required
        • extractionCodePaymentThreadId string | null Required
        • ocCase boolean Required
        • isOcShared boolean Required
        • proEnabled boolean Required
        • isArchived boolean Required
      • collectionEventsEnabled boolean

        Desktop/portal should send collection events and heartbeats

    • case object Required
      Hide case attributes Show case attributes object

      • case object Required
        Hide case attributes Show case attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • name string Required
        • slug string Required
        • description string | null Required
        • matterId string | null
        • status string Required

          Values are open, closed, archived, or pending.

        • assignStatus string Required

          Values are assigned or unassigned.

        • createdBy object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide createdBy attributes Show createdBy attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • email string Required
          • phone array[string] Required
          • isActive boolean Required
          • isEmailVerified boolean Required
          • lastActive string(date-time) Required
          • roles array[string] Required
          • avatar object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide avatar attributes Show avatar attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • providerId string Required
            • convertedName string | null Required
            • convertedProviderId string Required
            • provider string Required
            • size number Required

              Size in bytes

            • transferState number | null Required
          • onboardingStatus string | null Required
          • userType string | null Required
          • firstName string Required
          • lastName string Required
          • initials string Required
          • userOrganizations array[object]

            Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
        • assignedTo array[string] Required

          Assigned user ids

        • organization object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide organization attributes Show organization attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • slug string Required
          • email string Required
          • contact string Required
          • city string Required
          • state string Required
          • country string Required
          • description string Required
          • phone array[string] Required
          • logo string | null Required
          • isActive boolean Required
          • isPriority boolean
          • activePlan object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide activePlan attributes Show activePlan attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • subscription object | null Required

              Not loaded on public routes, so always null there. Only the internal admin organization report loads it.

            • relatedSubscription array[object] | null Required

              Not loaded by any route, so always null or an empty list.
            • organization object | null Required

              Not loaded by any route, so always null.

            • seats number Required
            • seatsUsed number Required
            • devices number Required
            • deviceUsed number Required
            • storage number Required

              Storage in bytes

            • storageUsed number Required

              Storage used in bytes

            • payments array[object] | null Required

              Not loaded by any route, so always null or an empty list.
            • type string Required

              Values are admin, free, limited-access, trial, tier1, tier2, tier3, tier4, tier5, tier6, or tier7.

            • isActive boolean Required
            • isBetweenPlanChanges boolean Required
            • storageInKb number Required
            • storageUsedInKb number Required
            • storageInMb number Required
            • storageUsedInMb number Required
            • storageInGb number Required
            • storageUsedInGb number Required
            • storageInTb number Required
            • storageUsedInTb number Required
            • isFreePlan boolean Required
            • remainingSeats number Required
            • remainingDevices number Required
            • remainingStorage number Required

              Storage left in bytes (storage minus storageUsed).

          • metadata object Required
          • type string Required
          • version string Required

            Values are v1, v2, eu, or ca.

        • isActive boolean Required
        • tags array[object] | null Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide tags attributes Show tags attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • nameLowercase string Required
          • backgroundColor string Required
          • textColor string Required
          • type string Required

            Values are system, organization, case, or user.

          • severity string Required

            Values are info, warning, or danger.

          • origin string Required

            Values are manual or auto-import.

          • creatorAccessType string | null

            Values are org or opposing_council.

          • isActive boolean Required
        • priority string Required

          Values are low, medium, high, or urgent.

        • attachedDevices array[string] Required

          Attached device ids

        • integrations array[object] | null Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide integrations attributes Show integrations attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • integrationType string Required

            Values are goodfact, clio, or smokeball.

          • attachedAt string(date-time) Required
          • remoteCaseId string Required
          • remoteCaseName string Required
        • totalConversations number Required
        • archivedBy object | null Required

          Not loaded by any route, so always null.

        • exportJobId string | null Required
        • metadata object Required
        • extractionCodePaymentThreadId string | null Required
        • attachedTags array[object]
          Hide attachedTags attributes Show attachedTags attributes object

          • tagId string Required

            Tag id (Tag._id)

          • tag string Required

            Tag display name (Tag.name)

          • addedBy string Required

            Values are user, ai, auto, auto-import, system, or default.

          • addedById string | null
          • removedAt string(date-time) | null
          • removedBy string | null

            Values are user, ai, auto, auto-import, system, or default.

          • removedById string | null
        • ocCase boolean Required
        • isOcShared boolean Required
        • proEnabled boolean Required
        • isArchived boolean Required
      • access object Required
        Hide access attributes Show access attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • user object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide user attributes Show user attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • email string Required
          • phone array[string] Required
          • isActive boolean Required
          • isEmailVerified boolean Required
          • lastActive string(date-time) Required
          • roles array[string] Required
          • avatar object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide avatar attributes Show avatar attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • providerId string Required
            • convertedName string | null Required
            • convertedProviderId string Required
            • provider string Required
            • size number Required

              Size in bytes

            • transferState number | null Required
          • onboardingStatus string | null Required
          • userType string | null Required
          • firstName string Required
          • lastName string Required
          • initials string Required
          • userOrganizations array[object]

            Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
        • invitedBy object | null Required

          Not loaded by any route, so always null.

        • case object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide case attributes Show case attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • slug string Required
          • description string | null Required
          • matterId string | null
          • status string Required

            Values are open, closed, archived, or pending.

          • assignStatus string Required

            Values are assigned or unassigned.

          • createdBy object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide createdBy attributes Show createdBy attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • email string Required
            • phone array[string] Required
            • isActive boolean Required
            • isEmailVerified boolean Required
            • lastActive string(date-time) Required
            • roles array[string] Required
            • avatar object Required

              The full record on routes that load it; null (or an empty list) on routes that do not.

              Hide avatar attributes Show avatar attributes object

              • createdAt string(date-time) Required
              • updatedAt string(date-time) Required
              • id string Required
              • name string Required
              • providerId string Required
              • convertedName string | null Required
              • convertedProviderId string Required
              • provider string Required
              • size number Required

                Size in bytes

              • transferState number | null Required
            • onboardingStatus string | null Required
            • userType string | null Required
            • firstName string Required
            • lastName string Required
            • initials string Required
            • userOrganizations array[object]

              Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
          • assignedTo array[string] Required

            Assigned user ids

          • organization object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide organization attributes Show organization attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • slug string Required
            • email string Required
            • contact string Required
            • city string Required
            • state string Required
            • country string Required
            • description string Required
            • phone array[string] Required
            • logo string | null Required
            • isActive boolean Required
            • isPriority boolean
            • activePlan object Required

              The full record on routes that load it; null (or an empty list) on routes that do not.

              Hide activePlan attributes Show activePlan attributes object

              • createdAt string(date-time) Required
              • updatedAt string(date-time) Required
              • id string Required
              • subscription object | null Required

                Not loaded on public routes, so always null there. Only the internal admin organization report loads it.

              • relatedSubscription array[object] | null Required

                Not loaded by any route, so always null or an empty list.
              • organization object | null Required

                Not loaded by any route, so always null.

              • seats number Required
              • seatsUsed number Required
              • devices number Required
              • deviceUsed number Required
              • storage number Required

                Storage in bytes

              • storageUsed number Required

                Storage used in bytes

              • payments array[object] | null Required

                Not loaded by any route, so always null or an empty list.
              • type string Required

                Values are admin, free, limited-access, trial, tier1, tier2, tier3, tier4, tier5, tier6, or tier7.

              • isActive boolean Required
              • isBetweenPlanChanges boolean Required
              • storageInKb number Required
              • storageUsedInKb number Required
              • storageInMb number Required
              • storageUsedInMb number Required
              • storageInGb number Required
              • storageUsedInGb number Required
              • storageInTb number Required
              • storageUsedInTb number Required
              • isFreePlan boolean Required
              • remainingSeats number Required
              • remainingDevices number Required
              • remainingStorage number Required

                Storage left in bytes (storage minus storageUsed).

            • metadata object Required
            • type string Required
            • version string Required

              Values are v1, v2, eu, or ca.

          • isActive boolean Required
          • tags array[object] | null Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide tags attributes Show tags attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • nameLowercase string Required
            • backgroundColor string Required
            • textColor string Required
            • type string Required

              Values are system, organization, case, or user.

            • severity string Required

              Values are info, warning, or danger.

            • origin string Required

              Values are manual or auto-import.

            • creatorAccessType string | null

              Values are org or opposing_council.

            • isActive boolean Required
          • priority string Required

            Values are low, medium, high, or urgent.

          • attachedDevices array[string] Required

            Attached device ids

          • integrations array[object] | null Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide integrations attributes Show integrations attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • integrationType string Required

              Values are goodfact, clio, or smokeball.

            • attachedAt string(date-time) Required
            • remoteCaseId string Required
            • remoteCaseName string Required
          • totalConversations number Required
          • archivedBy object | null Required

            Not loaded by any route, so always null.

          • exportJobId string | null Required
          • metadata object Required
          • extractionCodePaymentThreadId string | null Required
          • attachedTags array[object]
            Hide attachedTags attributes Show attachedTags attributes object

            • tagId string Required

              Tag id (Tag._id)

            • tag string Required

              Tag display name (Tag.name)

            • addedBy string Required

              Values are user, ai, auto, auto-import, system, or default.

            • addedById string | null
            • removedAt string(date-time) | null
            • removedBy string | null

              Values are user, ai, auto, auto-import, system, or default.

            • removedById string | null
          • ocCase boolean Required
          • isOcShared boolean Required
          • proEnabled boolean Required
          • isArchived boolean Required
        • organization object | null Required

          Not loaded by any route, so always null.

        • status string Required
        • level string Required
        • accessGrantedAt string(date-time) Required
        • accessRevokedAt string(date-time) | null Required
        • lastAccessedAt string(date-time) | null Required
        • isActive boolean Required
        • isOnline boolean Required
      • usersWithAccess array[object] Required
        Hide usersWithAccess attributes Show usersWithAccess attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • user object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide user attributes Show user attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • email string Required
          • phone array[string] Required
          • isActive boolean Required
          • isEmailVerified boolean Required
          • lastActive string(date-time) Required
          • roles array[string] Required
          • avatar object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide avatar attributes Show avatar attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • providerId string Required
            • convertedName string | null Required
            • convertedProviderId string Required
            • provider string Required
            • size number Required

              Size in bytes

            • transferState number | null Required
          • onboardingStatus string | null Required
          • userType string | null Required
          • firstName string Required
          • lastName string Required
          • initials string Required
          • userOrganizations array[object]

            Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
        • status string Required
        • level string Required
        • lastAccessedAt string(date-time) Required
      • conversations array[object] | null Required
        Hide conversations attributes Show conversations attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • messageSharing object Required
        • selectionCoverage object
        • name string Required
        • displayName string Required

          'Conversation with ' unless the name was edited, in which case the edited name as typed.

        • chatName string Required
        • originalDisplayName string Required
        • source string Required

          Values are message, whatsapp, voicemail, call_log, facebook_dump, instagram_dump, threads_dump, or email.

        • linkedContacts array[object] | null Required

          Not loaded by any route, so always null or an empty list.
        • device object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide device attributes Show device attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • deviceId string Required
          • serialNumber string Required
          • name string Required
          • type string Required
          • nonDeviceType string | null Required
          • model string Required
          • timeZone string Required
          • osVersion string Required
          • owner object | null Required

            Not loaded by any route, so always null.

          • devicePhoneNumber string Required
          • organizations array[string] Required

            Organization ids

          • extractionCodes array[string] Required

            Extraction code ids

          • availableData object

            Which data types exist for this device (optionally scoped by query filters).

        • avatar object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide avatar attributes Show avatar attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • providerId string Required
          • convertedName string | null Required
          • convertedProviderId string Required
          • provider string Required
          • size number Required

            Size in bytes

          • transferState number | null Required
        • service string Required
        • lastMessageText string Required
        • firstMessageDate string(date-time) | null Required
        • lastMessageDate string(date-time) Required
        • displayNameEditedAt string(date-time) | null Required
        • lastMessageExternalId string Required
        • isGroup boolean Required

          Default value is false.

        • owner object | null Required

          Not loaded by any route, so always null.

        • isReadonly boolean Required
        • lastExportedAt string(date-time) | null Required
        • messagesCount number Required
        • archivedBy object | null Required

          Not loaded by any route, so always null.

        • archivedAt string(date-time) | null Required
        • starredAt string(date-time) | null Required
        • tags array[object] | null Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide tags attributes Show tags attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • nameLowercase string Required
          • backgroundColor string Required
          • textColor string Required
          • type string Required

            Values are system, organization, case, or user.

          • severity string Required

            Values are info, warning, or danger.

          • origin string Required

            Values are manual or auto-import.

          • creatorAccessType string | null

            Values are org or opposing_council.

          • isActive boolean Required
        • attachedTags array[object]
          Hide attachedTags attributes Show attachedTags attributes object

          • tagId string Required

            Tag id (Tag._id)

          • tag string Required

            Tag display name (Tag.name)

          • addedBy string Required

            Values are user, ai, auto, auto-import, system, or default.

          • addedById string | null
          • removedAt string(date-time) | null
          • removedBy string | null

            Values are user, ai, auto, auto-import, system, or default.

          • removedById string | null
        • isPlaceholder boolean Required
        • isArchived boolean Required
        • isStarred boolean Required
        • hasAllAttachmentProcessed boolean Required
        • processedAttachmentCount number Required
        • conversationName string Required
        • isNameEdited boolean Required
        • participantCount number Required
      • noOfBackups number Required
      • pendingUsersInitials array[string] Required
      • usersWithPendingAccess array[object] | null Required
        Hide usersWithPendingAccess attributes Show usersWithPendingAccess attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • invitedUserEmail string Required
        • invitedUserName string Required
        • invitedBy object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide invitedBy attributes Show invitedBy attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • email string Required
          • phone array[string] Required
          • isActive boolean Required
          • isEmailVerified boolean Required
          • lastActive string(date-time) Required
          • roles array[string] Required
          • avatar object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide avatar attributes Show avatar attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • providerId string Required
            • convertedName string | null Required
            • convertedProviderId string Required
            • provider string Required
            • size number Required

              Size in bytes

            • transferState number | null Required
          • onboardingStatus string | null Required
          • userType string | null Required
          • firstName string Required
          • lastName string Required
          • initials string Required
          • userOrganizations array[object]

            Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
        • organization object | null Required

          Not loaded by any route, so always null.

        • case object | null Required

          Not loaded by any route, so always null.

        • invitedUserRole string Required
        • status string Required
        • emailSent boolean Required
        • emailSentAt string(date-time) | null Required
        • acceptedAt string(date-time) | null Required
        • acceptedBy object | null Required

          Not loaded by any route, so always null.

        • invitedUser object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide invitedUser attributes Show invitedUser attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • email string Required
          • phone array[string] Required
          • isActive boolean Required
          • isEmailVerified boolean Required
          • lastActive string(date-time) Required
          • roles array[string] Required
          • avatar object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide avatar attributes Show avatar attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • providerId string Required
            • convertedName string | null Required
            • convertedProviderId string Required
            • provider string Required
            • size number Required

              Size in bytes

            • transferState number | null Required
          • onboardingStatus string | null Required
          • userType string | null Required
          • firstName string Required
          • lastName string Required
          • initials string Required
          • userOrganizations array[object]

            Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
        • rejectedAt string(date-time) | null Required
        • rejectedReason string | null Required
        • initials string Required
      • noOfMembers number Required
      • noOfPendingUsers number Required
      • exportCount number Required
      • conversationsCount number Required
      • extractionCodes array[object] | null Required
        Hide extractionCodes attributes Show extractionCodes attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • code string Required
        • email string Required
        • name string | null Required
        • phone string | null Required
        • isActive boolean Required
        • label string | null Required
        • config object Required
          Hide config attributes Show config attributes object

          • type string Required

            Values are allow_client, share_all, or auto_share. Default value is allow_client.

          • origin string | null Required
          • ignoreMediaPermissionAndroid boolean
          • dateRange object
            Hide dateRange attributes Show dateRange attributes object

            • start string(date-time) | null Required
            • end string(date-time) | null Required
          • appConfig object
            Hide appConfig attributes Show appConfig attributes object

            • conversionConcurrency array[object] Required
              Hide conversionConcurrency attributes Show conversionConcurrency attributes object

              • mediaType string Required

                Values are images, video, audio, or documents.

              • concurrency array[number] Required
            • compressionConcurrency array[object] Required
              Hide compressionConcurrency attributes Show compressionConcurrency attributes object

              • mediaType string Required

                Values are images, video, audio, or documents.

              • concurrency array[number] Required
            • enableLocalMediaConversion boolean
            • enableLocalMediaCompression boolean
            • enableIosEncryptedBackupExtraction boolean
            • allowOnlyEncryptedIosBackup boolean
            • autoIncludeSafariData boolean
            • autoIncludeNotesData boolean
            • autoIncludeContacts boolean

              Default value is false.

            • shareAction string

              Values are share, export, or share_and_export. Default value is share.

          • enableLocalExport object
            Hide enableLocalExport attributes Show enableLocalExport attributes object

            • formats array[string]
            • defaultConfig object
              Hide defaultConfig attributes Show defaultConfig attributes object

              • chunkType string Required

                Values are year, month, week, day, or none.

              • includeAttachments boolean Required
          • allowClient object
            Hide allowClient attributes Show allowClient attributes object

            • allowSocialApps array[string] Required
            • allowShareAll boolean Required
          • autoShare object
            Hide autoShare attributes Show autoShare attributes object

            • allowClientApproval boolean Required
            • allowAdditionalShare boolean Required
            • searches array[object] Required
              Hide searches attributes Show searches attributes object

              • type string Required

                Values are name, phone, keywords, or email. Default value is name.

              • values array[string] Required
              • apps array[string] Required
              • dateRange object Required
                Hide dateRange attributes Show dateRange attributes object

                • start string(date-time) | null Required
                • end string(date-time) | null Required
              • exactMatch boolean Required
              • include boolean Required
              • conversationType string Required

                Values are all, dm, or group. Default value is all.

          • shareAll object
            Hide shareAll attributes Show shareAll attributes object

            • apps array[string] Required
            • includeAttachments boolean Required
            • dateRange object
              Hide dateRange attributes Show dateRange attributes object

              • start string(date-time) | null Required
              • end string(date-time) | null Required
            • searchesExclude array[object]
              Hide searchesExclude attributes Show searchesExclude attributes object

              • type string Required

                Values are name, phone, keywords, or email. Default value is name.

              • values array[string] Required
              • apps array[string] Required
              • exactMatch boolean Required
              • conversationType string Required

                Values are all, dm, or group. Default value is all.

        • devices array[object] | null Required

          Not loaded by any route, so always null or an empty list.
        • totalDevicesCount number Required
        • dueDate string(date-time) | null
        • sendEmail boolean

          Default value is false.

        • lockedAt string(date-time) | null
        • hasDueDateCrossed boolean Required
        • status string Required
        • reviewStatus string | null Required

          Values are approved, rejected, not_reviewed, or na.

        • reviewMessage string | null Required
        • lastApprovedBy object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide lastApprovedBy attributes Show lastApprovedBy attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • email string Required
          • phone array[string] Required
          • isActive boolean Required
          • isEmailVerified boolean Required
          • lastActive string(date-time) Required
          • roles array[string] Required
          • avatar object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide avatar attributes Show avatar attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • providerId string Required
            • convertedName string | null Required
            • convertedProviderId string Required
            • provider string Required
            • size number Required

              Size in bytes

            • transferState number | null Required
          • onboardingStatus string | null Required
          • userType string | null Required
          • firstName string Required
          • lastName string Required
          • initials string Required
          • userOrganizations array[object]

            Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
        • ocReviewedByOrg object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide ocReviewedByOrg attributes Show ocReviewedByOrg attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • slug string Required
          • email string Required
          • contact string Required
          • city string Required
          • state string Required
          • country string Required
          • description string Required
          • phone array[string] Required
          • logo string | null Required
          • isActive boolean Required
          • isPriority boolean
          • activePlan object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide activePlan attributes Show activePlan attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • subscription object | null Required

              Not loaded on public routes, so always null there. Only the internal admin organization report loads it.

            • relatedSubscription array[object] | null Required

              Not loaded by any route, so always null or an empty list.
            • organization object | null Required

              Not loaded by any route, so always null.

            • seats number Required
            • seatsUsed number Required
            • devices number Required
            • deviceUsed number Required
            • storage number Required

              Storage in bytes

            • storageUsed number Required

              Storage used in bytes

            • payments array[object] | null Required

              Not loaded by any route, so always null or an empty list.
            • type string Required

              Values are admin, free, limited-access, trial, tier1, tier2, tier3, tier4, tier5, tier6, or tier7.

            • isActive boolean Required
            • isBetweenPlanChanges boolean Required
            • storageInKb number Required
            • storageUsedInKb number Required
            • storageInMb number Required
            • storageUsedInMb number Required
            • storageInGb number Required
            • storageUsedInGb number Required
            • storageInTb number Required
            • storageUsedInTb number Required
            • isFreePlan boolean Required
            • remainingSeats number Required
            • remainingDevices number Required
            • remainingStorage number Required

              Storage left in bytes (storage minus storageUsed).

          • metadata object Required
          • type string Required
          • version string Required

            Values are v1, v2, eu, or ca.

        • ocReviewedAt string(date-time) | null Required
        • ocRequired boolean Required

          Default value is true.

        • allowShareAll boolean Required Deprecated
        • metadata object Required
        • logsConfig object Required
        • sources array[object]
          Hide sources attributes Show sources attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • case object | null Required

            Not loaded by any route, so always null.

          • extractionCode object | null Required

            Not loaded by any route, so always null.

          • dataSource object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide dataSource attributes Show dataSource attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • name string Required
            • displayName string Required
            • category string Required
            • config object | null Required

              Collection options for this source. The keys below are the ones the code reads, for device sources (ios, android).

              Additional properties are allowed.

              Hide config attributes Show config attributes object | null

              • iosEnableEncryptedBackup boolean
              • iosAllowOnlyEncryptedBackup boolean
              • iosAutoIncludeSafariData boolean
              • iosAutoIncludeNotesData boolean
              • androidIgnoreMediaPermission boolean
              • iosAllApps array[string]
              • iosAllowedApps array[string]
              • androidAllApps array[string]
              • androidAllowedApps array[string]
          • caseDataSource object Required

            The full record on routes that load it; null (or an empty list) on routes that do not.

            Hide caseDataSource attributes Show caseDataSource attributes object

            • createdAt string(date-time) Required
            • updatedAt string(date-time) Required
            • id string Required
            • case object | null Required

              Not loaded by any route, so always null.

            • dataSource object Required

              The full record on routes that load it; null (or an empty list) on routes that do not.

              Hide dataSource attributes Show dataSource attributes object

              • createdAt string(date-time) Required
              • updatedAt string(date-time) Required
              • id string Required
              • name string Required
              • displayName string Required
              • category string Required
              • config object | null Required

                Collection options for this source. The keys below are the ones the code reads, for device sources (ios, android).

                Additional properties are allowed.

                Hide config attributes Show config attributes object | null

                • iosEnableEncryptedBackup boolean
                • iosAllowOnlyEncryptedBackup boolean
                • iosAutoIncludeSafariData boolean
                • iosAutoIncludeNotesData boolean
                • androidIgnoreMediaPermission boolean
                • iosAllApps array[string]
                • iosAllowedApps array[string]
                • androidAllApps array[string]
                • androidAllowedApps array[string]
            • config object | null Required
          • config object | null Required
        • payment object | null Required
      • totalExtractionCodes number Required
      • dataUsedInBytes number Required
      • totalCaseFileSize number Required
      • hasCaseFiles boolean Required
      • dataSources array[object] Required
        Hide dataSources attributes Show dataSources attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • case object | null Required

          Not loaded by any route, so always null.

        • dataSource object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide dataSource attributes Show dataSource attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • displayName string Required
          • category string Required
          • config object | null Required

            Collection options for this source. The keys below are the ones the code reads, for device sources (ios, android).

            Additional properties are allowed.

            Hide config attributes Show config attributes object | null

            • iosEnableEncryptedBackup boolean
            • iosAllowOnlyEncryptedBackup boolean
            • iosAutoIncludeSafariData boolean
            • iosAutoIncludeNotesData boolean
            • androidIgnoreMediaPermission boolean
            • iosAllApps array[string]
            • iosAllowedApps array[string]
            • androidAllApps array[string]
            • androidAllowedApps array[string]
        • config object | null Required
      • dataSourcesStatusCount object Required
  • statusCode number Required
  • timestamp string(date-time) Required