Agents

Get agent conversation by ID

Changed on Oct 28, 2026

Returns the conversation with paginated/sorted messages and filter metadata.

Message Pagination:

Messages are paginated newest-first: page=1 returns the most recent batch. Increment page to load older batches (used by the infinite-scroll "load older messages" feature).

page: Page number (default: 1)
limit: Messages per page (default: 20, max: 100)

get/agents/{agentKey}/conversations/{conversationId}

Request

Base URL
https://app.pipeshub.com/api/v1
URL
https://app.pipeshub.com/api/v1/agents/{agentKey}/conversations/{conversationId}
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

conversationIdstring objectId required

Query parameters

pageinteger

Page number for message pagination (1 = most recent batch)

limitinteger

Number of messages per page

sortBy'createdAt' | 'messageType' | 'content'

Field to sort messages by

sortOrderstring

Sort direction. asc sorts ascending; any other value, including an unrecognised one, is read as desc and is not refused.

startDatestring

Filter messages created on or after this date, as an ISO 8601 date or date-time. The validator accepts any string JavaScript Date can parse (so also forms like May 1 2020 or 2999/01/01); one it cannot parse returns HTTP 400. An empty value is read as not sent.

endDatestring

Filter messages created on or before this date, as an ISO 8601 date or date-time. The validator accepts any string JavaScript Date can parse (so also forms like May 1 2020 or 2999/01/01); one it cannot parse returns HTTP 400. An empty value is read as not sent.

Filter messages by type. An empty value is read as not sent.

Response

Agent conversation detail

Changes

Oct 28, 2026dbb5e203b445 Revision changes
- breaking
  removed the enum value asc from the query request parameter sortOrder
- breaking
  removed the enum value desc from the query request parameter sortOrder
- 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
  the ///// response's property type changed from object to no type for status
- breaking
  the ///// response's property type changed from object to no type for status
- breaking
  the ///// response's property type changed from object to no type for status
- breaking
  the ///// response's property type changed from object to no type for status
- breaking
  the ///// response's property type changed from object to no type for status
- breaking
  the //// response's property type changed from object to no type for status
- breaking
  the //// response's property type changed from object to no type for status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ////// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- info
  added the new enum value to the query request parameter messageType
- 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 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 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 to the //// response property anyOf list for the response status
- info
  added to the ///// response property anyOf list for the response status
- info
  added to the ///// response property anyOf list for the response status
- info
  added to the ///// response property anyOf list for the response status
- info
  added to the ///// response property anyOf list for the response status
- info
  added to the ///// response property anyOf list for the response status
- info
  added subschema #1 to the //// response property anyOf list for the response status
Oct 26, 2026fc76aa045994 Revision changes
- breaking
  the response property / became optional for the status
- info
  added the optional property / to the response with the status
- info
  added the optional property /// to the response with the status

Operation history (7 revisions)