INintheloop
Conversation

Get Conversation search list.

post/api/v1/conversation/list

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Query parameters

isCommunityAdminRequestboolean

Community admin request.

Headers

Authorizationstring

Authorization header.

X-Impersonate-Userstring

Impersonation header.

Request body

queryTextstring

Query text

sizeinteger required

Size of results

sortOrder'Descending' | 'Ascending' required

Sort direction enum

sortType'ModifiedDate' | 'CreatedDate' | 'ViewDate' required

Sort Type enum

historyIdstring

Histroy id

historyStartDatestring date-time

Histroy start date if HistoryId is not yet define

historyEndDatestring date-time

Histroy start end if HistoryId is not yet define

responseFormatstring

Response format (small)

$typestring required
conversationConditionsRelation'Or' | 'And' | 'OrNot' | 'AndNot' required

Query relation enum.

conversationIdsstring[]

Filter by converstaion ids

hasUnreadsboolean

Does conversation contain unreads

viewDateGreaterThanstring date-time

View date must be greater than

conversationDateFromstring date-time

Conversation date (precision is date without hour - search by date) must be greater than or equal

conversationDateTostring date-time

Conversation date (precision is date without hour - search by date) must be less than or equal

channelIdsstring[]

Filter list of channels one must exists

includeOldPersonalConversationsboolean required

Get old personal cards

includeConversationAttachmentSignedLinkboolean required

Include conversation attachment signed links

showOnlyAssignedboolean required

Show only assigned conversations

showOnlyNotAssignedboolean required

Show only not assigned conversations

showOnlyPurgedboolean required

Show only purged conversation

showOnlyNotPurgedboolean required

Show only not purged conversations

hasPreventPurgeTagboolean

Does conversation has / has not prevent purge tag

showOnlyChannelDeletedViewboolean required

Show only channel deleted view

showOnlyClosedConversionboolean required

Show only closed conversation

showOnlyNotClosedConversionboolean required

Show only not closed conversation

showOnlyConversionWithAttachmentboolean required

Show only conversation with attachments

showOnlyConversionWitNoAttachmentboolean required

Show only conversation with no attachments

Response

OK

sizeinteger required

Page size

offsetinteger required

Page offset

offsetHistoryIdstring

Offset history id

totalSizeinteger required

Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size

Changes

No recorded changes to this operation across all 1 revision of this API.