Circle

Circle (circle.so) is an all-in-one community platform for creators, coaches, and brands - hosting discussions, courses, events, live streams, memberships, paywalls, and chat under a single branded space. This is the community software company at circle.so, NOT the USDC / stablecoin financial-services company. Circle exposes a documented public developer platform: an admin-authenticated Admin API (V2) for automations, migrations, and bulk administration; a Headless offering (Member API plus Auth API) for embedding Circle features into your own website or app via member-scoped JWT tokens; and a beta ActionCable WebSocket surface for realtime chat and notifications. API access is plan-gated to the Business plan and above.

8 APIs 0 Features
CommunityCreatorsCoursesMembershipsEventsChatCommunity Platform

APIs

Circle Admin Members API

Admin-authenticated management of community members - list, search, create, update, ban, and delete members; manage member tags and tagged members; and assign members to access ...

Circle Admin Spaces API

Manage the foundational containers of a community - spaces, space groups, and their memberships. Create, list, get, update, and delete spaces and space groups, and add or remove...

Circle Admin Posts and Comments API

Create, list, retrieve, update, move, and delete posts across spaces, manage the comments on those posts, generate AI post summaries, and administer topics. Post parameters cont...

Circle Admin Events API

Create, list, get, update, duplicate, and delete community events, and manage event attendees (add, list, remove). Events are scoped to a space and support recurring configurati...

Circle Admin Courses API

Administer course curricula - create, list, get, update, and delete course sections and course lessons, and set a member's course lesson progress. Backs the learning / cohort ex...

Circle Headless Member API

Member-authenticated server-side API for building your own member-facing experience - home feed, spaces, posts, comments, likes and reactions, bookmarks, community events and RS...

Circle Headless Auth API

Server-to-server authentication API that exchanges a community-level headless auth token for a member-scoped JWT access token (and refresh token) used to call the Member API. Ac...

Circle Realtime WebSocket API

Beta ActionCable (Rails) WebSocket surface for realtime chat and notifications, connected at wss://app.circle.so/cable with a member Bearer access token and a whitelisted Origin...

Collections

Circle Developer Platform API

OPEN

Pricing Plans

Circle Community Plans Pricing

4 plans

PLANS

Rate Limits

Circle Community Rate Limits

4 limits

RATE LIMITS

FinOps

Circle Community Finops

FINOPS

Event Specifications

Circle Realtime WebSocket API (Beta)

Circle exposes a documented public WebSocket API for realtime chat and notifications, in beta for customers on the Business plan and above. The transport is ActionCable (Rails' ...

ASYNCAPI

Resources

🔗
DomainSecurity
DomainSecurity
🔑
Authentication
Authentication
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Circle Developer Platform API
  version: '2.0'
items:
- info:
    name: Admin - Members
    type: folder
  items:
  - info:
      name: List community members
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/admin/v2/community_members
      headers:
      - name: Authorization
        value: Token {{adminToken}}
      params:
      - name: page
        value: '1'
        type: query
      - name: per_page
        value: '10'
        type: query
    docs: Lists community members (paginated).
  - info:
      name: Invite or create a community member
      type: http
    http:
      method: POST
      url: https://app.circle.so/api/admin/v2/community_members
      headers:
      - name: Authorization
        value: Token {{adminToken}}
      body:
        type: json
        data: '{}'
    docs: Invites or creates a community member.
  - info:
      name: List member tags
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/admin/v2/member_tags
      headers:
      - name: Authorization
        value: Token {{adminToken}}
    docs: Lists member tags.
- info:
    name: Admin - Spaces
    type: folder
  items:
  - info:
      name: List spaces
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/admin/v2/spaces
      headers:
      - name: Authorization
        value: Token {{adminToken}}
    docs: Lists spaces.
  - info:
      name: Create a space
      type: http
    http:
      method: POST
      url: https://app.circle.so/api/admin/v2/spaces
      headers:
      - name: Authorization
        value: Token {{adminToken}}
      body:
        type: json
        data: '{}'
    docs: Creates a space.
  - info:
      name: List space members
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/admin/v2/space_members
      headers:
      - name: Authorization
        value: Token {{adminToken}}
    docs: Lists space members.
- info:
    name: Admin - Posts
    type: folder
  items:
  - info:
      name: List posts
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/admin/v2/posts
      headers:
      - name: Authorization
        value: Token {{adminToken}}
    docs: Lists posts across spaces.
  - info:
      name: List comments
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/admin/v2/comments
      headers:
      - name: Authorization
        value: Token {{adminToken}}
    docs: Lists comments.
- info:
    name: Admin - Events
    type: folder
  items:
  - info:
      name: List events
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/admin/v2/events
      headers:
      - name: Authorization
        value: Token {{adminToken}}
    docs: Lists community events.
- info:
    name: Admin - Courses
    type: folder
  items:
  - info:
      name: List course sections
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/admin/v2/course_sections
      headers:
      - name: Authorization
        value: Token {{adminToken}}
    docs: Lists course sections.
  - info:
      name: List course lessons
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/admin/v2/course_lessons
      headers:
      - name: Authorization
        value: Token {{adminToken}}
    docs: Lists course lessons.
- info:
    name: Headless - Auth
    type: folder
  items:
  - info:
      name: Exchange headless auth token for member JWT
      type: http
    http:
      method: POST
      url: https://app.circle.so/api/v1/headless/auth_token
      headers:
      - name: Authorization
        value: Bearer {{headlessAuthToken}}
      body:
        type: json
        data: '{}'
    docs: Exchanges a community-level headless auth token for a member-scoped JWT access token (expires after one hour) plus
      refresh token.
- info:
    name: Headless - Member
    type: folder
  items:
  - info:
      name: Get member home feed
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/headless/v1/home
      headers:
      - name: Authorization
        value: Bearer {{memberAccessToken}}
    docs: Returns the member's home feed.
  - info:
      name: List posts in a space
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/headless/v1/spaces/:space_id/posts
      headers:
      - name: Authorization
        value: Bearer {{memberAccessToken}}
      params:
      - name: space_id
        value: ''
        type: path
    docs: Lists posts in a space as the member.
  - info:
      name: List notifications
      type: http
    http:
      method: GET
      url: https://app.circle.so/api/headless/v1/notifications
      headers:
      - name: Authorization
        value: Bearer {{memberAccessToken}}
    docs: Lists the member's notifications.