PIpipeshub-ai
Agents

List archived conversations for an agent

Changed on

Paginated list of the caller's archived conversations for the given agent key. The agentKey is matched against the stored conversations only; the agent itself is not looked up.

The query is strict: a parameter not listed here is refused with 400 (VALIDATION_ERROR on query, "These fields aren't accepted here").

get/agents/{agentKey}/conversations/show/archives

Request

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

Path parameters

agentKeystring required

Query parameters

pageinteger

1-based page number. A value below 1 or one that is not a number is read as 1; neither is refused.

limitinteger

Page size. A value outside 1..100 or one that is not a number is read as 20; neither is refused.

sortBystring

Sort field. Supported values are createdAt, lastActivityAt and title; any other value is accepted and ignored (the list is then sorted by lastActivityAt).

sortOrderstring

Sort direction, asc or desc; any other value is accepted and ignored (descending order).

searchstring

Case-insensitive search over the conversation title and message content. A printf-style format specifier (%s, %x, ...) is refused with VALIDATION_ERROR; markup (HTML tags, javascript:, event handlers) is refused with HTTP_BAD_REQUEST by the sanitizer every route runs.

startDatestring

Inclusive lower bound on createdAt, as an ISO 8601 date or date-time. The validator accepts any string JavaScript Date can parse (so also forms like May 1 2026 or 2026/05/01); one it cannot parse returns HTTP 400. An empty value is read as not sent.

endDatestring

Inclusive upper bound on createdAt, as an ISO 8601 date or date-time. The validator accepts any string JavaScript Date can parse (so also forms like May 1 2026 or 2026/05/01); one it cannot parse returns HTTP 400. An empty value is read as not sent.

Response

Archived conversations for the agent

Changes

  • dbb5e203b445Revision changes
    • breaking

      removed the enum value asc from the query request parameter sortOrder

    • breaking

      removed the enum value createdAt from the query request parameter sortBy

    • breaking

      removed the enum value desc from the query request parameter sortOrder

    • breaking

      removed the enum value lastActivityAt from the query request parameter sortBy

    • breaking

      removed the enum value title from the query request parameter sortBy

    • breaking

      added the pattern ^$|^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}(:\d{2}(\.\d+)?)?(Z|[+-]\d{2}:?\d{2})?)?$ to the query request parameter endDate

    • breaking

      added the pattern ^$|^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}(:\d{2}(\.\d+)?)?(Z|[+-]\d{2}:?\d{2})?)?$ to the query request parameter startDate

    • breaking

      added the pattern ^(?![\s\S]*?(?:(?<!\w)%(?:\d{1,10}\$)?[#0\-+ ]{0,10}(?:\d{1,10})?(?:\.\d{1,10})?(?:h{1,2}|l{1,2}|L|z|j|t)?[nsxXp]|<[^>]{0,10000}>)) to the query request parameter search

    • info

      for the query request parameter endDate, the format was generalized from date-time to no format

    • info

      for the query request parameter startDate, the format was generalized from date-time to no format

    • 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

  • fc76aa045994Revision changes
    • info

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

    • info

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