Headless
Our Headless offering is designed for communities to integrate Circle features into their own website or app, like discussions, feed, notifications, events, and more.
Last updated
Our Headless offering is designed for communities to integrate Circle features into their own website or app, like discussions, feed, notifications, events, and more.
Last updated
Available on our Business plan and above:
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.
UI Kit (Alpha): A React-based UI kit which makes it easy for you to use our off-the-shelf front-end components to build your own front-end experiences on top of our Member API.
Please note:
- The access_token persists across sessions, allowing users to possess multiple tokens concurrently.
- We do not revoke theaccess_token automatically
- Our system automatically revokes the refresh_token after one month for enhanced security
- If you need selective token revocation, our API offers endpoints dedicated to both access_token and refresh_token revocation
Keep your application token secure by making server-side calls for the Auth API. Do not expose your admin API token or your application token in your client-side code.
Implement token management for the Member API using JWT access and refresh tokens on the client-side.
For the full list of API endpoints, please visit https://api-headless.circle.so/.
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.
