Every endpoint in Platform: 123 operations across 32 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.
Tenants
GET/api/platform/tenants
List tenants
curl -X GET https://app.jaicrm.ai/api/platform/tenants
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/tenants/{id}
Read one tenant
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/tenants/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/tenants/{id}/ai
List ai
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/ai
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/tenants/{id}/modules
List modules
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/modules
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/tenants/{id}/usage
List usage
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/usage
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/tenants
Create a tenant
curl -X POST https://app.jaicrm.ai/api/platform/tenants
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/tenants/{id}/archive
Create an archive
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/archive
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/tenants/{id}/cancel
Create a cancel
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/cancel
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/tenants/{id}/extend-trial
Create an extend trial
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/extend-trial
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/tenants/{id}/impersonate
Create an impersonate
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/impersonate
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/tenants/{id}/impersonate/end
Create an end
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/impersonate/end
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/tenants/{id}/limits
Create a limit
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/limits
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/tenants/{id}/modules/resync
Create a resync
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/modules/resync
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/tenants/{id}/reactivate
Create a reactivate
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/reactivate
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/tenants/{id}/suspend
Create a suspend
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/suspend
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/tenants/{id}
Change a tenant
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/tenants/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/tenants/{id}/modules
Change a module
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/modules
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/platform/tenants/{id}/ai
Change an ai
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/platform/tenants/RECORD_ID/ai
-H 'Authorization: Bearer YOUR_API_KEY'Plans
GET/api/platform/plans
List plans
curl -X GET https://app.jaicrm.ai/api/platform/plans
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/plans/{id}
Read one plan
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/plans/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/plans/{id}/dependencies
List dependencies
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/plans/RECORD_ID/dependencies
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/plans
Create a plan
curl -X POST https://app.jaicrm.ai/api/platform/plans
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/plans/{id}/prices
Create a price
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/plans/RECORD_ID/prices
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/plans/{id}
Change a plan
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/plans/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/plans/{id}/prices/{priceId}
Change a price
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
priceId | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/plans/RECORD_ID/prices/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/plans/{id}
Delete a plan
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/plans/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/plans/{id}/prices/{priceId}
Delete a price
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
priceId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/plans/RECORD_ID/prices/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Settings
GET/api/platform/settings/email
List email
curl -X GET https://app.jaicrm.ai/api/platform/settings/email
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/settings/email-templates
List email templates
curl -X GET https://app.jaicrm.ai/api/platform/settings/email-templates
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/settings/email-templates/{key}/duplicate
Create a duplicate
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/settings/email-templates/RECORD_ID/duplicate
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/settings/email-templates/{key}/preview
Create a preview
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/settings/email-templates/RECORD_ID/preview
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/settings/email/test
Create a test
curl -X POST https://app.jaicrm.ai/api/platform/settings/email/test
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/platform/settings/email
Change an email
curl -X PUT https://app.jaicrm.ai/api/platform/settings/email
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/platform/settings/email-templates/{key}
Change an email template
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/platform/settings/email-templates/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/settings/email-templates/{key}
Delete an email template
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/settings/email-templates/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Subscriptions
GET/api/platform/subscriptions
List subscriptions
curl -X GET https://app.jaicrm.ai/api/platform/subscriptions
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/subscriptions/{id}
Read one subscription
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/subscriptions/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/subscriptions
Create a subscription
curl -X POST https://app.jaicrm.ai/api/platform/subscriptions
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/subscriptions/{id}/cancel
Create a cancel
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/subscriptions/RECORD_ID/cancel
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/subscriptions/{id}/change-plan
Create a change plan
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/subscriptions/RECORD_ID/change-plan
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/subscriptions/{id}/invoice
Create an invoice
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/subscriptions/RECORD_ID/invoice
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/subscriptions/{id}/reactivate
Create a reactivate
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/subscriptions/RECORD_ID/reactivate
-H 'Authorization: Bearer YOUR_API_KEY'Client types
GET/api/platform/client-types
List client types
curl -X GET https://app.jaicrm.ai/api/platform/client-types
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/client-types/{id}
Read one client type
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/client-types/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/client-types/{id}/dependencies
List dependencies
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/client-types/RECORD_ID/dependencies
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/client-types
Create a client type
curl -X POST https://app.jaicrm.ai/api/platform/client-types
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/client-types/{id}
Change a client type
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/client-types/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/platform/client-types/{id}/modules
Change a module
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/platform/client-types/RECORD_ID/modules
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/client-types/{id}
Delete a client type
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/client-types/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Announcements
GET/api/platform/announcements
List announcements
curl -X GET https://app.jaicrm.ai/api/platform/announcements
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/announcements/{id}
Read one announcement
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/announcements/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/announcements/{id}/reach
List reach
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/announcements/RECORD_ID/reach
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/announcements/options
List options
curl -X GET https://app.jaicrm.ai/api/platform/announcements/options
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/announcements
Create an announcement
curl -X POST https://app.jaicrm.ai/api/platform/announcements
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/announcements/{id}
Change an announcement
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/announcements/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/announcements/{id}
Delete an announcement
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/announcements/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Addons
GET/api/platform/addons
List addons
curl -X GET https://app.jaicrm.ai/api/platform/addons
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/addons/{id}
Read one addon
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/addons/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/addons/{id}/dependencies
List dependencies
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/addons/RECORD_ID/dependencies
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/addons
Create an addon
curl -X POST https://app.jaicrm.ai/api/platform/addons
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/addons/{id}
Change an addon
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/addons/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/addons/{id}
Delete an addon
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/addons/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Coupons
GET/api/platform/coupons
List coupons
curl -X GET https://app.jaicrm.ai/api/platform/coupons
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/coupons/{id}
Read one coupon
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/coupons/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/coupons/{id}/dependencies
List dependencies
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/coupons/RECORD_ID/dependencies
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/coupons
Create a coupon
curl -X POST https://app.jaicrm.ai/api/platform/coupons
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/coupons/{id}
Change a coupon
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/coupons/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/coupons/{id}
Delete a coupon
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/coupons/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Modules
GET/api/platform/modules
List modules
curl -X GET https://app.jaicrm.ai/api/platform/modules
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/modules/{id}
Read one module
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/modules/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/modules/{id}/dependencies
List dependencies
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/modules/RECORD_ID/dependencies
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/modules
Create a module
curl -X POST https://app.jaicrm.ai/api/platform/modules
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/modules/{id}
Change a module
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/modules/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/modules/{id}
Delete a module
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/modules/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Invoices
GET/api/platform/invoices
List invoices
curl -X GET https://app.jaicrm.ai/api/platform/invoices
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/invoices/{id}
Read one invoice
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/invoices/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/invoices/{id}/payments
Create a payment
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/invoices/RECORD_ID/payments
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/invoices/{id}/void
Create a void
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/invoices/RECORD_ID/void
-H 'Authorization: Bearer YOUR_API_KEY'Users
GET/api/platform/users
List users
curl -X GET https://app.jaicrm.ai/api/platform/users
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/users
Create an user
curl -X POST https://app.jaicrm.ai/api/platform/users
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/users/{id}
Change an user
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/users/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/users/{id}
Delete an user
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/users/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Roles
GET/api/platform/roles
List roles
curl -X GET https://app.jaicrm.ai/api/platform/roles
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/roles
Create a role
curl -X POST https://app.jaicrm.ai/api/platform/roles
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/roles/{id}
Change a role
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/roles/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/roles/{id}
Delete a role
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/roles/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Ai
GET/api/platform/ai
List ai
curl -X GET https://app.jaicrm.ai/api/platform/ai
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/ai/models
List models
curl -X GET https://app.jaicrm.ai/api/platform/ai/models
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/ai/test
Create a test
curl -X POST https://app.jaicrm.ai/api/platform/ai/test
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/platform/ai
Change an ai
curl -X PUT https://app.jaicrm.ai/api/platform/ai
-H 'Authorization: Bearer YOUR_API_KEY'Analytics
GET/api/platform/analytics/churn
List churn
curl -X GET https://app.jaicrm.ai/api/platform/analytics/churn
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/analytics/revenue
List revenue
curl -X GET https://app.jaicrm.ai/api/platform/analytics/revenue
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/analytics/tenants
List tenants
curl -X GET https://app.jaicrm.ai/api/platform/analytics/tenants
-H 'Authorization: Bearer YOUR_API_KEY'Gateways
GET/api/platform/gateways
List gateways
curl -X GET https://app.jaicrm.ai/api/platform/gateways
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/gateways/{key}/test
Create a test
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/gateways/RECORD_ID/test
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/platform/gateways/{key}
Change a gateway
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/platform/gateways/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Autopay
GET/api/platform/autopay
List autopay
curl -X GET https://app.jaicrm.ai/api/platform/autopay
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/autopay
Create an autopay
curl -X POST https://app.jaicrm.ai/api/platform/autopay
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/autopay
Delete an autopay
curl -X DELETE https://app.jaicrm.ai/api/platform/autopay
-H 'Authorization: Bearer YOUR_API_KEY'Feedback
GET/api/platform/feedback
List feedback
curl -X GET https://app.jaicrm.ai/api/platform/feedback
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/platform/feedback/{id}
Change a feedback
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/platform/feedback/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/platform/feedback/{id}
Delete a feedback
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/platform/feedback/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Public
GET/api/platform/public/coupons/{code}
Read one coupon
| Parameter | Type | Required | Notes |
|---|---|---|---|
code | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/platform/public/coupons/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/platform/public/plans
List plans
curl -X GET https://app.jaicrm.ai/api/platform/public/plans
-H 'Authorization: Bearer YOUR_API_KEY'Webhooks
GET/api/platform/webhooks
List webhooks
curl -X GET https://app.jaicrm.ai/api/platform/webhooks
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/webhooks/{key}
Act on a webhook
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/webhooks/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Purchases
GET/api/platform/purchases/pending
List pending
curl -X GET https://app.jaicrm.ai/api/platform/purchases/pending
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/platform/purchases/{id}/settle
Create a settle
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/platform/purchases/RECORD_ID/settle
-H 'Authorization: Bearer YOUR_API_KEY'Billing settings
GET/api/platform/billing-settings
List billing settings
curl -X GET https://app.jaicrm.ai/api/platform/billing-settings
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/platform/billing-settings
Change a billing setting
curl -X PUT https://app.jaicrm.ai/api/platform/billing-settings
-H 'Authorization: Bearer YOUR_API_KEY'Branding
GET/api/platform/branding
List branding
curl -X GET https://app.jaicrm.ai/api/platform/branding
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/platform/branding
Change a branding
curl -X PUT https://app.jaicrm.ai/api/platform/branding
-H 'Authorization: Bearer YOUR_API_KEY'Video meetings
GET/api/platform/video-meetings
The Google, Microsoft and Zoom apps video links are made through
curl -X GET https://app.jaicrm.ai/api/platform/video-meetings
-H 'Authorization: Bearer YOUR_API_KEY'PUT/api/platform/video-meetings/{provider}
Save the client id and secret of one video meeting app
| Parameter | Type | Required | Notes |
|---|---|---|---|
provider | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/platform/video-meetings/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Dashboard
GET/api/platform/dashboard
Read the the platform dashboard
curl -X GET https://app.jaicrm.ai/api/platform/dashboard
-H 'Authorization: Bearer YOUR_API_KEY'Payments
GET/api/platform/payments
List payments
curl -X GET https://app.jaicrm.ai/api/platform/payments
-H 'Authorization: Bearer YOUR_API_KEY'Checkout
POST/api/platform/checkout
Create a checkout
curl -X POST https://app.jaicrm.ai/api/platform/checkout
-H 'Authorization: Bearer YOUR_API_KEY'Dunning
GET/api/platform/dunning
List dunning
curl -X GET https://app.jaicrm.ai/api/platform/dunning
-H 'Authorization: Bearer YOUR_API_KEY'Impersonations
GET/api/platform/impersonations
List impersonations
curl -X GET https://app.jaicrm.ai/api/platform/impersonations
-H 'Authorization: Bearer YOUR_API_KEY'Permissions
GET/api/platform/permissions
List permissions
curl -X GET https://app.jaicrm.ai/api/platform/permissions
-H 'Authorization: Bearer YOUR_API_KEY'Audit
GET/api/platform/audit
List audit
curl -X GET https://app.jaicrm.ai/api/platform/audit
-H 'Authorization: Bearer YOUR_API_KEY'Signups
GET/api/platform/signups
List signups
curl -X GET https://app.jaicrm.ai/api/platform/signups
-H 'Authorization: Bearer YOUR_API_KEY'Platform
GET/api/platform/
List platform
curl -X GET https://app.jaicrm.ai/api/platform/
-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.