openapi-directory/api/circuitsandbox.net.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://circuitsandbox.net/rest/v2"}],"x-hasEquivalentPaths":true,"info":{"description":"Circuit REST API to interact with the Circuit system.\n\n[Learn more about the Circuit Development Community](https://www.circuit.com/web/developers/home)","title":"REST API Version 2","version":"2.9.235","x-apisguru-categories":["messaging"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://pbs.twimg.com/profile_images/927933988269903874/4jU82-IJ_400x400.jpg"},"x-origin":[{"format":"openapi","url":"https://circuitsandbox.net/rest/v2/swagger","version":"3.0"}],"x-providerName":"circuitsandbox.net"},"paths":{"/conversations":{"get":{"description":"Gets a list of conversations and communities the authenticated user participates in.\nOauthScopes: READ_CONVERSATIONS","operationId":"getConversations","parameters":[{"description":"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","in":"query","name":"modTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"The direction of the search based on the modification time. Valid values are either BEFORE (default) or AFTER","in":"query","name":"direction","required":false,"schema":{"default":"BEFORE","enum":["BEFORE","AFTER"],"maxLength":2048,"type":"string"}},{"description":"The maximum number of returned results (default 25). The maximum allowed value is 100.","in":"query","name":"results","required":false,"schema":{"default":25,"format":"int32","maximum":100,"minimum":1,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Conversation"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/Conversation"},"type":"array"}}},"description":"The matching conversations"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Gets a list of conversations","tags":["Conversations"]}},"/conversations/byIds":{"get":{"description":"Gets conversation based on the given IDs.\nOauthScopes: READ_CONVERSATIONS","operationId":"getConversationsById","parameters":[{"description":"The array of IDs of the conversations which should be retrieved","explode":true,"in":"query","name":"convIds","required":true,"schema":{"items":{"maxLength":2048,"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Conversation"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/Conversation"},"type":"array"}}},"description":"List of existing conversations successfully retrieved."},"400":{"description":"missing documentation"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Gets conversations","tags":["Conversations"]}},"/conversations/community":{"get":{"description":"Gets a list of communities. This endpoint can be used to explore the communities the authenticated user could join.\nOauthScopes: READ_CONVERSATIONS","operationId":"getCommunityConversations","parameters":[{"description":"Defines the type of sorting for the community conversations (default is alphabetical)","in":"query","name":"sort","required":false,"schema":{"default":"ALPHABETICALLY","enum":["ALPHABETICALLY","RECENT_ACTIVITY","POPULARITY"],"maxLength":2048,"type":"string"}},{"description":"Defines the ordering of the conversations (default is ascending)","in":"query","name":"order","required":false,"schema":{"default":"ASCENDING","enum":["ASCENDING","DESCENDING"],"maxLength":2048,"type":"string"}},{"description":"If set to false only conversations are returned where the user is no member of, otherwise all community conversations are returned","in":"query","name":"includeOwn","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"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","in":"query","name":"startIndex","required":false,"schema":{"default":0,"format":"int32","maximum":255,"minimum":0,"type":"number"}},{"description":"The maximum number of returned results (default 25). The maximum allowed value is 100.","in":"query","name":"results","required":false,"schema":{"default":25,"format":"int32","maximum":100,"minimum":1,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Conversation"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/Conversation"},"type":"array"}}},"description":"The matching conversations"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul>a field constraint is violated</ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Gets a list of communities","tags":["Conversations"]},"post":{"description":"Creates a community. Communities are open conversations that anyone in a Circuit domain (tenant) can join without having to be added by another user.\nOauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS","operationId":"createCommunityConversation","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"description":{"description":"An optional description for the community conversation","maxLength":2048,"type":"string"},"participants":{"description":"list of participants that will be part of this conversation, specified by the Circuit user ID or the unique email address. At least one participant needs to be added","items":{"maxLength":2048,"type":"string"},"type":"array"},"topic":{"description":"An optional topic of the conversation. If not set the Circuit client will render the names of the participants as topic of the conversation (the first 4 names will be used)","maxLength":2048,"type":"string"}},"required":["topic"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"The conversation was created successfully and can be accessed via the conversation ID"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the userIds passed as parameter are not provided in the correct format</li><li> or an valid email address</li><li>or one or more of the user do not exist</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MANAGE_CONVERSATIONS"]}],"summary":"Creates a community conversation","tags":["Conversations"]}},"/conversations/community/{convId}":{"put":{"description":"Updates the information of the given community.\nOauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS","operationId":"updateConversationCommunity","parameters":[{"description":"The ID of the conversation which should be updated","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"description":{"description":"An optional description for the community conversation","maxLength":2048,"type":"string"},"topic":{"description":"An optional topic of the conversation. If not set the Circuit client will render the names of the participants as topic of the conversation (the first 4 names will be used)","maxLength":2048,"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"Gets the updated conversation object with the new topic / description"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li><li>the conversation is not of type COMMUNITY</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MANAGE_CONVERSATIONS"]}],"summary":"Updates the information of a community","tags":["Conversations"]}},"/conversations/community/{convId}/join":{"post":{"description":"Adds the authenticated user to the given community (i.e., allows the user to join this community). Contrary to the operation of adding a new participant, this operation can only be performed by a user who is not yet a member of the community.\nOauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS","operationId":"joinCommunityConversation","parameters":[{"description":"The ID of the conversation which the user will join","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"Gets the conversation object to which the participants was added"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the userIds passed as parameter are not provided in the correct format</li><li> or an valid email address</li><li>or one or more of the user do not exist</li><li>the conversation does not exist</li><li>the conversation is not of type COMMUNITY</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MANAGE_CONVERSATIONS"]}],"summary":"Adds the authenticated user to a community","tags":["Conversations"]}},"/conversations/community/{convId}/participants":{"delete":{"description":"Removes one or more participants from the given community. The last participant of a community cannot be removed. This operation can only be performed by a user who is already a member of the community.\nOauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS","operationId":"removeParticipantCommunity","parameters":[{"description":"The ID of the conversation from which the participant have to be removed","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}},{"description":"The IDs or the unique email addresses of the Circuit users that have to be removed","explode":true,"in":"query","name":"participants","required":true,"schema":{"items":{"maxLength":6500,"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"Gets the conversation object from which the participants were removed."},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul></li>the userIds passed as parameter are not provided in the correct format</li><li> or an valid email address</li><li>or one or more of the user do not exist</li><li>the conversation does not exist</li><li>the conversation is not of type COMMUNITY</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MANAGE_CONVERSATIONS"]}],"summary":"Removes participants from a community","tags":["Conversations"]},"post":{"description":"Adds one or more participants to the given community. This operation can only be performed by a user who is already a member of the community.\nOauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS","operationId":"addParticipantCommunity","parameters":[{"description":"The ID of the conversation to which the participant has to be added.","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/addParticipantCommunity"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"Gets the conversation object to which the participants were added."},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the userIds passed as parameter are not provided in the correct format</li><li> or an valid email address</li><li>or one or more of the user do not exist</li><li>the conversation does not exist</li><li>the conversation is not of type COMMUNITY</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MANAGE_CONVERSATIONS"]}],"summary":"Adds participants to a community","tags":["Conversations"]}},"/conversations/conversationdetails":{"get":{"description":"Gets the conference details of the given conversations. Conference details include the URL, which is used to join the conference through a web or mobile application, as well as the dial-in phone numbers and conference PIN, which are used to join the conference by phone.\nOauthScopes: READ_CONVERSATIONS","operationId":"getJoinDetailsMultiple","parameters":[{"description":"An array of IDs of the conversations for which the join details should be returned","explode":true,"in":"query","name":"convIds","required":true,"schema":{"items":{"maxLength":2048,"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ConversationDetails"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/ConversationDetails"},"type":"array"}}},"description":"The join details."},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Gets the conference details for multiple conversations","tags":["Conversations"]}},"/conversations/direct":{"get":{"description":"Checks if a 1-to-1 conversation between the authenticated user and the user with the provided userId exists.\nOauthScopes: READ_CONVERSATIONS","operationId":"getDirectConversation","parameters":[{"description":"The participant that will be part of this conversation together with the creator, specified by the Circuit user ID or the unique email address","in":"query","name":"participant","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"The conversation was found and can be accessed via the conversation ID"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the data format of the passed user does not match either a UUID (user primary key)</li><li> or an valid email address</li><li>or the user does not exist</li><li>or the user is the same who initiates the request</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Checks for a 1-to-1 conversation","tags":["Conversations"]},"post":{"description":"Creates a 1-to-1 conversation between the authenticated user and the user with the provided userId. In case there is already an existing 1-to-1 conversation between these users, the endpoint returns the existing conversation.\nOauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS","operationId":"createDirectConversation","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"participant":{"description":"The participant that will be part of this conversation together with the creator, specified by the Circuit user ID or the unique email address","maxLength":2048,"type":"string"}},"required":["participant"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"The conversation was created successfully and can be accessed via the conversation ID"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the data format of the passed user does not match either a UUID (user primary key)</li><li> or an valid email address</li><li>or the user does not exist</li><li>or the user is the same who initiates the request</li></ul>"},"401":{"description":"The authentication was not successful"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"A conversation already exists. The response contains this conversation."},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MANAGE_CONVERSATIONS"]}],"summary":"Creates a 1-to-1 conversation","tags":["Conversations"]}},"/conversations/favorite":{"get":{"description":"Gets the conversationIds which are marked as favorites.\nOauthScopes: READ_CONVERSATIONS","operationId":"getFavoriteConversations","responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/String"},"type":"array"}}},"description":"A list of marked conversations or an empty response."},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li><li>the user is no participant of the conversation</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Gets favorite conversations","tags":["Conversations"]}},"/conversations/group":{"post":{"description":"Creates a group conversation between three or more users. The authenticated user is directly added to this conversation.\nOauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS","operationId":"createGroupConversation","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"participants":{"description":"A list of participants that will be part of this conversation, specified by the Circuit user ID or the unique email address. At least one participant needs to be added","items":{"maxLength":2048,"type":"string"},"type":"array"},"topic":{"description":"An optional topic of the conversation. If not set the Circuit client will render the names of the participants as topic of the conversation (the first 4 names will be used)","maxLength":2048,"type":"string"}},"required":["participants"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"The conversation was created successfully and can be accessed via the conversation ID"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the userIds passed as parameter are not provided in the correct format</li><li> or an valid email address</li><li>or one or more of the user do not exist</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MANAGE_CONVERSATIONS"]}],"summary":"Creates a group conversation","tags":["Conversations"]}},"/conversations/group/{convId}":{"put":{"description":"Updates the information of the given group conversation.\nOauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS","operationId":"updateConversationGroup","parameters":[{"description":"The ID of the conversation which should be updated","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"topic":{"description":"An optional topic of the conversation. If not set the Circuit client will render the names of the participants as topic of the conversation (the first 4 names will be used)","maxLength":2048,"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"Gets the updated conversation object with the new topic"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li><li>the conversation is not of type GROUP</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MANAGE_CONVERSATIONS"]}],"summary":"Updates the information of a group conversation","tags":["Conversations"]}},"/conversations/group/{convId}/participants":{"delete":{"description":"Removes one or more participants from the given group conversation. The last participant of a group conversation cannot be removed. This operation can only be performed on behalf of a user who is already a member of the conversation.\nOauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS","operationId":"removeParticipantGroup","parameters":[{"description":"The ID of the conversation from which the participant have to be removed","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}},{"description":"The IDs or the unique email addresses of the Circuit users that have to be removed","explode":true,"in":"query","name":"participants","required":true,"schema":{"items":{"maxLength":6500,"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"Gets the conversation object from which the participants were removed."},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the userIds passed as parameter are not provided in the correct format</li><li> or an valid email address</li><li>or one or more of the user do not exist</li><li>the conversation does not exist</li><li>the conversation is not of type GROUP</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MANAGE_CONVERSATIONS"]}],"summary":"Removes participants from a group conversation","tags":["Conversations"]},"post":{"description":"Adds one or more participants to the given group conversation. This operation can only be performed by a user who is already a member of the conversation.\nOauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS","operationId":"addParticipantGroup","parameters":[{"description":"The ID of the conversation to which the participant has to be added.","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/addParticipantCommunity"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"Gets the conversation object to which the participants were added."},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the userIds passed as parameter are not provided in the correct format</li><li> or an valid email address</li><li>or one or more of the user do not exist</li><li>the conversation does not exist</li><li>the conversation is not of type GROUP</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MANAGE_CONVERSATIONS"]}],"summary":"Adds participants to a group conversation","tags":["Conversations"]}},"/conversations/label/{labelId}":{"get":{"description":"Returns conversations with matching labels and paginated \nOauthScopes: READ_CONVERSATIONS","operationId":"getConversationsByLabel","parameters":[{"description":"Id of the label to look for","in":"path","name":"labelId","required":true,"schema":{"maxLength":2048,"type":"string"}},{"description":"Pointer to the next page of conversations if there are any","in":"query","name":"nextPagePointer","required":false,"schema":{"maxLength":2048,"type":"string"}},{"description":"Numbers of max conversations per page","in":"query","name":"pageSize","required":false,"schema":{"default":25,"format":"int32","maximum":100,"minimum":1,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationsPage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ConversationsPage"}}},"description":"Returns a list of conversations that are tagged with a certain label"},"400":{"description":"he request cannot be fulfilled due to bad syntax"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Returns conversations with a certain label","tags":["Conversations"]}},"/conversations/messages/flag":{"get":{"description":"Gets a list of all the messages the authenticated user has flagged. This endpoint should be used carefully in case where the authenticated user has a lot of flagged messages.\nOauthScopes: READ_CONVERSATIONS","operationId":"getFlagItemConv","responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/ConversationItem"},"type":"array"}}},"description":"Gets the list of flagged items"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Gets a list of the flagged messages","tags":["Conversations"]}},"/conversations/messages/{itemId}":{"get":{"description":"Returns a text item for a given item id\nOauthScopes: READ_CONVERSATIONS","operationId":"getSingleConversationtem","parameters":[{"description":"The ID of the item that will be returned","in":"path","name":"itemId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationItem"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ConversationItem"}}},"description":"The item was successful returned"},"400":{"description":"The item with the given id was not found"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Returns a text item","tags":["Conversations"]}},"/conversations/moderate/{convId}":{"post":{"description":"Set a conversation in moderatd mode. Moderators can be added and removed\nOauthScopes: WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS","operationId":"moderateConversation","parameters":[{"description":"The ID of the conversation which will be set to moderated state","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"description":"The conversation is in moderated mode"},"401":{"description":"Permission denied"},"403":{"description":"Forbidden to edit this conversation"},"500":{"description":"Internal server error"},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MODERATE_CONVERSATIONS"]}],"summary":"Set conversation moderated","tags":["Conversations"]}},"/conversations/resolveinvitetoken":{"get":{"description":"Resolves an invite token to a conversation\nOauthScopes: READ_CONVERSATIONS","operationId":"resolveInvitationToken","parameters":[{"description":"The invite token to resolve","in":"query","name":"token","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"Returns the conversation object that belongs to the invite token if you are member of the conversation"},"400":{"description":"In case no invitation token was send"},"401":{"description":"The authentication was not successful"},"404":{"description":"If the token does not exist or you are not member of the conversation "},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Resolves an invite token to a conversation","tags":["Conversations"]}},"/conversations/search":{"get":{"description":"Performs a search for conversation content. A maximum of 100 conversations is returned. If you hit this limit you should refine the search term.\nOauthScopes: READ_CONVERSATIONS","operationId":"searchConversations","parameters":[{"description":"The search term","in":"query","name":"term","required":true,"schema":{"maxLength":2048,"type":"string"}},{"description":"Optional parameter to specify if a deep or normal search is executed. In a deep search all matching item IDs inside every conversation are returned (up to a maximum of 100). For a normal search only the conversation IDs are returned. Default is a normal search (without item IDs).","in":"query","name":"includeItemIds","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"The search scope, FILES||PEOPLE||MEMBERS||MESSAGES||SENTBY||ALL||CONVERSATIONS||LABEL||FILTER","in":"query","name":"scope","required":false,"schema":{"default":"ALL","enum":["FILES","PEOPLE","MEMBERS","MESSAGES","SENTBY","ALL","CONVERSATIONS","LABEL","FILTER"],"maxLength":2048,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationSearchResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ConversationSearchResult"}}},"description":"A list of conversations and items that match the term"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the user is no participant of the conversation</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Performs a conversation search","tags":["Conversations"]}},"/conversations/unmoderate/{convId}":{"post":{"description":"Set a conversation to unmoderatd mode\nOauthScopes: WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS","operationId":"unmoderateConversation","parameters":[{"description":"The ID of the conversation which will be set to unmoderated state","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"description":"The conversation is in unmoderated mode"},"401":{"description":"Forbidden to edit this conversation"},"403":{"description":"Permission denied"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","MODERATE_CONVERSATIONS"]}],"summary":"Set conversation unmoderated","tags":["Conversations"]}},"/conversations/{convId}":{"get":{"description":"Gets a conversation based on the given ID.\nOauthScopes: READ_CONVERSATIONS","operationId":"getConversationbyId","parameters":[{"description":"The ID of the conversation which should be updated","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Conversation"}}},"description":"Gets the conversation object"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Gets a conversation","tags":["Conversations"]}},"/conversations/{convId}/archive":{"delete":{"description":"The conversation will no longer be archived but active again\nOauthScopes: WRITE_CONVERSATIONS","operationId":"undoArchiveConversation","parameters":[{"description":"The ID of the conversation which will be unmarked as muted","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"description":"The conversation was successfully unmarked"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li><li>the user is no participant of the conversation</li><li>a field constraint is violated</li><li>the conversation was not marked before</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS"]}],"summary":"Unmute conversation","tags":["Conversations"]},"post":{"description":"Archives a conversation by muting it\nOauthScopes: WRITE_CONVERSATIONS","operationId":"archiveConversation","parameters":[{"description":"The ID of the conversation which will be archived","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"description":"The conversation was successfully archived"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li><li>the user is no participant of the conversation</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS"]}],"summary":"Archives conversation","tags":["Conversations"]}},"/conversations/{convId}/conversationdetails":{"get":{"description":"Gets the conference details of the given conversation. Conference details include the URL, which is used to join the conference through a web or mobile application, as well as the dial-in phone numbers and conference PIN, which are used to join the conference by phone.\nOauthScopes: READ_CONVERSATIONS","operationId":"getJoinDetails","parameters":[{"description":"The ID of the conversation for which the join details should be returned","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ConversationDetails"}}},"description":"The join details."},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Gets the conference details of a conversation","tags":["Conversations"]}},"/conversations/{convId}/favorite":{"delete":{"description":"Removes a conversation from favorites. Favorites can be displayed in a separate side tab inside of the Circuit client to have a better overview of important conversations.\nOauthScopes: WRITE_CONVERSATIONS","operationId":"deleteFavorite","parameters":[{"description":"The ID of the conversation which will be unmarked as favorite","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"description":"The conversation was successfully unmarked"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li><li>the user is no participant of the conversation</li><li>a field constraint is violated</li><li>the conversation was not marked before</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS"]}],"summary":"Removes a conversation from favorites","tags":["Conversations"]},"post":{"description":"Adds a conversation to the favorites. Favorites can be displayed in a separate side tab inside of the Circuit client to have a better overview of important conversations.\nOauthScopes: WRITE_CONVERSATIONS","operationId":"addFavorite","parameters":[{"description":"The ID of the conversation which will be marked as favorite","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"description":"The conversation was successfully marked"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li><li>the user is no participant of the conversation</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS"]}],"summary":"Adds a conversation to the favorites","tags":["Conversations"]}},"/conversations/{convId}/items":{"get":{"description":"Gets a list of conversation items.\nOauthScopes: READ_CONVERSATIONS","operationId":"getConversationItems","parameters":[{"description":"The ID of the conversation to which the items belong","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}},{"description":"The modification time of the item in UTC format. During the query the items before (default) or after this timestamps are returned. In case no timestamp is specified the current server time in UTC is used, i.e. the last 25 modified items are returned","in":"query","name":"modTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"The direction of the search based on the modification time. Valid values are either BEFORE (default) or AFTER","in":"query","name":"direction","required":false,"schema":{"default":"BEFORE","enum":["BEFORE","AFTER"],"maxLength":2048,"type":"string"}},{"description":"The maximum number of returned results (default 25). The maximum allowed value is 100.","in":"query","name":"results","required":false,"schema":{"default":25,"format":"int32","maximum":100,"minimum":1,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ConversationItem"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/ConversationItem"},"type":"array"}}},"description":"The matching conversation items"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","READ_CONVERSATIONS"]}],"summary":"Gets a list of conversation items","tags":["Conversations"]}},"/conversations/{convId}/label":{"post":{"description":"Adds a label to a conversation, you can search and organize your conversations based on these labels\nOauthScopes: WRITE_CONVERSATIONS, ORGANIZE_CONVERSATIONS","operationId":"assignLabel","parameters":[{"description":"The ID of the conversation to which the label is added","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"label":{"description":"The actual label ","maxLength":2048,"type":"string"}},"required":["label"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"The label was successfully added"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>a field constraint is violated</li><li>you reached the maximum of 250 labels</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","ORGANIZE_CONVERSATIONS"]}],"summary":"Adds a label to a conversation","tags":["Conversations"]}},"/conversations/{convId}/label/{labelId}":{"delete":{"description":"Removes a label from a conversation, you can search and organize your conversations based on these labels\nOauthScopes: WRITE_CONVERSATIONS","operationId":"unassignLabel","parameters":[{"description":"The ID of the conversation from which the label is removed","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}},{"description":"The actual label ","in":"path","name":"labelId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"The label was successfully removed"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>a field constraint is violated</li><li>the label was not assigned to the conversation</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS"]}],"summary":"Removes a label from a conversation","tags":["Conversations"]}},"/conversations/{convId}/messages":{"post":{"description":"Adds a message to the given conversation. This operation can be only performed on behalf of a user who is already a member of the conversation.\nOauthScopes: WRITE_CONVERSATIONS, CREATE_CONVERSATIONS_CONTENT","operationId":"addTextItem","parameters":[{"description":"The ID of the conversation to which the new item has to be added","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"attachments":{"description":"A comma separated list of attachment IDs from the file API.","items":{"maxLength":16000,"type":"string"},"type":"array"},"content":{"description":"The actual content of the item, is mandatory unless an attachment is added","maxLength":16384,"type":"string"},"formMetaData":{"description":"The form meta data of the new text item","maxLength":32768,"type":"string"},"subject":{"description":"The subject (headline) of the new text item","maxLength":255,"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationItem"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ConversationItem"}}},"description":"Gets the new text item object"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li><li>the user is no participant of the conversation</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oauth":["ALL","WRITE_CONVERSATIONS","CREATE_CONVERSATIONS_CONTENT"]}],"summary":"Adds a message to a conversation","tags":["Conversations"]}},"/conversations/{convId}/messages/flag":{"get":{"description":"Gets a list of all the flagged messages in the given conversation.\nOauthScopes: READ_CONVERSATIONS, ORGANIZE_CONVERSATIONS","operationId":"getFlagItem","parameters":[{"description":"The ID of the conversation to which the item belongs","in":"path","name":"convId","required":true,"schema":{"maxLength":2048,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ConversationItem"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/ConversationItem"},"type":"array"}}},"description":"Gets the list of flagged items"},"400":{"description":"The request cannot be fulfilled due to bad syntax: <ul><li>the conversation does not exist</li><li>a field constraint is violated</li></ul>"},"401":{"description":"The authentication was not successful"},"500":{"description":"The server encountered an internal error and the operation could not be completed."},"503":{"description":"The server is currently unable to receive requests."}},"security":[{"oau