This is the documentation site for the public CabCard API. CabCard makes a RESTful API and webhooks service available to its customers.

If you have any questions, please contact us ([email protected]). We will be happy to talk through your requirements and help you to understand how to achieve your goals using our API.

An API key is required for all API interactions, unless it is specifically stated that no authentication is required.

You can generate and manage API keys using the Developer Tools section of your CabCard Dashboard.

Because API credentials allow access to sensitive data and potentially destructive actions within your account, you should take steps to protect your API credentials carefully. You are responsible for storing and protecting credentials appropriately. If you suspect a credential may have been compromised, please immediately disable the API key from your dashboard.

For your security, when generating an API key you should take care to select only the minimal permissions you require for your integration. In many cases, simply selecting the sales:read permission is sufficient, for example.

To use an API key, you should set an API-Key header in your requests, for example:

All requests to the API must use HTTPS (SSL/TLS).

The API is rate limited. If you make too many requests in a given time window, you will receive a response error code 429 TOO MANY REQUESTS. Please do not abuse the API and be mindful of the need to avoid using excessive system resources.

HTTP responses from the API will include the following headers to enable you to manage rate limit behaviour. Please note that some API endpoints have different rate limit policies.

Although we try to keep system outages and technical incidents to a minimum, it is sometimes necessary to carry out periods of maintenance work and (like all technical systems) we cannot guarantee 100% system availability. Please check our status page at status.cabcard.services for information; we recommend you subscribe for updates by email.