LogoLogo
  • Get Started
    • Overview
    • Concepts
      • Spaces & space groups
      • Posts
      • Messages
      • TipTap editor
      • File uploads
      • Rich Text Body
    • Websockets (Beta)
  • APIs
    • Admin API
      • Quick start
      • Usage and limits
        • Optimizing usage
        • Best Practices
      • V1
      • V2
    • Headless
      • Quick start
      • Member API
        • Docs
        • Community Member Search
        • Cookies
        • Direct upload
      • Auth SDK
        • Node.js
          • Methods
        • Ruby
        • Go
        • Python
      • Usage and limits
    • Data API
      • Docs
Powered by GitBook
On this page
  • The Circle Developer Platform
  • Feedback
  • More information
  1. Get Started

Overview

An overview of the Circle Developer platform

NextConcepts

Last updated 3 months ago

Circle provides a powerful suite of APIs to developers to build automations, run migrations, bring data into your own data warehouse, or natively integrate community features into your own website or app.

The Circle Developer Platform

Requests are admin-authenticated, which means the API can only be used to build administrative tooling and automations.

Available to customers on our Business plan and above, our Headless offering is designed for communities to integrate Circle features into their own website or app, like discussions, feed, notifications, events, and more.

Headless consists of three components:

Feedback

More information

1.

Available to customers on our Business plan and above, our is designed for community admins to build automations, migration scripts, and administrative integrations.

2.

: A server-side API with endpoints for building your own member-side experiences in your app or website. Unlike the admin API, requests are member-authenticated via the member-specific JWT tokens you'll generate with the . This means every API request is made on behalf of a signed in member on your website or app, allowing you to write your own client-side code for integrating posts, comments, events, notifications, and more into your website or app.

: A server-side API to authenticate your website or app’s signed in members with the Member API using a JWT token. Optionally, you can use the for Node.js to get a head-start with your Node application.

3.

Available to customers on our Plus Platform plan only, the is a special API which lets your data team integrate your community's event stream data into your own warehouse via an ETL integration with a tool like or similar.

If you have general questions or want to share your creations with the developer community, please check out our .

If you have API feedback for our engineering team, to reach out to us.

If you're new to Circle, we recommend checking out the .

Admin API
Admin API
Headless
Member API
See endpoints
Auth API
Auth API
See endpoints
Auth SDK
Data API
Data API
Airbyte
Developer community space
please use this form
Knowledge Base