API Integration

Get even more out of Hello Club by using our API to create widgets for your website or advanced integrations with other apps or platforms

Lauren Hose avatar
Written by Lauren Hose
Updated over a week ago

If you want to build custom widgets for your website, or if you are looking to develop an advanced integration with another app or platform, you can generate an API key to access your Hello Club data directly via our API.

How to generate an API key

To generate an API key:

  1. Go to the Integrations page

  2. Scroll all the way down and open the API keys card

  3. Click on Create new key

  4. Provide a suitable name for this key so you can identify it later

  5. Click Save to generate your API key

Your API key will be ready to use right away. If you have multiple applications or clients, you can generate as many API keys as needed.

Warning: Your API keys carry many privileges, so be sure to keep them secure!

  • Do not share your API keys in publicly accessible areas

  • Do not commit your API keys to GitHub or similar services

  • Do not store you API keys in the front-end of your website

API documentation

Our API documentation can be found here: https://api-docs.helloclub.com/

Note that this documentation is not exhaustive, and not all endpoints have been documented yet. However, most of the common routes should be there. Please let us know if you require documentation for any additional endpoints.

Frequently asked questions

Can we restrict the permissions for API keys?

At this stage it is not possible to restrict the permissions for API keys. All API keys will always have full access to all of your data (e.g. admin permissions). Please be careful with how you use the API keys and how you store them.

Can API keys be disabled?

Yes, if you don't want to remove an API key but temporarily disable it instead, you can do that by toggling the switch next to the API key that you want to disable to the off position.

Is the API accessible with every plan?

No, to access the API you will need to be on our Business plan. Please contact us if you are a small club but have specific requirements and would like to access the API.

Further reading

Did this answer your question?