Circle API Documentation

This is the complete API documentation for connecting to the Circle API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Circle: Manage Circle communities, members, spaces, posts, events, and access groups. Keep reading to get started.

Quickstart

Before you run your first Circle request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Circle connection — create or choose one in Connections. Note its connectionId.

Every Circle action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/circle/latest/actions/{actionSlug}

You need a MindCloud API Key and a Circle connection. Then call an action such as Get Basic Post:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/circle/latest/actions/get-basic-post" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Circle account that should run the action. MindCloud stores and refreshes the Circle credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Circle actions

All 40 published actions for this Circle version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Space Member
• POSTCreate Access Group
• POSTCreate Basic Post
• POSTCreate Comment
• POSTCreate Community Member
• POSTCreate Community Segment
• POSTCreate Event
• POSTCreate Member Tag
• POSTCreate Space
• POSTCreate Topic
• GETGet Basic Post
• GETGet Comment
• GETGet Community
• GETGet Community Member
• GETGet Event
• GETGet Member Tag
• GETGet Space
• GETGet Topic
• GETList Access Groups
• GETList Basic Posts
• GETList Comments
• GETList Community Member Spaces
• GETList Community Members
• GETList Community Segments
• GETList Events
• GETList Member Tags
• GETList Profile Fields
• GETList Space Members
• GETList Spaces
• GETList Topics
• GETSearch Community Members
• PUTUpdate Access Group
• PUTUpdate Basic Post
• PUTUpdate Community
• PUTUpdate Community Member
• PUTUpdate Community Segment
• PUTUpdate Event
• PUTUpdate Member Tag
• PUTUpdate Space
• PUTUpdate Topic

Related apps

More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.

GmailSlackDiscordTwilioMicrosoft Teamstl;dvClickSend SMSChatwork