API Documentation

Welcome to the Numyn API documentation. The public developer API is coming in Q1 2028. It will provide powerful endpoints to manage alerts, automations, and more.

Whether you're building integrations or automating workflows, Numyn will provide a simple, reliable API for managing alerts and keeping your systems in sync.

📅 Release Timeline:

Q1 2028: Numyn bookkeeping platform early access
Q1 2028: Public developer API launch

Join our waitlist to be notified when we launch.

Public Endpoints

GET /api/v1/health

Check API health status and uptime

POST /api/v1/waitlist

Join the Numyn waitlist

POST /api/v1/waitlist/unsubscribe

Remove yourself from the waitlist

POST /api/v1/contact

Send a contact message to our team

Status

📅 Coming Q1 2028: The public Numyn API will launch by the end of Q1 2028. This documentation outlines the planned endpoints and architecture.

Rate Limiting

We implement rate limiting to ensure fair usage and system stability. Current limits:

Public API endpoints: 100 requests per minute per IP
Login endpoint: 5 attempts per 5 minutes per IP
Contact form: 10 submissions per hour per IP

Authentication

The public endpoints do not require authentication. Admin endpoints and management features require authentication and are not yet publicly available.

Support

Have questions or feedback? Reach out to us at hello@numyn.ca or use the contact form.