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
• case string
• searchText string

  Minimum length is 3, maximum length is 100.

• status string

  Values are pending, accepted, or rejected.

• accessLevel string

  Values are owner, admin, commenter, or viewer.

• 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]
      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
      • invitedBy object Required

        Who sent the invite

        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.
      • invitedUser string | null Required
      • acceptedBy string | null Required
      • organization string Required
      • case string Required
      • accessOrganization string | null Required

        The opposing counsel's organization, for OC invites

      • invitedUserRole string Required

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

      • invitedUserAccessLevel string Required

        Values are owner, admin, commenter, or viewer.

      • status string Required

        Values are pending, accepted, or rejected.

      • emailSent boolean Required
      • emailSentAt string(date-time) | null Required
  • statusCode number Required
  • timestamp string(date-time) Required