The Rulebricks API gives you access to core functionality around building, retrieving, and solving rules, and is straightforward to implement.
This documentation describes all of our publicly available API calls and properties of the returned objects. If you have any questions, or need new functionality in our API to become available, please reach out to [email protected].
You can get an API Key by creating an account at https://rulebricks.com/, then opening your dashboard and navigating to the API tab. From this tab, you are able to reveal and copy your key, which you will need to authenticate all your requests to Rulebricks endpoints.
<aside> <img src="https://beestat.io/img/notion/info.svg" alt="https://beestat.io/img/notion/info.svg" width="40px" /> Keep this key safe– anyone with this API Key can use the Rulebricks API as you. If it is compromised, please contact our support and we will help you secure your account.
</aside>
Every API call made to Rulebricks must include the x-api-key header with your API key. To test if you are successfully able to make requests to Rulebricks, we recommend you try the /usage endpoint, which returns basic statistics about your plan and how many times you have run rules on our platform.
To do this, simply make a GET request with the x-api-key header to the following URL.
<https://rulebricks.com/api/v1/usage>
<aside> <img src="https://beestat.io/img/notion/lightbulb.svg" alt="https://beestat.io/img/notion/lightbulb.svg" width="40px" /> You can send API calls directly in your web browser, using cURL from a command line, or with your programming language of choice. You can also use the Postman Collection.
</aside>
