Circuit REST API to interact with the Circuit system. [Learn more about the Circuit Development Community](https://www.circuit.com/web/developers/home)
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://circuitsandbox.net/rest/v2
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Circuit REST API to interact with the Circuit system. [Learn more about the Circuit Development Community](https://www.circuit.com/web/developers/home)
| method | path | what the vendor says it does |
|---|---|---|
GET | /conversations | Gets a list of conversations Gets a list of conversations and communities the authenticated user participates |
GET | /conversations/byIds | Gets conversations Gets conversation based on the given IDs. OauthScopes: READ_CONVERSATIONS Conversations |
GET | /conversations/community | Gets a list of communities Gets a list of communities. This endpoint can be used to explore the communities th |
POST | /conversations/community | Creates a community conversation Creates a community. Communities are open conversations that anyone in a Circ |
PUT | /conversations/community/{convId} | Updates the information of a community Updates the information of the given community. OauthScopes: WRITE_CONV |
POST | /conversations/community/{convId}/join | Adds the authenticated user to a community Adds the authenticated user to the given community (i.e., allows th |
POST | /conversations/community/{convId}/participants | Adds participants to a community Adds one or more participants to the given community. This operation can only |
DELETE | /conversations/community/{convId}/participants | Removes participants from a community Removes one or more participants from the given community. The last part |
GET | /conversations/conversationdetails | Gets the conference details for multiple conversations Gets the conference details of the given conversations. |
GET | /conversations/direct | Checks for a 1-to-1 conversation Checks if a 1-to-1 conversation between the authenticated user and the user w |
POST | /conversations/direct | Creates a 1-to-1 conversation Creates a 1-to-1 conversation between the authenticated user and the user with t |
GET | /conversations/favorite | Gets favorite conversations Gets the conversationIds which are marked as favorites. OauthScopes: READ_CONVERSA |
POST | /conversations/group | Creates a group conversation Creates a group conversation between three or more users. The authenticated user |
PUT | /conversations/group/{convId} | Updates the information of a group conversation Updates the information of the given group conversation. Oauth |
POST | /conversations/group/{convId}/participants | Adds participants to a group conversation Adds one or more participants to the given group conversation. This |
DELETE | /conversations/group/{convId}/participants | Removes participants from a group conversation Removes one or more participants from the given group conversat |
GET | /conversations/label/{labelId} | Returns conversations with a certain label Returns conversations with matching labels and paginated OauthScop |
GET | /conversations/messages/flag | Gets a list of the flagged messages Gets a list of all the messages the authenticated user has flagged. This e |
GET | /conversations/messages/{itemId} | Returns a text item Returns a text item for a given item id OauthScopes: READ_CONVERSATIONS Conversations |
POST | /conversations/moderate/{convId} | Set conversation moderated Set a conversation in moderatd mode. Moderators can be added and removed OauthScope |
GET | /conversations/resolveinvitetoken | Resolves an invite token to a conversation Resolves an invite token to a conversation OauthScopes: READ_CONVER |
GET | /conversations/search | Performs a conversation search Performs a search for conversation content. A maximum of 100 conversations is r |
POST | /conversations/unmoderate/{convId} | Set conversation unmoderated Set a conversation to unmoderatd mode OauthScopes: WRITE_CONVERSATIONS, MODERATE_ |
GET | /conversations/{convId} | Gets a conversation Gets a conversation based on the given ID. OauthScopes: READ_CONVERSATIONS Conversations |
POST | /conversations/{convId}/archive | Archives conversation Archives a conversation by muting it OauthScopes: WRITE_CONVERSATIONS Conversations |
DELETE | /conversations/{convId}/archive | Unmute conversation The conversation will no longer be archived but active again OauthScopes: WRITE_CONVERSATI |
GET | /conversations/{convId}/conversationdetails | Gets the conference details of a conversation Gets the conference details of the given conversation. Conferenc |
POST | /conversations/{convId}/favorite | Adds a conversation to the favorites Adds a conversation to the favorites. Favorites can be displayed in a sep |
DELETE | /conversations/{convId}/favorite | Removes a conversation from favorites Removes a conversation from favorites. Favorites can be displayed in a s |
GET | /conversations/{convId}/items | Gets a list of conversation items Gets a list of conversation items. OauthScopes: READ_CONVERSATIONS Conversat |
POST | /conversations/{convId}/label | Adds a label to a conversation Adds a label to a conversation, you can search and organize your conversations |
DELETE | /conversations/{convId}/label/{labelId} | Removes a label from a conversation Removes a label from a conversation, you can search and organize your conv |
POST | /conversations/{convId}/messages | Adds a message to a conversation Adds a message to the given conversation. This operation can be only performe |
GET | /conversations/{convId}/messages/flag | Gets a list of the flagged messages of a conversation Gets a list of all the flagged messages in the given con |
POST | /conversations/{convId}/messages/{itemId} | Adds a message to an item Adds a message to the existing item. The added message will be a child item of the m |
PUT | /conversations/{convId}/messages/{itemId} | Updates a message Updates the content or subject of the existing message. Only the creator of the message is a |
DELETE | /conversations/{convId}/messages/{itemId} | Deletes a message from a conversation Marks a message in the given conversation as deleted. Deleted messages a |
POST | /conversations/{convId}/messages/{itemId}/flag | Adds a flag to a message in a conversation Adds a flag to the given message in the given conversation. OauthSc |
DELETE | /conversations/{convId}/messages/{itemId}/flag | Removes the flag from a message Removes the flag from a given message that is posted to the given conversation |
POST | /conversations/{convId}/messages/{itemId}/like | Adds a "like" to a message Adds a "like" to the given message in the given conversation OauthScopes: WRITE_CON |
and 83 more operation(s) in this specification, all searchable.
specification origin: https://circuitsandbox.net/rest/v2/swagger
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.