Circuit REST API Version 2

Name: Circuit REST API Version 2 API
Brand: Circuit REST API Version 2
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsChat Messagingoauth2123 EndpointsREST

For Agents

Read and post Circuit conversations, manage users and presence, and start collaboration calls through 123 OAuth-authenticated REST endpoints. Supports community, group, and direct conversations with scope-controlled access.

Quickstart

Get started with Circuit REST API Version 2 in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"post a message into a Circuit conversation"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Circuit REST API Version 2 API.

Create a community, group, or direct Circuit conversation and add participants

Search conversations and look up message items by itemId for moderation or audit

Moderate or unmoderate a conversation by convId to control posting permissions

Manage user profiles and presence state for the authenticated tenant

GET STARTED

Start building with Circuit REST API Version 2 API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Circuit REST API Version 2, keeping it validated and agent-ready.

Circuit is a team collaboration platform from Unify offering persistent group conversations, direct messages, voice and video calls, screen sharing, and shared spaces. The Circuit REST API v2 exposes 123 endpoints over https://circuitsandbox.net/rest/v2 covering conversations, messages, users, presence, calls, call recording, and spaces. Authentication is OAuth 2.0 implicit flow with fine-grained scopes such as READ_CONVERSATIONS, WRITE_CONVERSATIONS, CALLS, CALL_RECORDING, USER_MANAGEMENT, and MANAGE_PRESENCE so an integration can request only the permissions it actually needs.

Use Cases

Patterns agents use Circuit REST API Version 2 API for, with concrete tasks.

★ Backend Bots Posting Into Circuit Conversations

An ops or build-status bot can authenticate via OAuth 2.0 with the WRITE_CONVERSATIONS scope and post update messages into a Circuit group conversation when CI completes or an alert fires. The /conversations and /conversations/group endpoints support creating new threads, while item-level endpoints retrieve and update individual messages.

POST a new Circuit group conversation via /conversations/group with a participants list and an initial message body announcing the deploy.

Conversation Compliance and Search

Administrators can use GET /conversations/search and GET /conversations/messages/flag to locate flagged content for compliance review, then call POST /conversations/moderate/{convId} to restrict posting in problematic threads. The MODERATE_CONVERSATIONS and SEARCH_CONVERSATIONS scopes control these capabilities, so a compliance integration only needs the scopes it actually exercises.

GET /conversations/search?searchTerm=invoice and POST /conversations/moderate/{convId} for any thread that surfaces sensitive financial content.

Meeting Hand-off From Chat to Call

When a chat conversation needs to escalate to a live call, an integration can use the CALLS scope to initiate a Circuit call attached to an existing conversation. Combined with CALL_RECORDING for compliance, this lets a workflow promote a discussion thread into a recorded session without users leaving Circuit.

Invoke the Circuit call endpoint to start a real-time session attached to convId 'conv_abc123' with recording enabled.

AI Agent Daily Standup Summary

An AI agent invoked through Jentic can pull the last 24 hours of messages from a Circuit group via GET /conversations/{convId} and the message item endpoints, summarise activity, and post the summary back as a new message. Jentic handles OAuth scope selection so the agent only requests READ_CONVERSATIONS and WRITE_CONVERSATIONS — never USER_MANAGEMENT or CALLS.

Search Jentic for 'summarise yesterday's Circuit conversation', load the GET /conversations/{convId} schema, fetch messages, and POST the summary into the same thread.

Key Endpoints

123 endpoints — circuit is a team collaboration platform from unify offering persistent group conversations, direct messages, voice and video calls, screen sharing, and shared spaces.

METHOD

PATH

DESCRIPTION

GET

/conversations

List conversations for the authenticated user

POST

/conversations/group

Create a group conversation

POST

/conversations/community

Create a community conversation

GET

/conversations/search

Search across conversations

POST

/conversations/moderate/{convId}

Moderate a conversation

GET

/conversations/{convId}

Get a conversation by id

GET

/conversations/messages/{itemId}

Get a specific message item

GET

/conversations

List conversations for the authenticated user

POST

/conversations/group

Create a group conversation

POST

/conversations/community

Create a community conversation

GET

/conversations/search

Search across conversations

POST

/conversations/moderate/{convId}

Moderate a conversation

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Circuit OAuth 2.0 access tokens are stored encrypted in the Jentic vault (MAXsystem). Agents request only the OAuth scopes they need (e.g., READ_CONVERSATIONS, WRITE_CONVERSATIONS) and the raw token never enters the agent's prompt.

Intent-based discovery

Agents search Jentic by intent (e.g., 'post a message in Circuit') and Jentic returns the matching operation along with the OAuth scope it requires, so the agent can request least-privilege access automatically.

Time to first call

Direct Circuit integration: 3-5 days for OAuth implicit flow, scope wiring, and pagination across 123 endpoints. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Cisco API

Cisco Webex covers the same team-messaging and meeting use cases as Circuit at enterprise scale.

Choose Webex inside Cisco-standardised enterprises; choose Circuit for tenants already on the Unify Circuit platform.

Complementary

GoToMeeting API

GoToMeeting hosts scheduled meetings that complement Circuit's persistent chat threads.

Use GoToMeeting for external scheduled webinars; use Circuit for the ongoing internal team conversation.

Complementary

CINNOX API

CINNOX handles external customer messaging while Circuit handles internal team collaboration.

Use CINNOX for the outward-facing customer channel; use Circuit when the conversation belongs to staff.

FAQs

Specific to using Circuit REST API Version 2 API through Jentic.

What authentication does the Circuit REST API use?

Circuit uses OAuth 2.0 with the implicit flow, with fine-grained scopes including READ_CONVERSATIONS, WRITE_CONVERSATIONS, CALLS, CALL_RECORDING, USER_MANAGEMENT, and MANAGE_PRESENCE. Through Jentic the access token is held in the MAXsystem vault and never exposed to the agent.

Can I post messages into a Circuit conversation programmatically?

Yes. Create or fetch a conversation via /conversations/group or /conversations/{convId}, then post message items using the item-level endpoints. The WRITE_CONVERSATIONS scope is required for posting.

What are the rate limits for the Circuit REST API?

Circuit does not document hard rate limits in the OpenAPI spec. Plan for tenant-level throttling and let Jentic surface 429 responses for retry. Circuit recommends batching message reads where possible.

How do I search Circuit conversations through Jentic?

Run pip install jentic, search Jentic for 'search Circuit conversations', and load GET /conversations/search. Supply the search term and execute. Jentic injects the OAuth token at runtime. Sign up at https://app.jentic.com/sign-up.

Can I record a Circuit call?

Yes, with the CALL_RECORDING OAuth scope. Combined with the CALLS scope, an integration can start a recorded session attached to a conversation. Recording must comply with your tenant policy and applicable regulation.

How do I moderate a Circuit conversation?

POST /conversations/moderate/{convId} restricts posting to moderators, and POST /conversations/unmoderate/{convId} reverses the change. The MODERATE_CONVERSATIONS scope is required and these endpoints typically pair with /conversations/search for compliance workflows.