Every endpoint in Modules you added: 16 operations across 8 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.
Custom
GET/api/custom/{key}
List the records in a module you added
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/custom/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/custom/{key}/{id}
Read a record in a module you added
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/custom/RECORD_ID/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/custom/{key}
Create a record in a module you added
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/custom/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/custom/{key}/{id}
Change a record in a module you added
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/custom/RECORD_ID/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/custom/{key}/{id}
Delete a record in a module you added
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/custom/RECORD_ID/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Modules
GET/api/custom/modules
List the modules this business has added
curl -X GET https://app.jaicrm.ai/api/custom/modules
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/custom/modules
Add a module of your own
curl -X POST https://app.jaicrm.ai/api/custom/modules
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/custom/modules/{key}
Change a module of your own
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/custom/modules/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/custom/modules/{key}
Delete a module of your own
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/custom/modules/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Bulk
POST/api/custom/{key}/bulk
Change several records in a module you added
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/custom/RECORD_ID/bulk
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/custom/{key}/bulk/delete
Delete several records in a module you added
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/custom/RECORD_ID/bulk/delete
-H 'Authorization: Bearer YOUR_API_KEY'Export.csv
GET/api/custom/{key}/export.csv
Export the records of a module you added as CSV
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/custom/RECORD_ID/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'Kanban
GET/api/custom/{key}/kanban
Read a module you added as a board
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/custom/RECORD_ID/kanban
-H 'Authorization: Bearer YOUR_API_KEY'Pivot
GET/api/custom/{key}/pivot
Summarise a module you added as a pivot
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/custom/RECORD_ID/pivot
-H 'Authorization: Bearer YOUR_API_KEY'Import
POST/api/custom/{key}/import
Import records into a module you added
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/custom/RECORD_ID/import
-H 'Authorization: Bearer YOUR_API_KEY'Timeline
GET/api/custom/{key}/{id}/timeline
Read the history of a record in a module you added
| Parameter | Type | Required | Notes |
|---|---|---|---|
key | string | Required | The record’s id. |
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/custom/RECORD_ID/RECORD_ID/timeline
-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.