With the Cirqll API, you can build your own integration to exchange data with other systems. Whether you want to sync orders, retrieve customer data, or create tasks — it all starts with a solid foundation.This guide will help you get started in just a few steps.
1. What Do You Need?#
Before you begin, make sure you have:A Cirqll account with administrator access
Access to the API documentation
A development environment (ApiDog, Postman, Node.js, Python, etc.)
A place to receive webhooks (optional, for real-time updates)
2. Retrieve Your API Keys#
1.
Log in to your Cirqll account.
2.
Go to Settings > Integrations
3.
Click the "Create integration" button
4.
Give your integration a name and description
5.
Click on the Details button
6.
Scroll to the bottom of the popup
7.
You will see your client id and client secret
⚠️ Note: Keep these credentials safe. They provide access to your data!
3. Connect to the API#
Cirqll only supports OAuth2 authentication. You can set this up in Postman and any other Postman clone. If you are connection in code, we advice installing the recommended OAuth2 package for your language. See OAuth2 for more informationAfter login in through OAuth2 you will have an access token and a refresh token. The access token must be used like this:GET /api/auth/me HTTP/1.1
Host: api.cirqll.com
Authorization: Bearer your-access-token
Content-Type: application/json
4. Test Your Connection#
We recommend starting with a simple GET call:If you receive data about the user and a list of customers, you're good to go!
5. (Optional) Set Up Webhooks#
Want to receive real-time notifications when something changes in Cirqll (like a new task or customer)? You can use webhooks:1.
Ensure your endpoint is reachable via HTTPS
2.
Select which events you want to receive
4.
Test the webhook by triggering the event in Cirqll
6. Start Building#
From here, you can combine endpoints to:Track sales opportunities
Send notes or attachments
Modified at 2025-05-13 08:25:19
