Query parameters

• page number

  Default value is 1.

• perPage number

  Default value is 10.

• skip number

  If skip/limit not provided, page/perPage will take precedence

• limit number

  If skip/limit not provided, page/perPage will take precedence

• sortOrder string

  Values are asc or desc. Default value is asc.

• searchText string

  Minimum length is 1, maximum length is 100.

• sortBy string

  Values are createdAt, updatedAt, or name. Default value is createdAt.

Responses

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

  • data object Required
    Hide data attributes Show data attributes object

    • total number Required
    • page number
    • perPage number
    • skip number
    • limit number
    • totalPages number Required
    • nextPage number | null Required
    • previousPage number | null Required
    • data array[object]
      Hide data attributes Show data 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.

  • statusCode number Required
  • timestamp string(date-time) Required