actionPOSTv1.0.0
Add a user label
Add a label to the list of user labels OauthScopes: WRITE_USER_PROFILE, ORGANIZE_CONVERSATIONS
actionPOSTv1.0.0
Add moderators
Adds a list of moderators to a conversation OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS
actionPOSTv1.0.0
Add Participant to Space
Add a participant to a space OauthScopes: WRITE_SPACE, MANAGE_SPACE
actionPOSTv1.0.0
Adds a "like" to a message
Adds a "like" to the given message in the given conversation OauthScopes: WRITE_CONVERSATIONS, UPDATE_CONVERSATION_CONTENT
actionPOSTv1.0.0
Adds a conversation to the favorites
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
actionPOSTv1.0.0
Adds a flag to a message in a conversation
Adds a flag to the given message in the given conversation. OauthScopes: WRITE_CONVERSATIONS, ORGANIZE_CONVERSATIONS
actionPOSTv1.0.0
Adds a label to a conversation
Adds a label to a conversation, you can search and organize your conversations based on these labels OauthScopes: WRITE_CONVERSATIONS, ORGANIZE_CONVERSATIONS
actionPOSTv1.0.0
Adds a message to a conversation
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
actionPOSTv1.0.0
Adds a message to an item
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
actionPOSTv1.0.0
Adds participants to a community
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
actionPOSTv1.0.0
Adds participants to a group conversation
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
actionPOSTv1.0.0
Adds the authenticated user to a community
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
actionPOSTv1.0.0
Archives conversation
Archives a conversation by muting it OauthScopes: WRITE_CONVERSATIONS
actionPOSTv1.0.0
Assign labels
Assign labels to space OauthScopes: WRITE_SPACE, ORGANIZE_SPACE
actionGETv1.0.0
Checks for a 1-to-1 conversation
Checks if a 1-to-1 conversation between the authenticated user and the user with the provided userId exists. OauthScopes: READ_CONVERSATIONS
actionPOSTv1.0.0
Create a space
Create a space OauthScopes: WRITE_SPACE, MANAGE_SPACE, CREATE_SPACE_CONTENT
actionPOSTv1.0.0
Creates a 1-to-1 conversation
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
actionPOSTv1.0.0
Creates a community conversation
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
actionPOSTv1.0.0
Creates a group conversation
Creates a group conversation between three or more users. The authenticated user is directly added to this conversation. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS
actionPOSTv1.0.0
creates a new space topic
creates a new space topic OauthScopes: WRITE_SPACE, MANAGE_SPACE, CREATE_SPACE_CONTENT
actionPOSTv1.0.0
creates a reply to a topic
creates a reply to a topic OauthScopes: WRITE_SPACE
actionDELETEv1.0.0
Delete a space
Delete a space OauthScopes: WRITE_SPACE, MANAGE_SPACE, DELETE_SPACE_CONTENT
actionDELETEv1.0.0
Deletes a message from a conversation
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
actionDELETEv1.0.0
deletes a space item
deletes a space item OauthScopes: WRITE_SPACE, DELETE_SPACE_CONTENT
actionPOSTv1.0.0
Deny access for a space
Deny access for a space OauthScopes: WRITE_SPACE, MANAGE_SPACE
actionGETv1.0.0
Finds participants to add to add to a space
Finds participants to add to a space OauthScopes: WRITE_SPACE, MANAGE_SPACE, ORGANIZE_SPACE
actionGETv1.0.0
Get devices infos
Get the device infos of the requesting user OauthScopes: READ_USER_PROFILE
actionGETv1.0.0
Get flagged items
Get flagged items OauthScopes: READ_SPACE
actionGETv1.0.0
Get journal
Get telephony journal OauthScopes: READ_CONVERSATIONS
actionGETv1.0.0
Get telephony conversation id
Get telephony conversation id for requesting client OauthScopes: READ_CONVERSATIONS
actionGETv1.0.0
Get the directory
Get the directory by a search query in ordered way OauthScopes: READ_SPACE
actionGETv1.0.0
Get the likes of an item
Get the likes of an item OauthScopes: READ_SPACE
actionGETv1.0.0
Get the participants of a space
Get the participants of a space OauthScopes: READ_SPACE
actionGETv1.0.0
Get the participants of a space
Get the participants of a space OauthScopes: READ_SPACE
actionGETv1.0.0
Get the pending participants of a space
Get the pending participants of a space OauthScopes: WRITE_SPACE, MANAGE_SPACE
actionGETv1.0.0
Get the spaces
Get the spaces OauthScopes: READ_SPACE
actionGETv1.0.0
Get the spaces by their ids
Get the spaces by their ids OauthScopes: READ_SPACE
actionGETv1.0.0
Get user by email
Get user by first or secondary email address OauthScopes: READ_USER_PROFILE
actionGETv1.0.0
Gets a conversation
Gets a conversation based on the given ID. OauthScopes: READ_CONVERSATIONS
actionGETv1.0.0
Gets a list of active sessions
Gets a list of active RTCsessions OauthScopes: CALLS
actionGETv1.0.0
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
actionGETv1.0.0
Gets a list of conversation items
Gets a list of conversation items. OauthScopes: READ_CONVERSATIONS
actionGETv1.0.0
Gets a list of conversations
Gets a list of conversations and communities the authenticated user participates in. OauthScopes: READ_CONVERSATIONS
actionGETv1.0.0
Gets a list of the flagged messages
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
actionGETv1.0.0
Gets a list of the flagged messages of a conversation
Gets a list of all the flagged messages in the given conversation. OauthScopes: READ_CONVERSATIONS, ORGANIZE_CONVERSATIONS
actionGETv1.0.0
Gets conversations
Gets conversation based on the given IDs. OauthScopes: READ_CONVERSATIONS
actionGETv1.0.0
Gets favorite conversations
Gets the conversationIds which are marked as favorites. OauthScopes: READ_CONVERSATIONS
actionGETv1.0.0
Gets space replies
Gets a number of Space replies OauthScopes: READ_SPACE
actionGETv1.0.0
Gets space replies and a topic
Gets a number of Space replies with a matching topic OauthScopes: READ_SPACE
actionGETv1.0.0
Gets space topics
Gets a number of Space topics OauthScopes: READ_SPACE
actionGETv1.0.0
Gets the authenticated user's profile information
Gets the authenticated user's profile information. OauthScopes: READ_USER_PROFILE
actionGETv1.0.0
Gets the conference details for multiple conversations
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
actionGETv1.0.0
Gets the conference details of a conversation
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
actionGETv1.0.0
Gets the presence status
Gets the presence status of the users whose IDs or email addresses are given. OauthScopes: READ_USER
actionGETv1.0.0
Gets the presence status
Gets the presence status of the users whose ID or email address is given. OauthScopes: READ_USER
actionGETv1.0.0
Gets the support information
Gets the support information for the tenant of the requesting user OauthScopes: READ_USER_PROFILE
actionGETv1.0.0
Gets the user's profile information
Gets the profile information of the user with the given ID. OauthScopes: READ_USER
actionPOSTv1.0.0
grant access for a space
grant access for a space OauthScopes: WRITE_SPACE, MANAGE_SPACE
actionPOSTv1.0.0
Join a space
Join a space OauthScopes: WRITE_SPACE
actionPOSTv1.0.0
Leave a space
Leave a space OauthScopes: WRITE_SPACE
actionGETv1.0.0
Performs a conversation search
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
actionGETv1.0.0
Performs a list of participants
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
actionPOSTv1.0.0
Pins a topic of a conversation
Pins a topic of a conversation OauthScopes: READ_CONVERSATIONS
actionDELETEv1.0.0
Remove a user label
Remove a label from the list of user labels OauthScopes: WRITE_USER_PROFILE, ORGANIZE_CONVERSATIONS
actionDELETEv1.0.0
Remove moderators
Removes a list of moderators from a conversation OauthScopes: WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS
actionDELETEv1.0.0
Removes a "like" from a message
Removes a "like" from the given message in the given conversation OauthScopes: WRITE_CONVERSATIONS, UPDATE_CONVERSATION_CONTENT
actionDELETEv1.0.0
Removes a conversation from favorites
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
actionDELETEv1.0.0
Removes a label from a conversation
Removes a label from a conversation, you can search and organize your conversations based on these labels OauthScopes: WRITE_CONVERSATIONS
actionDELETEv1.0.0
Removes participants from a community
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
actionDELETEv1.0.0
Removes participants from a group conversation
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
actionDELETEv1.0.0
Removes the flag from a message
Removes the flag from a given message that is posted to the given conversation. OauthScopes: WRITE_CONVERSATIONS, ORGANIZE_CONVERSATIONS
actionPOSTv1.0.0
request access for a space
request access for a space OauthScopes: READ_SPACE
actionGETv1.0.0
Retrieve pinned topics
Retrieve pinned topics of a space OauthScopes: READ_SPACE
actionGETv1.0.0
Retrieve recent space searches
Retrieve recent space searches for a user. OauthScopes: READ_SPACE
actionGETv1.0.0
Returns a text item
Returns a text item for a given item id OauthScopes: READ_CONVERSATIONS
actionGETv1.0.0
Returns all user labels
Returns all labels of the user that were defined either explicit or implicit via assignment to conversations. OauthScopes: READ_USER_PROFILE, ORGANIZE_CONVERSATIONS
actionGETv1.0.0
Returns conversations with a certain label
Returns conversations with matching labels and paginated OauthScopes: READ_CONVERSATIONS
actionGETv1.0.0
Returns pinned topics of a conversation
Returns pinned topics of a conversation OauthScopes: READ_CONVERSATIONS
actionGETv1.0.0
Search for users
Search for users based on an email address or username OauthScopes: READ_USER
actionGETv1.0.0
Search multiple users.
Search multiple users given by id or email address. OauthScopes: READ_USER
actionPOSTv1.0.0
Set conversation moderated
Set a conversation in moderatd mode. Moderators can be added and removed OauthScopes: WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS
actionPOSTv1.0.0
Set conversation unmoderated
Set a conversation to unmoderatd mode OauthScopes: WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS
actionGETv1.0.0
Space name exists
Find out if a space name already exists for non-secret spaces. OauthScopes: READ_SPACE
actionGETv1.0.0
starts a basic search in spaces
starts a basic search in spaces OauthScopes: READ_SPACE
actionGETv1.0.0
starts a detailed search in a space
starts a detailed search in a space OauthScopes: READ_SPACE
actionDELETEv1.0.0
Unassign labels
Unassign labels from a space OauthScopes: WRITE_SPACE, ORGANIZE_SPACE
actionDELETEv1.0.0
Unmute conversation
The conversation will no longer be archived but active again OauthScopes: WRITE_CONVERSATIONS
actionDELETEv1.0.0
Unpins a topic of a conversation
Unpins a topic of a conversation OauthScopes: READ_CONVERSATIONS
actionPUTv1.0.0
Update a space
Update a space OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT
actionPUTv1.0.0
Update content of welcome box
Update content of the welcome box of a space OauthScopes: MANAGE_SPACE, WRITE_SPACE
actionPUTv1.0.0
Update participant
Update participant in space OauthScopes: WRITE_SPACE, MANAGE_SPACE, ORGANIZE_SPACE
actionPUTv1.0.0
Update read timestamp
Update read timestamp OauthScopes: READ_SPACE, WRITE_SPACE
actionPUTv1.0.0
Update tags
Update the tags of a topic OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT
actionPUTv1.0.0
Updates a message
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
actionPUTv1.0.0
Updates a space reply
Updates a space reply OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT
actionPUTv1.0.0
Updates a topic
Updates a topic OauthScopes: WRITE_SPACE, UPDATE_SPACE_CONTENT
actionPUTv1.0.0
Updates the information of a community
Updates the information of the given community. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS
actionPUTv1.0.0
Updates the information of a group conversation
Updates the information of the given group conversation. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS
actionPUTv1.0.0
Updates the presence status
Updates the presence status of the authenticated user. OauthScopes: WRITE_USER_PROFILE, MANAGE_PRESENCE
actionPUTv1.0.0
Updates the user profile
Updates the user profile of the authenticated user OauthScopes: WRITE_USER_PROFILE
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec