Getting Started

Welcome!

With this API you can build your own integration to exchange data with other systems. Whether you want to retrieve customer data, watch for updates on new assignments, or create tasks; it is all possible. As long as you know how to troubleshoot!

To begin with using the API here are some things you need to know:

The only authentication we support is OAuth2

tokens expire in 15 days

refresh tokens expire in 30 days

We support webhooks for almost every resource (so please avoid HTTP polling when possible)

We support ETag headers (for caching), so make sure to add ETag middleware to your integration to make use of this, when possible

Make use of the Query Parameters to

Paginate, filter and change the ordering on indexes

Get more resources at once by eager loading them (like getting customers and contacts all at once)

Only get certain fields when you want to save on memory usage

Zapier

Cirqll has an official integration for Zapier. It is a no-code integration platform where you can chain triggers with actions. Like for example when a new customer is made in Moneybird, it can be created in Cirqll; and vice versa.

For the full documentation see the Zapier page.

Setup OAuth2

You will need these urls to authorize with Cirqll.

Authorize URL	https://api.cirqll.nl/oauth/authorize
Token URL	https://api.cirqll.nl/oauth/token
Refresh Token URL	https://api.cirqll.nl/oauth/token/refresh

If you do not yet have a server running that can provide you with a callback url, we recommend using https://oauthdebugger.com/ to debug the OAuth2 process. This way you can get a feel for how it works.

Go to Settings > Integrations (or click here)

Click the "Create" button under "Custom Integrations"

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

Keep the client secret safe. It provides access to your data!

(Optional) fill in all details on https://oauthdebugger.com/

Paste this in the scope field to get all permissions.

company.read company.update user.create.all user.read.all user.update.all user.delete.all customer.create.all customer.read.all customer.update.all customer.delete.all contact.create.all contact.read.all contact.update.all contact.delete.all appointment.create.all appointment.read.all appointment.update.all appointment.delete.all task.create.all task.read.all task.update.all task.delete.all chance.create.all chance.read.all chance.update.all chance.delete.all assignment.create.all assignment.read.all assignment.update.all assignment.delete.all contract.create.all contract.read.all contract.update.all contract.delete.all note.create.all note.read.all note.update.all note.delete.all email.create.all email.read.all email.update.all email.delete.all todo.create.all todo.read.all todo.update.all todo.delete.all field.create.all field.read.all field.update.all field.delete.all template.create.all template.read.all template.update.all template.delete.all webhook.create.all webhook.read.all webhook.update.all webhook.delete.all role.create.all role.read.all role.update.all role.delete.all media.create.all media.read.all media.update.all media.delete.all

10.

(Optional) authorize on https://api.cirqll.nl/login

11.

(Optional) copy the token and try out a request

Use Postman or similar for easy request debugging (we use Apidog!)

Test your token and make the following request:

GET /api/auth/me HTTP/1.1
Host: api.cirqll.com
Authorization: Bearer your-access-token
Content-Type: application/json

Zapier#

Setup OAuth2#

Zapier

Setup OAuth2