Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shinecx.com/llms.txt

Use this file to discover all available pages before exploring further.

The ShineCRM REST API lets you read and write contacts, jobs, estimates, invoices, and messages programmatically.
The public API is currently in private beta. Detailed endpoint documentation is being prepared. If you need API access today, contact us at support@shinecx.com.

​
What you’ll be able to do

  • Sync contacts and jobs with external CRMs (HubSpot, Salesforce, Pipedrive, etc.)
  • Push estimates and invoices into accounting systems (QuickBooks, Xero)
  • Build custom dashboards and reports
  • Connect ShineCRM to your existing tooling via webhooks

​
Authentication

The API uses API keys scoped to a single organization. Keys are generated from Settings then API keys in the operator dashboard (coming soon).

​
Base URL

https://api.shinecx.com/v1

​
Rate limits

Standard limits are 100 requests per minute per organization. Higher limits are available on request.

​
Coming next

  • Full endpoint reference (auto-generated from OpenAPI)
  • Webhook event catalog
  • SDK libraries for JavaScript, Python, and Go