Conversations

Search archived conversations

Changed on

Search across all archived conversations (assistant and agent) for the authenticated user.

Overview:

Performs a case-insensitive substring match against conversation titles and message content across both assistant (Conversation) and agent (AgentConversation) archived collections. Results are merged server-side and sorted by lastActivityAt descending.

Search parameter:

The search query parameter is required, must contain a non-space character, and is capped at 1000 characters; it is trimmed before use. Requests that omit it, send only spaces or exceed the cap return 400 VALIDATION_ERROR. A value holding markup or a printf-style format specifier (such as %s) is refused by the controller with 400 HTTP_BAD_REQUEST.

Query parameters not listed here are dropped by the validator and ignored.

Pagination:

Results are paginated using page and limit. The response includes a pagination block with total counts and a summary block that breaks matches down by source.

Item shape:

Each item is a conversation list entry (no messages payload — that field is omitted for performance) tagged with source, plus computed isOwner, accessLevel, archivedAt, and archivedBy. agentKey is present only when source is agent.

get/conversations/show/archives/search

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/conversations/show/archives/search
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: conversation:read

Query parameters

searchstring required

Search term to match against conversation titles and message content (max 1000 chars)

pagenumber

Page number (1-indexed). The validator accepts any number, so a fraction such as 1.5 is not refused; it is truncated (1.5 reads as page 1).

limitnumber

Items per page. A fraction is not refused; it is truncated (5.5 reads as 5).

Response

Search results across archived conversations

Changes

    • breaking

      added the pattern \S to the query request parameter search

    • info

      for the query request parameter limit, the type was generalized from integer to number

    • info

      for the query request parameter page, the type was generalized from integer to number

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property ////// to the response with the status