Getting Started

Welcome!

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

A callback url to authorize with OAuth2

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 Client ID & Secret

Go to Settings > Integrations

Click the "Create integration" button

Give your integration a name and callback url

Click on the Details button

Scroll to the bottom of the popup

You will see your client id and client secret

⚠️ Note: Keep these credentials safe. They provide access to your data!

3. Authorize and 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 information

After loging 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:

Ensure your endpoint is reachable via HTTPS

Select which events you want to receive

Create a webhook

Test the webhook by triggering the event in Cirqll

6. Start Building

From here, you can combine endpoints to:

Sync customers

Create tasks

Track sales opportunities

Retrieve contract data

Send notes or attachments

Use the full API documentation to explore all available actions and parameters.

1. What Do You Need?#

2. Retrieve Your Client ID & Secret#

3. Authorize and Connect to the API#

4. Test Your Connection#