API Reference

Aria exposes a REST API for advanced integrations — connect your CRM, website, or custom tools directly to your Aria tenant.

Interactive Explorer

Your backend URL provides a built-in API explorer at /docs. This page lists every available endpoint with request/response examples you can try directly from the browser.

The API explorer is protected by basic auth. Contact support at jkydynasty@gmail.com to receive your credentials.

Authentication

All API requests require an X-API-Key header. You can find your API key under Settings → Account → API Key in the Aria dashboard.


X-API-Key: your-api-key-here

Response Format

Every endpoint returns a standard JSON envelope:


{
  "success": true,
  "data": { },
  "error": null,
  "error_code": null,
  "retry": false
}

success — true if the request completed, false otherwise
data — the response payload (object, array, or null)
error — human-readable error message, or null on success
error_code — machine-readable code (e.g., RATE_LIMIT_EXCEEDED), or null
retry — true if the request can be safely retried

Rate Limits

The API allows 100 requests per minute per tenant. If you exceed this, you will receive a 429 Too Many Requests response with retry: true. Wait a few seconds and try again.

Common Endpoints

Method	Endpoint	Description
`GET`	`/api/leads`	List all leads
`GET`	`/api/leads/:id`	Get a single lead
`POST`	`/api/leads`	Create a new lead
`GET`	`/api/bookings`	List all bookings
`GET`	`/api/analytics/funnel`	Get conversion funnel data

For the full list of endpoints, parameters, and examples, visit the interactive explorer at your backend URL /docs.

Need Help?

WhatsApp +60103369672 or email jkydynasty@gmail.com for API support.