API Integration

Getting Started

You can use API to create custom quests or get our analytics data. To get started, go to your Dashboard => Overview ⇒ API Integration.

If this is your first time, you will see a pop-up where you can request an API key. Otherwise, when you navigate to the API Integration tab, you should see your API key.

Resources & Document

• API Documentation: https://api.communityone.io/v1/documentation

  • For custom quests: https://api.communityone.io/v1/documentation#tag/Custom-Quests. If you are using Cursor or any AI coding tool, download our openAPI JSON doc and let your AI code for you.

  • For analytics: https://api.communityone.io/v1/documentation#tag/Analytics

• Our python SDK is out (Custom Quests Only): https://pypi.org/project/communityone/

  • You should be able to integrate your quests with your Discord in 3 lines

  

• Javascript/Typescript SDK: https://www.npmjs.com/package/communityone!

First, Authentication:

Every server will be given a unique API key in its configuration dashboard.

You must include the API key directly in the header of every request to the API like this:

Copy

{"Authorization": "YOUR_API_KEY"}

If authentication fails, the server will receive a 401 Unauthorized response. Unauthorized (401) response:

Copy

{"detail": "Invalid API key"}