Sign in

v1

latestOpenAPI 3.0.02026-07-1412360190.8 KB
Conversations

Gets a list of communities

Gets a list of communities. This endpoint can be used to explore the communities the authenticated user could join. OauthScopes: READ_CONVERSATIONS

get/conversations/community

Query parameters

sort'ALPHABETICALLY' | 'RECENT_ACTIVITY' | 'POPULARITY'

Defines the type of sorting for the community conversations (default is alphabetical)

order'ASCENDING' | 'DESCENDING'

Defines the ordering of the conversations (default is ascending)

includeOwnboolean

If set to false only conversations are returned where the user is no member of, otherwise all community conversations are returned

startIndexnumber

The index of the conversation that is the first one that has to be returned. E.g. if a request starts with startIndex 40 and results 20 the conversations 40 to 60 are returned

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