Circle Community Platform

Circle (circle.so) is a community platform for creators and businesses to run branded communities with members, spaces, posts, comments, and events. This connector uses Circle's Admin API v2 to read and write community data, including members, spaces, posts, comments, events, tags, and community configuration.

Power end-to-end data operations for your Circle Community Platform API with Nexla. Our bi-directional Circle Community Platform connector is purpose-built for Circle Community Platform, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Circle Community Platform or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Circle Community Platform workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Circle Community Platform credential, you need an Admin API v2 token for the target Circle community, along with the community's host domain. The Admin API v2 is available on Circle's Business plan and higher, and tokens are scoped to a single community.

Circle's Admin API v2 authenticates each request with an API token sent in the Authorization header using the format Token <your_token>. In addition, every request must include a host header naming the community's domain so that Circle routes the request to the correct community.

To obtain your Circle Admin API v2 token, follow these steps:

1. Sign in to the Circle community you want to connect to as a community admin.

2. Click your community name or logo at the top left of the navigation bar, and select Developers.

3. In the sidebar menu, open the Tokens page.

4. Click Create token in the top-right corner of the page.

5. For Type, select the Admin API v2 token type. For Name, enter an internal name that will help you identify this token later (for example, "Nexla Integration").

6. Click Save, then copy the generated token. Store it securely, as it grants administrative access to your community data.

7. Note the domain of your community (for example, mycommunity.circle.so, or your custom domain). This value is sent as the required host header on every Admin API v2 request.

Keep your API token private and do not expose it publicly. Access to the Admin API is available only on Circle's Business plan and higher. For complete information about token creation, request formats, and available endpoints, see the Circle Admin API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Token	Yes	Yes	Circle community Admin API v2 token, found under Developers -> Tokens (type: Admin V2) in the target Circle community's admin dashboard.
Community Host	Yes	No	The domain of the target Circle community (e.g. mycommunity.circle.so, or your custom domain). Sent as the required 'host' header on every Admin API v2 request.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Circle Admin API v2 token in the API Token field. This token authenticates Nexla with your Circle community and is sent in the Authorization header. It grants administrative access to your community data and must be kept confidential.

4. Enter your community's domain in the Community Host field (for example, mycommunity.circle.so, or your custom domain). This value is sent as the required host header on every Admin API v2 request so that Circle routes each request to the correct community.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Circle Community Platform connector tile, then select the credential that will be used to connect to your Circle community, and click Next; or, create a new Circle Community Platform credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Circle Admin API v2 endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Community Members

List community members (profile, headline, bio, profile fields, tags).

• This endpoint returns a paginated list of members across the community. Nexla automatically pages through the results to retrieve all available records.

Get Community Member

Get a single community member by ID.

• This endpoint requires the numeric ID of the community member to retrieve. Enter the member ID when configuring the endpoint.

List Spaces

List spaces (channels/sub-communities) in the community.

• This endpoint returns a paginated list of spaces. Nexla automatically pages through the results to retrieve all available records.

Get Space

Get a single space by ID.

• This endpoint requires the numeric ID of the space to retrieve. Enter the space ID when configuring the endpoint.

List Posts

List basic posts, optionally filtered by space or space group.

• This endpoint returns a paginated list of posts. Nexla automatically pages through the results to retrieve all available records.

Get Post

Get a single post by ID.

• This endpoint requires the numeric ID of the post to retrieve. Enter the post ID when configuring the endpoint.

List Comments

List comments, optionally filtered by space or post.

• This endpoint returns a paginated list of comments. Nexla automatically pages through the results to retrieve all available records.

Get Comment

Get a single comment by ID.

• This endpoint requires the numeric ID of the comment to retrieve. Enter the comment ID when configuring the endpoint.

List Events

List events, optionally filtered by space or date range.

• This endpoint returns a paginated list of events. Nexla automatically pages through the results to retrieve all available records.

Get Event

Get a single event by ID.

• This endpoint requires the numeric ID of the event to retrieve. Enter the event ID when configuring the endpoint.

List Space Members

List members of a given space.

• This endpoint requires the Space ID of the space whose members to list. Enter the space ID when configuring the endpoint. Nexla automatically pages through the results to retrieve all available records.

List Space Groups

List space groups configured in the community.

• This endpoint returns a paginated list of space groups. Nexla automatically pages through the results to retrieve all available records.

List Member Tags

List member tags configured in the community.

• This endpoint returns a paginated list of member tags. Nexla automatically pages through the results to retrieve all available records.

List Access Groups

List access groups configured in the community.

• This endpoint returns a paginated list of access groups. Nexla automatically pages through the results to retrieve all available records.

List Topics

List topics configured in the community.

• This endpoint returns a paginated list of topics. Nexla automatically pages through the results to retrieve all available records.

Get Community

Get details of the community itself.

• This endpoint returns configuration and metadata for the community associated with the credential. No additional parameters are required.

List Event Attendees

List attendees (RSVPs) for a given event.

• This endpoint requires the Event ID of the event whose attendees to list. Enter the event ID when configuring the endpoint. Nexla automatically pages through the results to retrieve all available records.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Circle Community Platform data sources can also be manually configured to ingest data from any valid Circle Admin API v2 endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Circle Community Platform data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Circle Community Platform destination, and select the Send to Destination option from the menu. Select the Circle Community Platform connector from the list of available destination connectors, then select the credential that will be used to connect to your Circle community, and click Next; or, create a new Circle Community Platform credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Circle Admin API v2 endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Community Member

Create/invite a community member by email.

• Each record from your Nexset is sent as a JSON request body to create or invite a new community member. Ensure your records include the member details required by the Circle Admin API v2, such as the member's email address.

Update Community Member

Update an existing community member.

• This endpoint requires the numeric ID of the community member to update. Each record from your Nexset is sent as a JSON request body containing the fields to update.

Create Post

Create a basic post in a basic-type space.

• Each record from your Nexset is sent as a JSON request body to create a new post. Ensure your records include the post details required by the Circle Admin API v2, such as the target space and post content.

Update Post

Update an existing post.

• This endpoint requires the numeric ID of the post to update. Each record from your Nexset is sent as a JSON request body containing the fields to update.

Create Event

Create an event in an event-type space.

• Each record from your Nexset is sent as a JSON request body to create a new event. Ensure your records include the event details required by the Circle Admin API v2, such as the target event-type space and event schedule.

Update Event

Update an existing event.

• This endpoint requires the numeric ID of the event to update. Each record from your Nexset is sent as a JSON request body containing the fields to update.

Create Comment

Create a comment on a post.

• Each record from your Nexset is sent as a JSON request body to create a new comment. Ensure your records include the comment details required by the Circle Admin API v2, such as the target post and comment body.

Create Space

Create a new space.

• Each record from your Nexset is sent as a JSON request body to create a new space. Ensure your records include the space details required by the Circle Admin API v2, such as the space name and space group.

Manual configuration

Circle Community Platform destinations can also be manually configured to send data to any valid Circle Admin API v2 endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Circle Admin API v2 endpoints expect JSON in the request body. For update operations, include the numeric ID of the object to be updated at the end of the endpoint URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Circle Community Platform endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Circle Community Platform endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.