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.

• organization string
• userRole string

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

• sortBy string

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

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] Required
      Hide data attributes Show data attributes object

      • createdAt string(date-time) Required
      • updatedAt string(date-time) Required
      • id string Required
      • invitedUserEmail string Required
      • invitedUserName string Required
      • invitedUserPhone array[string] Required

        Phone numbers stored on the invitation. No invite flow fills it today, so it is an empty list.

      • 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 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.

      • invitedUserRole string Required

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

      • status string Required

        Values are pending, accepted, or rejected.

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

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

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