Frequently Asked Questions (FAQ)

Q1. Do I need an API key to use HelioNote?

Yes, all requests to the HelioNote REST API must be authenticated using an API key.

Q2. Where can I get my API key?

API keys can be generated from your HelioNote account dashboard.

Q3. What data format does the API use?

The API accepts requests and returns responses in JSON format

Q4. Are there rate limits?

Yes, the default rate limit is 100 requests per minute per API key. If you exceed the limit, you’ll receive a 429 Too Many Requests error.

Q5. Can I test the API without real data?

Yes, HelioNote provides a sandbox environment. Replace the base URL with:

https://sandbox.api.helionote.com/v1/
                

Q6. What happens if I delete a note?

Deleted notes are permanently removed and cannot be recovered.

Q7. Who can I contact for support?

You can contact the HelioNote support team at support@helionote.com.

Q8. Can I sort or filter my notes when fetching them?

Yes, you can use query parameters like ?sort=created_at_order;=desc or ?tag=work to filter results.

Q9. Does the API support pagination?

Yes, responses for large datasets are paginated. Use limit and offset query parameters to navigate through results.

Q10. Is the API versioned?

Yes, all endpoints include the version in the URL (e.g.,/v1/). This ensures backward compatibility as new versions are released.