API overview

API Overview

Jewel Value exposes a JSON REST API at https://api.jewelvalue.app/api/v1/. It's the same API our web app uses.

Who can use it

API access is included on the Pro plan and above. Basic plan users see API endpoints return 403 with a plan-upgrade message.

Conventions

• All requests and responses are JSON
• All times are ISO-8601 in UTC unless otherwise noted
• Pagination via ?page=1&limit=50 query params; responses include a pagination block
• Errors return standard HTTP status codes plus a body of { statusCode, error, message }

Resources

• Auth: /auth/login, /auth/refresh
• Valuations: /valuations — full CRUD
• Customers: /customers — full CRUD
• Certificates: /certificates — generate and retrieve
• Webhooks: /webhooks — register your endpoints

Rate limits

100 requests per minute per tenant by default. See Rate limits for details.

Getting started

1. Generate an API key in Settings > Security > API Keys
2. Send it in the X-API-Key header
3. Hit GET /api/v1/auth/me to verify