Responses

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

  • data object Required
    Hide data attributes Show data 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
  • statusCode number Required
  • timestamp string(date-time) Required