Aura Partner Integrations API

Enterprise REST API for external partner integrations including commission platforms, external mobile apps, and client booking widgets.

Getting Started

1. Get Your API Key

Log in to your Aura dashboard
Navigate to Settings > Integrations
Scroll to the API Keys section
Click Create API Key and give it a descriptive name (e.g. "Postman Testing")
Copy the key immediately — it is only shown once

Your key will look like: aura_pk_live_xxxxxxxxxxxxxxxxxxxxxxxx

2. Make Your First Request

Test your API key with a simple health check and then an authenticated request:

# No auth required
curl https://api.aura-app.ai/health

# Authenticated request — replace with your key
curl -H "Authorization: Bearer aura_pk_live_xxxxx" \
  https://api.aura-app.ai/v1/leads

3. Explore the API

Browse the endpoint reference in the sidebar
Download the OpenAPI spec for Postman or other tools
Use the GraphQL playground at /graphql

Authentication

Authenticated endpoints support two authentication methods:

1. API Key (for partners and integrations):

Authorization: Bearer aura_pk_live_xxxxxxxxxxxxxxxx

Get your API key from the Aura dashboard at Settings > Integrations.

2. Clerk JWT (for mobile and web apps):

Authorization: Bearer <clerk_jwt_token>

Use Clerk's authentication SDK to obtain a JWT token with org claims.

Rate Limiting

Per API Key: 100 requests/minute
Per Organization: 1000 requests/minute

Rate limit headers are included in all responses:

X-RateLimit-Limit: Maximum requests allowed
X-RateLimit-Remaining: Remaining requests in current window
X-RateLimit-Reset: Unix timestamp when limit resets

API Endpoints

Leads

List leads - Retrieve paginated list of leads
Get lead - Get a specific lead by ID

Calls

List calls - Retrieve paginated list of calls
Get call - Get a specific call by ID

Team

List team members - Retrieve team members with roles and commission rates
Get team member - Get a specific team member by ID

Booking Links

List booking links - Retrieve booking links
Get booking link - Get a specific booking link

Products

List products - Retrieve product catalog
Get product - Get a specific product

Payments

List payments - Retrieve payment records
Get payment - Get a specific payment

Webhooks

List webhooks - List webhook subscriptions
Create webhook - Subscribe to events
Get webhook - Get a specific webhook subscription
Update webhook - Update a webhook subscription
Delete webhook - Remove a webhook subscription
Test webhook - Send a test event to a webhook

Error Handling

All errors follow a standard format:

{
  "success": false,
  "error": "Error message",
  "code": "ERROR_CODE"
}

Common HTTP status codes:

400 Bad Request - Invalid input
401 Unauthorized - Missing or invalid API key
403 Forbidden - Insufficient permissions
404 Not Found - Resource not found
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Server error

Aura Partner API