List archived conversations
Changed onRetrieve all archived conversations for the authenticated user.
Overview:
Archived conversations are hidden from the main list but preserved for reference. This endpoint returns only conversations where isArchived: true and archivedBy is set. Results include conversations the caller owns and those shared with them (isShared and the caller listed in sharedWith). Deleted and agent conversations are never listed. Each item carries its messages.
Filtering and sorting:
Results can be narrowed using search, shared, startDate, endDate, and conversationId. Sorting is controlled by sortBy and sortOrder. Pagination is controlled by page and limit.
Query parameters not listed here are dropped by the validator and ignored, including projectId, which GET /conversations accepts.
Unarchiving:
Use PATCH /conversations/{conversationId}/unarchive to restore a conversation to the active list.
Request
- Base URLhttps://app.pipeshub.com/api/v1
- URLhttps://app.pipeshub.com/api/v1/conversations/show/archives
- Auth
- HTTP bearer
- or OAuth 2Authorization code: /api/v1/oauth2/authorizeClient credentialsToken URL: /api/v1/oauth2/token scopes: conversation:read
Query parameters
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).
Items per page. A fraction is not refused; it is truncated (5.5 reads as 5).
Field to sort by
Sort direction
Case-insensitive substring match against title and message content (max 1000 chars). A value holding markup is refused by the controller with 400 HTTP_BAD_REQUEST.
When set, filters by isShared. Accepts exactly true, false, 1 or 0.
Include conversations created on or after this instant. Must be a full ISO 8601 date-time with Z or a numeric offset; a bare date is refused.
Include conversations created on or before this instant. Must be a full ISO 8601 date-time with Z or a numeric offset; a bare date is refused.
Restrict results to a single conversation by identifier
Response
List of archived conversations
Changes
- breaking
the
queryrequest parametersharedwas restricted to a list of enum values - breaking
added the pattern
^[0-9a-fA-F]{24}$to thequeryrequest parameterconversationId - breaking
added the pattern
^\d{4}-\d{2}-\d{2}T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d+)?(Z|[+-]\d{2}:?\d{2})$to thequeryrequest parameterendDate - breaking
added the pattern
^\d{4}-\d{2}-\d{2}T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d+)?(Z|[+-]\d{2}:?\d{2})$to thequeryrequest parameterstartDate - breaking
the
//////////response's property type changed fromobjectto no type for status - breaking
the
//////////response's property type changed fromobjectto no type for status - breaking
the
//////////response's property type changed fromobjectto no type for status - breaking
the
//////////response's property type changed fromobjectto no type for status - breaking
the
//////////response's property type changed fromobjectto no type for status - breaking
the
/////////response's property type changed fromobjectto 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 - info
added the new enum value
0to thequeryrequest parametershared - info
added the new enum value
1to thequeryrequest parametershared - info
added the new enum value
falseto thequeryrequest parametershared - info
added the new enum value
trueto thequeryrequest parametershared - info
for the
queryrequest parameterlimit, the type was generalized fromintegertonumber - info
for the
queryrequest parameterpage, the type was generalized fromintegertonumber - info
for the
queryrequest parametershared, the type was generalized frombooleantostring - info
added the media type
application/jsonfor 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 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 propertyanyOflist for the response status - info
added to the
//////////response propertyanyOflist for the response status - info
added to the
//////////response propertyanyOflist for the response status - info
added to the
//////////response propertyanyOflist for the response status - info
added to the
//////////response propertyanyOflist for the response status - info
added to the
/////////response propertyanyOflist for the response status - info
added
subschema #1to the/////////response propertyanyOflist for the response status
- breaking
- info
added the optional property
//////to the response with the status
- info