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:

All dates in the system are UTC in ISO 8601 format

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. For example when a new customer is made in Moneybird, it can be synced to Cirqll; and vice versa.

For the full documentation on how the integrations work go to https://docs.api.cirqll.nl/zapier. If you can't find what you are looking for checkout the Translations

Setup OAuth2

Checkout the full OAuth2 documentation at https://docs.api.cirqll.nl/oauth2

You will need these urls to authorize with Cirqll.

Type	URL
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.

Zapier#

Setup OAuth2#

Zapier

Setup OAuth2