Headers

• organization string Required

  id of the selected (active) organization

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.

• case string
• conversationIds array[string]
• searchText string

  Minimum length is 3, maximum length is 100.

• source string

  Values are message, whatsapp, voicemail, call_log, facebook_dump, instagram_dump, threads_dump, or email.

• sources array[string]

  Values are message, whatsapp, voicemail, call_log, facebook_dump, instagram_dump, threads_dump, or email.

• linkedContacts array[string]
• devices array[string]
• tags array[string]
• sortBy string

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

• hideExported number

  0 false, 1 true, default 0 (false)

  Default value is 0.

• isArchived number

  0 false, 1 true, default 0 (false)

  Default value is 0.

• isStarred number

  0 false, 1 true, default 0 (false)

  Default value is 0.

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
      • messageSharing object Required
      • selectionCoverage object
      • name string Required
      • displayName string Required

        'Conversation with ' unless the name was edited, in which case the edited name as typed.

      • chatName string Required
      • originalDisplayName string Required
      • source string Required

        Values are message, whatsapp, voicemail, call_log, facebook_dump, instagram_dump, threads_dump, or email.

      • linkedContacts array[object] | null Required

        Not loaded by any route, so always null or an empty list.
      • device object Required

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

        Hide device attributes Show device attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • deviceId string Required
        • serialNumber string Required
        • name string Required
        • type string Required
        • nonDeviceType string | null Required
        • model string Required
        • timeZone string Required
        • osVersion string Required
        • owner object | null Required

          Not loaded by any route, so always null.

        • devicePhoneNumber string Required
        • organizations array[string] Required

          Organization ids

        • extractionCodes array[string] Required

          Extraction code ids

        • availableData object

          Which data types exist for this device (optionally scoped by query filters).

      • 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
      • service string Required
      • lastMessageText string Required
      • firstMessageDate string(date-time) | null Required
      • lastMessageDate string(date-time) Required
      • displayNameEditedAt string(date-time) | null Required
      • lastMessageExternalId string Required
      • isGroup boolean Required

        Default value is false.

      • owner object | null Required

        Not loaded by any route, so always null.

      • isReadonly boolean Required
      • lastExportedAt string(date-time) | null Required
      • messagesCount number Required
      • archivedBy object | null Required

        Not loaded by any route, so always null.

      • archivedAt string(date-time) | null Required
      • starredAt string(date-time) | null Required
      • tags array[object] | null Required

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

        Hide tags attributes Show tags attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • name string Required
        • nameLowercase string Required
        • backgroundColor string Required
        • textColor string Required
        • type string Required

          Values are system, organization, case, or user.

        • severity string Required

          Values are info, warning, or danger.

        • origin string Required

          Values are manual or auto-import.

        • creatorAccessType string | null

          Values are org or opposing_council.

        • isActive boolean Required
      • attachedTags array[object]
        Hide attachedTags attributes Show attachedTags attributes object

        • tagId string Required

          Tag id (Tag._id)

        • tag string Required

          Tag display name (Tag.name)

        • addedBy string Required

          Values are user, ai, auto, auto-import, system, or default.

        • addedById string | null
        • removedAt string(date-time) | null
        • removedBy string | null

          Values are user, ai, auto, auto-import, system, or default.

        • removedById string | null
      • isPlaceholder boolean Required
      • isArchived boolean Required
      • isStarred boolean Required
      • hasAllAttachmentProcessed boolean Required
      • processedAttachmentCount number Required
      • conversationName string Required
      • isNameEdited boolean Required
      • participantCount number Required
  • statusCode number Required
  • timestamp string(date-time) Required