Every endpoint in Portal: 16 operations across 9 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.
Public
GET/api/portal/public/documents/{token}
Read one document
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/portal/public/documents/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/portal/public/documents/{token}/pages/{n}
Read one page
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
n | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/portal/public/documents/RECORD_ID/pages/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/portal/public/documents/{token}/proposal.pdf
List proposal.pdf
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/portal/public/documents/RECORD_ID/proposal.pdf
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/portal/public/documents/{token}/respond
Create a respond
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/portal/public/documents/RECORD_ID/respond
-H 'Authorization: Bearer YOUR_API_KEY'Documents
GET/api/portal/documents
List documents
curl -X GET https://app.jaicrm.ai/api/portal/documents
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/portal/documents/{id}
Read one document
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/portal/documents/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/portal/documents/{id}/respond
Create a respond
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/portal/documents/RECORD_ID/respond
-H 'Authorization: Bearer YOUR_API_KEY'Messages
GET/api/portal/messages
List messages
curl -X GET https://app.jaicrm.ai/api/portal/messages
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/portal/messages
Create a message
curl -X POST https://app.jaicrm.ai/api/portal/messages
-H 'Authorization: Bearer YOUR_API_KEY'Share
POST/api/portal/share/{documentId}
Act on a share
| Parameter | Type | Required | Notes |
|---|---|---|---|
documentId | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/portal/share/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/portal/share/{documentId}
Delete a share
| Parameter | Type | Required | Notes |
|---|---|---|---|
documentId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/portal/share/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Me
GET/api/portal/me
Read who the current token belongs to
curl -X GET https://app.jaicrm.ai/api/portal/me
-H 'Authorization: Bearer YOUR_API_KEY'Summary
GET/api/portal/summary
Read a summary for the portal
curl -X GET https://app.jaicrm.ai/api/portal/summary
-H 'Authorization: Bearer YOUR_API_KEY'Statement
GET/api/portal/statement
List statement
curl -X GET https://app.jaicrm.ai/api/portal/statement
-H 'Authorization: Bearer YOUR_API_KEY'Subscription
GET/api/portal/subscription
List subscription
curl -X GET https://app.jaicrm.ai/api/portal/subscription
-H 'Authorization: Bearer YOUR_API_KEY'Plans
GET/api/portal/plans
List plans
curl -X GET https://app.jaicrm.ai/api/portal/plans
-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.