Headers

• organization string Required

  id of the selected (active) organization

Path parameters

• caseId string Required

  Id of the case

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.

• sourceType string

  Values are DeviceMessage, DeviceConversation, UserEmailData, FinancialAccount, CaseFile, UserEmailDataThread, LinkedInConversation, LinkedInJobApplication, or AiChatConversation.

• sourceId string
• collection string
• conversation string
• parent string
• searchText string
• messages array[string]
• startMessageIndex number

  Required if endMessageIndex is provided

• endMessageIndex number

  Required if startMessageIndex is provided

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
      • text string Required
      • source string | null Required

        Id of the commented item (its kind is sourceType)

      • sourceType string Required

        Values are DeviceMessage, DeviceConversation, UserEmailData, FinancialAccount, CaseFile, UserEmailDataThread, LinkedInConversation, LinkedInJobApplication, or AiChatConversation.

      • deviceMessage string | null Required

        Id of the commented message, for message comments

      • 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.
      • parent string | null Required

        Id of the comment this one replies to

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