integrations.sh
← all integrations

REST API Version 2

OpenAPI apis-guru messaging

Circuit REST API to interact with the Circuit system.

Homepage
https://api.apis.guru/v2/specs/circuitsandbox.net/2.9.235.json
Provider
circuitsandbox.net
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/circuitsandbox.net/2.9.235/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/circuitsandbox.net/2.9.235/openapi.yaml

Tools (125)

Extracted live via the executor SDK.

  • conversations.addFavorite

    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. OauthScopes: WRITE_CONVERSATIONS

  • conversations.addLabel

    Add a label to the list of user labels OauthScopes: WRITE_USER_PROFILE, ORGANIZE_CONVERSATIONS

  • conversations.addModerators

    Adds a list of moderators to a conversation OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.addParticipantCommunity

    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. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.addParticipantGroup

    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. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.addTextItem

    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. OauthScopes: WRITE_CONVERSATIONS, CREATE_CONVERSATIONS_CONTENT

  • conversations.addTextItemWithParent

    Adds a message to the existing item. The added message will be a child item of the message with the given itemId. OauthScopes: WRITE_CONVERSATIONS

  • conversations.archiveConversation

    Archives a conversation by muting it OauthScopes: WRITE_CONVERSATIONS

  • conversations.assignLabel

    Adds a label to a conversation, you can search and organize your conversations based on these labels OauthScopes: WRITE_CONVERSATIONS, ORGANIZE_CONVERSATIONS

  • conversations.createCommunityConversation

    Creates a community. Communities are open conversations that anyone in a Circuit domain (tenant) can join without having to be added by another user. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.createDirectConversation

    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. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.createGroupConversation

    Creates a group conversation between three or more users. The authenticated user is directly added to this conversation. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.deleteFavorite

    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. OauthScopes: WRITE_CONVERSATIONS

  • conversations.deleteTextItem

    Marks a message in the given conversation as deleted. Deleted messages are still part of the conversation, but their content is no more visible. This operation can only be performed on behalf of the message's creator. OauthScopes: WRITE_CONVERSATIONS, DELETE_CONVERSATIONS_CONTENT

  • conversations.flagItem

    Adds a flag to the given message in the given conversation. OauthScopes: WRITE_CONVERSATIONS, ORGANIZE_CONVERSATIONS

  • conversations.getCommunityConversations

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

  • conversations.getConversationbyId

    Gets a conversation based on the given ID. OauthScopes: READ_CONVERSATIONS

  • conversations.getConversationItems

    Gets a list of conversation items. OauthScopes: READ_CONVERSATIONS

  • conversations.getConversations

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

  • conversations.getConversationsById

    Gets conversation based on the given IDs. OauthScopes: READ_CONVERSATIONS

  • conversations.getConversationsByLabel

    Returns conversations with matching labels and paginated OauthScopes: READ_CONVERSATIONS

  • conversations.getDirectConversation

    Checks if a 1-to-1 conversation between the authenticated user and the user with the provided userId exists. OauthScopes: READ_CONVERSATIONS

  • conversations.getFavoriteConversations

    Gets the conversationIds which are marked as favorites. OauthScopes: READ_CONVERSATIONS

  • conversations.getFlagItem

    Gets a list of all the flagged messages in the given conversation. OauthScopes: READ_CONVERSATIONS, ORGANIZE_CONVERSATIONS

  • conversations.getFlagItemConv

    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. OauthScopes: READ_CONVERSATIONS

  • conversations.getJoinDetails

    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. OauthScopes: READ_CONVERSATIONS

  • conversations.getJoinDetailsMultiple

    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. OauthScopes: READ_CONVERSATIONS

  • conversations.getParticipantsByConvId

    Performs a search for participants. The max number of participants is configurable. If more participants are available a search pointer is returned for consecutive calls. OauthScopes: READ_CONVERSATIONS

  • conversations.getPinnedConversations

    Returns pinned topics of a conversation OauthScopes: READ_CONVERSATIONS

  • conversations.getSingleConversationtem

    Returns a text item for a given item id OauthScopes: READ_CONVERSATIONS

  • conversations.joinCommunityConversation

    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. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.likeItem

    Adds a "like" to the given message in the given conversation OauthScopes: WRITE_CONVERSATIONS, UPDATE_CONVERSATION_CONTENT

  • conversations.moderateConversation

    Set a conversation in moderatd mode. Moderators can be added and removed OauthScopes: WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS

  • conversations.pinAConversation

    Pins a topic of a conversation OauthScopes: READ_CONVERSATIONS

  • conversations.removeLabel

    Remove a label from the list of user labels OauthScopes: WRITE_USER_PROFILE, ORGANIZE_CONVERSATIONS

  • conversations.removeModerators

    Removes a list of moderators from a conversation OauthScopes: WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS

  • conversations.removeParticipantCommunity

    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. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.removeParticipantGroup

    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. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.resolveInvitationToken

    Resolves an invite token to a conversation OauthScopes: READ_CONVERSATIONS

  • conversations.searchConversations

    Performs a search for conversation content. A maximum of 100 conversations is returned. If you hit this limit you should refine the search term. OauthScopes: READ_CONVERSATIONS

  • conversations.unassignLabel

    Removes a label from a conversation, you can search and organize your conversations based on these labels OauthScopes: WRITE_CONVERSATIONS

  • conversations.undoArchiveConversation

    The conversation will no longer be archived but active again OauthScopes: WRITE_CONVERSATIONS

  • conversations.unFlagItem

    Removes the flag from a given message that is posted to the given conversation. OauthScopes: WRITE_CONVERSATIONS, ORGANIZE_CONVERSATIONS

  • conversations.unlikeItem

    Removes a "like" from the given message in the given conversation OauthScopes: WRITE_CONVERSATIONS, UPDATE_CONVERSATION_CONTENT

  • conversations.unmoderateConversation

    Set a conversation to unmoderatd mode OauthScopes: WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS

  • conversations.unPinAConversation

    Unpins a topic of a conversation OauthScopes: READ_CONVERSATIONS

  • conversations.updateConversationCommunity

    Updates the information of the given community. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.updateConversationGroup

    Updates the information of the given group conversation. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • conversations.updateProfile

    Updates the user profile of the authenticated user OauthScopes: WRITE_USER_PROFILE

  • conversations.updateTextItem

    Updates the content or subject of the existing message. Only the creator of the message is allowed to perform this operation. OauthScopes: WRITE_CONVERSATIONS, UPDATE_CONVERSATION_CONTENT

  • incomingWebhooks.createIncomingWebhook

    Create a new webhook. Conversation must exist and creater has to be participant. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • incomingWebhooks.deleteIncomingWebhook

    Delete a new webhook. Webhook must exist OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

  • incomingWebhooks.getIncomingWebhookByUser

    Get all webhooks of a special user. OauthScopes: READ_CONVERSATIONS, MANAGE_CONVERSATIONS

  • incomingWebhooks.postWebhookAsSlackMessage

    Post text items to conversations via slack apps.

  • outgoingWebhooks.addPresenceWebHook

    Registers a webHook that has a presence filter with the given URL and userIds. There is a maximum number of userIds allowed OauthScopes: READ_USER

  • outgoingWebhooks.addWebHook

    Registers the webHook with the given filter and callback URL. OauthScopes: READ_CONVERSATIONS, READ_USER

  • outgoingWebhooks.getWebHook

    Gets the list of webHooks registered for this user or API. OauthScopes: READ_CONVERSATIONS, READ_USER

  • outgoingWebhooks.getWebHookById

    Gets the registered webHook with the given ID. OauthScopes: READ_CONVERSATIONS, READ_USER

  • outgoingWebhooks.removeWebHook

    Unregisters the webHook with the given ID. OauthScopes: READ_CONVERSATIONS, READ_USER

  • outgoingWebhooks.removeWebHooks

    Unregisters all webHooks of the authenticated user OauthScopes: READ_CONVERSATIONS, READ_USER

  • outgoingWebhooks.updatePresenceWebHook

    Updates a registration of a webHook that has a presence filter. The update can be performed either on the URL and/or the userIds. The new userIds, if any, will override any existing userIds. OauthScopes: READ_USER

  • outgoingWebhooks.updateWebHook

    Updates a webHook registration with the given filter and callback URL. OauthScopes: READ_CONVERSATIONS, READ_USER

  • rtc.getActiveSessions

    Gets a list of active RTCsessions OauthScopes: CALLS

  • spaces.addParticipantsToSpace

    Add a participant to a space OauthScopes: WRITE_SPACE, MANAGE_SPACE

  • spaces.addRecentSpaceSearch

    Add recent search of a client to search controller. OauthScopes: WRITE_SPACE, MANAGE_SPACE, ORGANIZE_SPACE

  • spaces.assignLabels

    Assign labels to space OauthScopes: WRITE_SPACE, ORGANIZE_SPACE

  • spaces.cancelSpaceSearch

    Cancels a space search of a client. OauthScopes: WRITE_SPACE, MANAGE_SPACE

  • spaces.createReply

    creates a reply to a topic OauthScopes: WRITE_SPACE

  • spaces.createSpace

    Create a space OauthScopes: WRITE_SPACE, MANAGE_SPACE, CREATE_SPACE_CONTENT

  • spaces.createSpaceTopic

    creates a new space topic OauthScopes: WRITE_SPACE, MANAGE_SPACE, CREATE_SPACE_CONTENT

  • spaces.deleteSpace

    Delete a space OauthScopes: WRITE_SPACE, MANAGE_SPACE, DELETE_SPACE_CONTENT

  • spaces.deleteSpaceItem

    deletes a space item OauthScopes: WRITE_SPACE, DELETE_SPACE_CONTENT

  • spaces.denySpaceAcces

    Deny access for a space OauthScopes: WRITE_SPACE, MANAGE_SPACE

  • spaces.existsSpaceName

    Find out if a space name already exists for non-secret spaces. OauthScopes: READ_SPACE

  • spaces.flagSpaceItem

    flag a space item OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT

  • spaces.getDirectory

    Get the directory by a search query in ordered way OauthScopes: READ_SPACE

  • spaces.getFlaggedItems

    Get flagged items OauthScopes: READ_SPACE

  • spaces.getLikes

    Get the likes of an item OauthScopes: READ_SPACE

  • spaces.getParticipantsImportData

    missing documentation OauthScopes: READ_SPACE

  • spaces.getPendingParticipants

    Get the pending participants of a space OauthScopes: WRITE_SPACE, MANAGE_SPACE

  • spaces.getPinnedTopics

    Retrieve pinned topics of a space OauthScopes: READ_SPACE

  • spaces.getRecentSearches

    Retrieve recent space searches for a user. OauthScopes: READ_SPACE

  • spaces.getSpaceParticipants

    Get the participants of a space OauthScopes: READ_SPACE

  • spaces.getSpaceReplies

    Gets a number of Space replies OauthScopes: READ_SPACE

  • spaces.getSpaces

    Get the spaces OauthScopes: READ_SPACE

  • spaces.getSpacesByIds

    Get the spaces by their ids OauthScopes: READ_SPACE

  • spaces.getSpaceTopics

    Gets a number of Space topics OauthScopes: READ_SPACE

  • spaces.grantSpaceAcces

    grant access for a space OauthScopes: WRITE_SPACE, MANAGE_SPACE

  • spaces.joinSpace

    Join a space OauthScopes: WRITE_SPACE

  • spaces.leaveSpace

    Leave a space OauthScopes: WRITE_SPACE

  • spaces.likeSpaceItem

    Like a space item OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT

  • spaces.pinTopic

    Pin a topic OauthScopes: WRITE_SPACE, MANAGE_SPACE

  • spaces.requestSpaceAcces

    request access for a space OauthScopes: READ_SPACE

  • spaces.searchParticipantsToAdd

    Finds participants to add to a space OauthScopes: WRITE_SPACE, MANAGE_SPACE, ORGANIZE_SPACE

  • spaces.searchSpaceParticipants

    Get the participants of a space OauthScopes: READ_SPACE

  • spaces.startBasicSpacesSearch

    starts a basic search in spaces OauthScopes: READ_SPACE

  • spaces.startDetailedSpaceSearch

    starts a detailed search in a space OauthScopes: READ_SPACE

  • spaces.unassignLabels

    Unassign labels from a space OauthScopes: WRITE_SPACE, ORGANIZE_SPACE

  • spaces.unflagSpaceItem

    Unflag a space item OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT

  • spaces.unlikeSpaceItem

    Unlike a space item OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT

  • spaces.unpinTopic

    Unpin a topic OauthScopes: WRITE_SPACE, MANAGE_SPACE

  • spaces.updateParticipantInSpace

    Update participant in space OauthScopes: WRITE_SPACE, MANAGE_SPACE, ORGANIZE_SPACE

  • spaces.updateReadTimestamp

    Update read timestamp OauthScopes: READ_SPACE, WRITE_SPACE

  • spaces.updateSpace

    Update a space OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT

  • spaces.updateSpaceReply

    Updates a space reply OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT

  • spaces.updateSpaceTopic

    Updates a topic OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT

  • spaces.updateTopicTags

    Update the tags of a topic
    OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT

  • spaces.v2GetTopicWithReplies

    Gets a number of Space replies with a matching topic OauthScopes: READ_SPACE

  • spaces.v2RemoveParticipantsFromSpace

    removes Participants from a space OauthScopes: WRITE_SPACE, MANAGE_SPACE, ORGANIZE_SPACE

  • spaces.v2UpdateWelcomeBoxContent

    Update content of the welcome box of a space OauthScopes: MANAGE_SPACE, WRITE_SPACE

  • telephony.getJournalEntries

    Get telephony journal OauthScopes: READ_CONVERSATIONS

  • telephony.v2GetDeviceInfos

    Get the device infos of the requesting user OauthScopes: READ_USER_PROFILE

  • telephony.v2GetTelephonyConversationId

    Get telephony conversation id for requesting client OauthScopes: READ_CONVERSATIONS

  • users.getLabel

    Returns all labels of the user that were defined either explicit or implicit via assignment to conversations. OauthScopes: READ_USER_PROFILE, ORGANIZE_CONVERSATIONS

  • users.getPresence

    Gets the presence status of the users whose IDs or email addresses are given. OauthScopes: READ_USER

  • users.getProfile

    Gets the authenticated user's profile information. OauthScopes: READ_USER_PROFILE

  • users.getSupportInfo

    Gets the support information for the tenant of the requesting user OauthScopes: READ_USER_PROFILE

  • users.getUserByEmailAddress

    Get user by first or secondary email address OauthScopes: READ_USER_PROFILE

  • users.getUserById

    Gets the profile information of the user with the given ID. OauthScopes: READ_USER

  • users.getUserPresence

    Gets the presence status of the users whose ID or email address is given. OauthScopes: READ_USER

  • users.searchUser

    Search for users based on an email address or username OauthScopes: READ_USER

  • users.searchUsersList

    Search multiple users given by id or email address. OauthScopes: READ_USER

  • users.setUserPresence

    Updates the presence status of the authenticated user. OauthScopes: WRITE_USER_PROFILE, MANAGE_PRESENCE

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools