API Reference

The QuintaGo REST API gives you programmatic access to all platform data — leads, proposals, messages, and calendar events. All endpoints return JSON and follow REST conventions.

Base URL

https://api.quintago.io/v1

All requests must use HTTPS. HTTP requests are rejected with a 301 redirect.

Authentication

Include your API key in the Authorization header on every request:

curl https://api.quintago.io/v1/leads \
  -H "Authorization: Bearer qg_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

See Authentication for full details on key types, scopes, and rotation.

Leads endpoints

# List leads (paginated)
GET  /v1/leads?page=1&limit=50&stage=new_enquiry

# Get a single lead
GET  /v1/leads/lead_01HXXXXXXXXXX

# Create a lead
POST /v1/leads
{
  "name": "Ana Silva",
  "email": "ana@example.com",
  "phone": "+351912345678",
  "eventDate": "2025-10-15",
  "guests": 120,
  "source": "website"
}

# Update a lead
PATCH /v1/leads/lead_01HXXXXXXXXXX
{
  "stage": "visit_booked",
  "tags": ["vip", "autumn-2025"]
}

# Archive a lead
DELETE /v1/leads/lead_01HXXXXXXXXXX

Pagination

List endpoints return paginated results. Use the page and limit query parameters. The response includes pagination metadata:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 243,
    "pages": 5,
    "hasNext": true,
    "hasPrev": false
  }
}

Rate limits

The API is rate-limited per API key:

• Read requests — 1,000 per minute
• Write requests — 200 per minute

Rate limit headers are included on every response:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1715351460

Error responses

// 4xx error format
{
  "error": {
    "code": "validation_error",
    "message": "The 'email' field is required",
    "field": "email",
    "status": 422
  }
}

// Common error codes
// 400 bad_request       – malformed request body
// 401 unauthorized      – invalid or missing API key
// 403 forbidden         – insufficient permissions
// 404 not_found         – resource does not exist
// 422 validation_error  – request failed validation
// 429 rate_limit        – too many requests
// 500 server_error      – unexpected server error