Sign in

v1

latestOpenAPI 3.0.02026-07-1412360190.8 KB
Conversations

Gets a list of conversations

Gets a list of conversations and communities the authenticated user participates in. OauthScopes: READ_CONVERSATIONS

get/conversations

Query parameters

modTimestring date-time

The modification time of the conversation in UTC format. During the query the conversations before (<i>default</i>) or after this timestamp are returned. In case no timestamp is specified the current server time in UTC is used, i.e. the last 25 modified conversations are returned

direction'BEFORE' | 'AFTER'

The direction of the search based on the modification time. Valid values are either BEFORE (default) or AFTER

resultsnumber

The maximum number of returned results (default 25). The maximum allowed value is 100.

Response

The matching conversations

avatarstring

The URL of the small avatar image of the conversation

avatarLargestring

The URL of the large avatar image of the conversation

convIdstring

The ID of the conversation

creationTimenumber

UTC timestamp when the conversation was created

creatorIdstring

The ID of the user who created the conversation

creatorTenantIdstring

The ID of the Circuit domain (tenant) where the creator of the conversation belongs to

descriptionstring

The description of the conversation. This field is available only for conversations with type COMMUNITY

isGuestAccessDisabledboolean

Indicates whether guest access to the conversation is disabled or not

isModeratedboolean

Indicates whether the conversation is moderated or not. In a moderated conversation only participants who have been assigned the role of a moderator are allowed to add or remove participants into the conversation

modificationTimenumber

UTC timestamp when the conversation was modified. A conversation is modified when any of the conversation object fields change but not when conversation items are added or edited

participantsstring[]

Array of active participants

topicstring

The title of the conversation. Conversations of type DIRECT cannot have a title

topicPlaceholderstring

The title of the conversation. Conversations of type DIRECT cannot have a title

typestring

The type of the conversation. It can be one of the following: DIRECT, GROUP, COMMUNITY or LARGE

All 123 operations