Search conversation threads

post

https://rls.congacloud.com/api/clm/v1/conversation-threads/search

Searches conversation threads by keyword across subjects, message content, participant names, and optionally document names.

Required Parameters:

searchText: Keyword to search for
objectType: Object type (e.g., "Agreement")
objectId: Specific object ID to search threads for

Search Scope:

Thread subject/name (exact and partial matches)
Message content across all messages in threads
Participant names (both internal Users and external Contacts)
Document names (when searchInAttachments is true)

Example Request (Search across Agreement and amendments):

{
  "searchText": "contract review",
  "objectType": "Agreement",
  "objectId": "CON-12345",
  "searchInAttachments": true,
  "sortBy": "ModifiedDate",
  "sortDirection": "Descending",
  "limit": 10,
  "skip": 0
}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Search request with search text and optional filters

Request model for searching conversation threads.

SearchText

string | null

Search text to look for in thread names, message content, participant names, and document names.

ThreadId

string | null

Optional thread ID to limit search within a specific thread.
If provided, searches only within this thread. If null/empty, searches across all threads.

ObjectType

string | null

Required object type to filter threads by related object type (e.g., "Agreement", "AgreementClause").
Must be provided together with ObjectId.

ObjectId

string | null

Required object ID to filter threads by specific related object.
Must be provided together with ObjectType. Both are required for the search endpoint.

SortBy

string | null

Field name to sort results by (e.g., "ModifiedDate", "Name", "MessageCount").
Default is "ModifiedDate".

SortDirection

string | null

Sort direction: "Ascending" or "Descending".
Default is "Descending" (latest modified at top).

Limit

int32 | null

Number of records to return (pagination).

Skip

int32 | null

Number of records to skip (pagination).

SearchInAttachments

boolean

Include search in document attachments. When true, searches document names for matching text.
Default is false for better performance.

ContractNumbers

array of strings | null

Gets or sets the list of contract numbers associated with the entity.

ContractNumbers

Responses

200Successfully retrieved matching threads

400Invalid search request (e.g., missing required parameters: searchText, objectType, or objectId)

500Internal Server Error