Circuit REST API to interact with the Circuit system. [Learn more about the Circuit Development Community](https://www.circuit.com/web/developers/home)
https://circuitsandbox.net/rest/v2123 endpoints available
/usersSearch for users
/spacesGet the spaces
/webhooksGets a list of webHooks
/webhooksRegisters a WebHook
/webhooksRemoves all webHooks
/spaces/idsGet the spaces by their ids
/users/listSearch multiple users.
/users/{id}Gets the user's profile information
/spaces/{id}Update a space
/spaces/{id}Delete a space
/rtc/sessionsGets a list of active sessions
/users/labelsReturns all user labels
/users/labelsAdd a user label
/conversationsGets a list of conversations
/spaces/createCreate a space
/users/profileGets the authenticated user's profile information
/users/profileUpdates the user profile
/webhooks/{id}Gets a webHook
/webhooks/{id}Updates a WebHook registration
/webhooks/{id}Removes a registered webHook
/spaces/flaggedGet flagged items
/users/presenceGets the presence status
/users/presenceUpdates the presence status
/spaces/directoryGet the directory
/spaces/{id}/joinJoin a space
/spaces/{id}/leaveLeave a space
/users/supportinfoGets the support information
/webhooks/presenceRegisters Presence WebHook registration
/conversations/byIdsGets conversations
/conversations/groupCreates a group conversation
/users/{id}/presenceGets the presence status
/conversations/directChecks for a 1-to-1 conversation
/conversations/directCreates a 1-to-1 conversation
/conversations/searchPerforms a conversation search
/spaces/exists/{name}Space name exists
/spaces/flag/{itemId}flag a space item
/spaces/item/{itemId}deletes a space item
/spaces/like/{itemId}Like a space item
/spaces/search/recentRetrieve recent space searches
/spaces/{topicId}/pinPin a topic
/spaces/likes/{itemId}Get the likes of an item
/telephony/deviceInfosGet devices infos
/conversations/favoriteGets favorite conversations
/conversations/{convId}Gets a conversation
/spaces/unflag/{itemId}Unflag a space item
/spaces/unlike/{itemId}Unlike a space item
/spaces/{spaceId}/topiccreates a new space topic
/spaces/{topicId}/unpinUnpin a topic
/users/labels/{labelId}Remove a user label
/webhooks/presence/{id}Updates a Presence WebHook registration
/conversations/communityGets a list of communities
/conversations/communityCreates a community conversation
/spaces/{id}/participantAdd Participant to Space
/spaces/{spaceId}/topicsGets space topics
/spaces/search/add/recentAdd recent search
/spaces/search/startBasicstarts a basic search in spaces
/spaces/{id}/participantsGet the participants of a space
/spaces/{id}/pinnedTopicsRetrieve pinned topics
/spaces/{id}/labels/assignAssign labels
/conversations/messages/flagGets a list of the flagged messages
/conversations/{convId}/pinsReturns pinned topics of a conversation
/spaces/search/startDetailedstarts a detailed search in a space
/spaces/{id}/labels/unassignUnassign labels
/spaces/{id}/updateTimestampUpdate read timestamp
/conversations/group/{convId}Updates the information of a group conversation
/conversations/{convId}/itemsGets a list of conversation items
/conversations/{convId}/labelAdds a label to a conversation
/spaces/{spaceId}/participantUpdate participant
/conversations/label/{labelId}Returns conversations with a certain label
/webhooks/incoming/{webhookId}Post text item for conversation via webhook.
/webhooks/incoming/{webhookId}Delete an existing webhook
/conversations/{convId}/archiveArchives conversation
/conversations/{convId}/archiveUnmute conversation
/spaces/{id}/participant/removeRemoves participants from a space
/conversations/messages/{itemId}Returns a text item
/conversations/moderate/{convId}Set conversation moderated
/conversations/{convId}/favoriteAdds a conversation to the favorites
/conversations/{convId}/favoriteRemoves a conversation from favorites
/conversations/{convId}/messagesAdds a message to a conversation
/spaces/search/cancel/{searchId}Cancels a space search of a client.
/webhooks/incoming/user/{userId}Get all webhooks of a special user.
/conversations/community/{convId}Updates the information of a community
/conversations/resolveinvitetokenResolves an invite token to a conversation
/spaces/{id}/participants/pendingGet the pending participants of a space
/spaces/{spaceId}/topic/{topicId}Gets space replies and a topic
/spaces/{spaceId}/topic/{topicId}Updates a topic
/conversations/conversationdetailsGets the conference details for multiple conversations
/conversations/unmoderate/{convId}Set conversation unmoderated
/conversations/{convId}/moderatorsAdd moderators
/conversations/{convId}/moderatorsRemove moderators
/spaces/topic/{topicId}/updateTagsUpdate tags
/telephony/telephonyConversationIdGet telephony conversation id
/conversations/{convId}/participantsPerforms a list of participants
/spaces/{id}/searchParticipantsToAddFinds participants to add to add to a space
/spaces/{id}/searchSpaceParticipantsGet the participants of a space
/users/{emailAddress}/getUserByEmailGet user by email
/conversations/{convId}/messages/flagGets a list of the flagged messages of a conversation
/conversations/{convId}/pins/{itemId}Pins a topic of a conversation
/conversations/{convId}/pins/{itemId}Unpins a topic of a conversation
/spaces/{spaceId}/participant/import/missing documentation
/spaces/{spaceId}/participant/requestrequest access for a space
/conversations/community/{convId}/joinAdds the authenticated user to a community
/spaces/{spaceId}/welcomebox/{content}Update content of welcome box
/conversations/{convId}/label/{labelId}Removes a label from a conversation
/spaces/{spaceId}/topic/{topicId}/replyGets space replies
/spaces/{spaceId}/topic/{topicId}/replycreates a reply to a topic
/conversations/{convId}/messages/{itemId}Updates a message
/conversations/{convId}/messages/{itemId}Adds a message to an item
/conversations/{convId}/messages/{itemId}Deletes a message from a conversation
/conversations/group/{convId}/participantsAdds participants to a group conversation
/conversations/group/{convId}/participantsRemoves participants from a group conversation
/webhooks/incoming/create/{conversationId}Create a new webhook for existing conversation.
/conversations/{convId}/conversationdetailsGets the conference details of a conversation
/telephony/{telephonyConversationId}/journalGet journal
/conversations/community/{convId}/participantsAdds participants to a community
/conversations/community/{convId}/participantsRemoves participants from a community
/conversations/{convId}/messages/{itemId}/flagAdds a flag to a message in a conversation
/conversations/{convId}/messages/{itemId}/flagRemoves the flag from a message
/conversations/{convId}/messages/{itemId}/likeAdds a "like" to a message
/conversations/{convId}/messages/{itemId}/likeRemoves a "like" from a message
/spaces/{spaceId}/topic/{topicId}/reply/{replyId}Updates a space reply
/spaces/{spaceId}/participant/{participantId}/denyDeny access for a space
/spaces/{spaceId}/participant/{participantId}/grantgrant access for a space
Circuit REST API to interact with the Circuit system. [Learn more about the Circuit Development Community](https://www.circuit.com/web/developers/home)
https://circuitsandbox.net/rest/v2123 endpoints available
/usersSearch for users
/spacesGet the spaces
/webhooksGets a list of webHooks
/webhooksRegisters a WebHook
/webhooksRemoves all webHooks
/spaces/idsGet the spaces by their ids
/users/listSearch multiple users.
/users/{id}Gets the user's profile information
/spaces/{id}Update a space
/spaces/{id}Delete a space
/rtc/sessionsGets a list of active sessions
/users/labelsReturns all user labels
/users/labelsAdd a user label
/conversationsGets a list of conversations
/spaces/createCreate a space
/users/profileGets the authenticated user's profile information
/users/profileUpdates the user profile
/webhooks/{id}Gets a webHook
/webhooks/{id}Updates a WebHook registration
/webhooks/{id}Removes a registered webHook
/spaces/flaggedGet flagged items
/users/presenceGets the presence status
/users/presenceUpdates the presence status
/spaces/directoryGet the directory
/spaces/{id}/joinJoin a space
/spaces/{id}/leaveLeave a space
/users/supportinfoGets the support information
/webhooks/presenceRegisters Presence WebHook registration
/conversations/byIdsGets conversations
/conversations/groupCreates a group conversation
/users/{id}/presenceGets the presence status
/conversations/directChecks for a 1-to-1 conversation
/conversations/directCreates a 1-to-1 conversation
/conversations/searchPerforms a conversation search
/spaces/exists/{name}Space name exists
/spaces/flag/{itemId}flag a space item
/spaces/item/{itemId}deletes a space item
/spaces/like/{itemId}Like a space item
/spaces/search/recentRetrieve recent space searches
/spaces/{topicId}/pinPin a topic
/spaces/likes/{itemId}Get the likes of an item
/telephony/deviceInfosGet devices infos
/conversations/favoriteGets favorite conversations
/conversations/{convId}Gets a conversation
/spaces/unflag/{itemId}Unflag a space item
/spaces/unlike/{itemId}Unlike a space item
/spaces/{spaceId}/topiccreates a new space topic
/spaces/{topicId}/unpinUnpin a topic
/users/labels/{labelId}Remove a user label
/webhooks/presence/{id}Updates a Presence WebHook registration
/conversations/communityGets a list of communities
/conversations/communityCreates a community conversation
/spaces/{id}/participantAdd Participant to Space
/spaces/{spaceId}/topicsGets space topics
/spaces/search/add/recentAdd recent search
/spaces/search/startBasicstarts a basic search in spaces
/spaces/{id}/participantsGet the participants of a space
/spaces/{id}/pinnedTopicsRetrieve pinned topics
/spaces/{id}/labels/assignAssign labels
/conversations/messages/flagGets a list of the flagged messages
/conversations/{convId}/pinsReturns pinned topics of a conversation
/spaces/search/startDetailedstarts a detailed search in a space
/spaces/{id}/labels/unassignUnassign labels
/spaces/{id}/updateTimestampUpdate read timestamp
/conversations/group/{convId}Updates the information of a group conversation
/conversations/{convId}/itemsGets a list of conversation items
/conversations/{convId}/labelAdds a label to a conversation
/spaces/{spaceId}/participantUpdate participant
/conversations/label/{labelId}Returns conversations with a certain label
/webhooks/incoming/{webhookId}Post text item for conversation via webhook.
/webhooks/incoming/{webhookId}Delete an existing webhook
/conversations/{convId}/archiveArchives conversation
/conversations/{convId}/archiveUnmute conversation
/spaces/{id}/participant/removeRemoves participants from a space
/conversations/messages/{itemId}Returns a text item
/conversations/moderate/{convId}Set conversation moderated
/conversations/{convId}/favoriteAdds a conversation to the favorites
/conversations/{convId}/favoriteRemoves a conversation from favorites
/conversations/{convId}/messagesAdds a message to a conversation
/spaces/search/cancel/{searchId}Cancels a space search of a client.
/webhooks/incoming/user/{userId}Get all webhooks of a special user.
/conversations/community/{convId}Updates the information of a community
/conversations/resolveinvitetokenResolves an invite token to a conversation
/spaces/{id}/participants/pendingGet the pending participants of a space
/spaces/{spaceId}/topic/{topicId}Gets space replies and a topic
/spaces/{spaceId}/topic/{topicId}Updates a topic
/conversations/conversationdetailsGets the conference details for multiple conversations
/conversations/unmoderate/{convId}Set conversation unmoderated
/conversations/{convId}/moderatorsAdd moderators
/conversations/{convId}/moderatorsRemove moderators
/spaces/topic/{topicId}/updateTagsUpdate tags
/telephony/telephonyConversationIdGet telephony conversation id
/conversations/{convId}/participantsPerforms a list of participants
/spaces/{id}/searchParticipantsToAddFinds participants to add to add to a space
/spaces/{id}/searchSpaceParticipantsGet the participants of a space
/users/{emailAddress}/getUserByEmailGet user by email
/conversations/{convId}/messages/flagGets a list of the flagged messages of a conversation
/conversations/{convId}/pins/{itemId}Pins a topic of a conversation
/conversations/{convId}/pins/{itemId}Unpins a topic of a conversation
/spaces/{spaceId}/participant/import/missing documentation
/spaces/{spaceId}/participant/requestrequest access for a space
/conversations/community/{convId}/joinAdds the authenticated user to a community
/spaces/{spaceId}/welcomebox/{content}Update content of welcome box
/conversations/{convId}/label/{labelId}Removes a label from a conversation
/spaces/{spaceId}/topic/{topicId}/replyGets space replies
/spaces/{spaceId}/topic/{topicId}/replycreates a reply to a topic
/conversations/{convId}/messages/{itemId}Updates a message
/conversations/{convId}/messages/{itemId}Adds a message to an item
/conversations/{convId}/messages/{itemId}Deletes a message from a conversation
/conversations/group/{convId}/participantsAdds participants to a group conversation
/conversations/group/{convId}/participantsRemoves participants from a group conversation
/webhooks/incoming/create/{conversationId}Create a new webhook for existing conversation.
/conversations/{convId}/conversationdetailsGets the conference details of a conversation
/telephony/{telephonyConversationId}/journalGet journal
/conversations/community/{convId}/participantsAdds participants to a community
/conversations/community/{convId}/participantsRemoves participants from a community
/conversations/{convId}/messages/{itemId}/flagAdds a flag to a message in a conversation
/conversations/{convId}/messages/{itemId}/flagRemoves the flag from a message
/conversations/{convId}/messages/{itemId}/likeAdds a "like" to a message
/conversations/{convId}/messages/{itemId}/likeRemoves a "like" from a message
/spaces/{spaceId}/topic/{topicId}/reply/{replyId}Updates a space reply
/spaces/{spaceId}/participant/{participantId}/denyDeny access for a space
/spaces/{spaceId}/participant/{participantId}/grantgrant access for a space