JAI CRM
Home Documentation API Service endpoints

Service endpoints

2 endpoints: Health, Ready.

Every endpoint in Service: 2 operations across 2 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.

Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.

Health

GET/health

Check the API is alive

curl -X GET https://app.jaicrm.ai/health 
  -H 'Authorization: Bearer YOUR_API_KEY'

Ready

GET/health/ready

Check the API can reach its database

curl -X GET https://app.jaicrm.ai/health/ready 
  -H 'Authorization: Bearer YOUR_API_KEY'

Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.