Note: API access is available on our Standard, Premium, and Ultimate plans
If you'd like to integrate your own custom applications with Beacon, you can use our open REST API to communicate with your Beacon account.
Please visit our developers website to learn more.
Note: Our API documentation is automatically generated based on how your database is configured. As such, you'll need to log in to be able to view the API docs.
Happy coding! 👩💻
Frequently asked questions
How are filters structured via the API?
We've got an extensive guide to filter structures, operators, and values available on our page here.
Do Beacon workflows run as a result of API actions?
Yes! Check out the FAQs in our workflows guide.
Are there rate limits for API calls?
Yes, we rate limit our API to better protect our systems from abuse.
You are limited to making up to 300 requests per minute. This is a pretty high limit, so this shouldn't restrict your normal use of the Beacon API.
If you exceed this limit, you will be returned a 429 HTTP status code and the following in the response body:
{"error": {"code": "rate_limit_exceeded","message": "You have exceeded the rate limit for API calls. Please try again in a few minutes."}