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
      • 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 2 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

1. Admin API

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

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

2. Headless

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:

  • Member API: A server-side API with endpoints for building your own member-side experiences in your app or website. See endpoints Unlike the admin API, requests are member-authenticated via the member-specific JWT tokens you'll generate with the Auth API. 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.

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

3. Data API

Available to customers on our Plus Platform plan only, the Data API 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 Airbyte or similar.

Feedback

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

  • If you have API feedback for our engineering team, please use this form to reach out to us.

More information

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