Every endpoint in Authentication: 30 operations across 20 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.
Register
GET/api/auth/register/autopay
List autopay
curl -X GET https://app.jaicrm.ai/api/auth/register/autopay
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/auth/register
Create a business and its first administrator
curl -X POST https://app.jaicrm.ai/api/auth/register
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/auth/register/autopay/retry
Create a retry
curl -X POST https://app.jaicrm.ai/api/auth/register/autopay/retry
-H 'Authorization: Bearer YOUR_API_KEY'
Me
GET/api/auth/me/deletion
List deletion
curl -X GET https://app.jaicrm.ai/api/auth/me/deletion
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/auth/me/deletion
Create a deletion
curl -X POST https://app.jaicrm.ai/api/auth/me/deletion
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/auth/me
Read who the current token belongs to
curl -X PATCH https://app.jaicrm.ai/api/auth/me
-H 'Authorization: Bearer YOUR_API_KEY'
2fa
POST/api/auth/2fa/disable
Create a disable
curl -X POST https://app.jaicrm.ai/api/auth/2fa/disable
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/auth/2fa/enable
Create an enable
curl -X POST https://app.jaicrm.ai/api/auth/2fa/enable
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/auth/2fa/setup
Create a setup
curl -X POST https://app.jaicrm.ai/api/auth/2fa/setup
-H 'Authorization: Bearer YOUR_API_KEY'
Workspaces
GET/api/auth/workspaces/{id}/state
List state
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/auth/workspaces/RECORD_ID/state
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/auth/workspaces
Create a workspace
curl -X POST https://app.jaicrm.ai/api/auth/workspaces
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/auth/workspaces/new
Create a new
curl -X POST https://app.jaicrm.ai/api/auth/workspaces/new
-H 'Authorization: Bearer YOUR_API_KEY'
Sessions
GET/api/auth/sessions
List sessions
curl -X GET https://app.jaicrm.ai/api/auth/sessions
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/auth/sessions/{id}
Delete a session
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/auth/sessions/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Platform
GET/api/auth/platform/session
List session
curl -X GET https://app.jaicrm.ai/api/auth/platform/session
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/auth/platform/login
Sign in and receive a token
curl -X POST https://app.jaicrm.ai/api/auth/platform/login
-H 'Authorization: Bearer YOUR_API_KEY'
Login
POST/api/auth/login
Sign in and receive a token
curl -X POST https://app.jaicrm.ai/api/auth/login
-H 'Authorization: Bearer YOUR_API_KEY'
Refresh
POST/api/auth/refresh
Exchange a refresh token for a new one
curl -X POST https://app.jaicrm.ai/api/auth/refresh
-H 'Authorization: Bearer YOUR_API_KEY'
Session
GET/api/auth/session
List session
curl -X GET https://app.jaicrm.ai/api/auth/session
-H 'Authorization: Bearer YOUR_API_KEY'
Logout
POST/api/auth/logout
End the session
curl -X POST https://app.jaicrm.ai/api/auth/logout
-H 'Authorization: Bearer YOUR_API_KEY'
Logout all
POST/api/auth/logout-all
Create a logout all
curl -X POST https://app.jaicrm.ai/api/auth/logout-all
-H 'Authorization: Bearer YOUR_API_KEY'
Forgot password
POST/api/auth/forgot-password
Create a forgot password
curl -X POST https://app.jaicrm.ai/api/auth/forgot-password
-H 'Authorization: Bearer YOUR_API_KEY'
Reset password
POST/api/auth/reset-password
Create a reset password
curl -X POST https://app.jaicrm.ai/api/auth/reset-password
-H 'Authorization: Bearer YOUR_API_KEY'
Change password
POST/api/auth/change-password
Create a change password
curl -X POST https://app.jaicrm.ai/api/auth/change-password
-H 'Authorization: Bearer YOUR_API_KEY'
Invitation
GET/api/auth/invitation/{token}
Read one invitation
| Parameter | Type | Required | Notes |
|---|---|---|---|
token | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/auth/invitation/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Accept invitation
POST/api/auth/accept-invitation
Create an accept invitation
curl -X POST https://app.jaicrm.ai/api/auth/accept-invitation
-H 'Authorization: Bearer YOUR_API_KEY'
My workspaces
GET/api/auth/my-workspaces
List my workspaces
curl -X GET https://app.jaicrm.ai/api/auth/my-workspaces
-H 'Authorization: Bearer YOUR_API_KEY'
Switch
POST/api/auth/switch
Create a switch
curl -X POST https://app.jaicrm.ai/api/auth/switch
-H 'Authorization: Bearer YOUR_API_KEY'
Workspace plans
GET/api/auth/workspace-plans
List workspace plans
curl -X GET https://app.jaicrm.ai/api/auth/workspace-plans
-H 'Authorization: Bearer YOUR_API_KEY'
Default workspace
POST/api/auth/default-workspace
Create a default workspace
curl -X POST https://app.jaicrm.ai/api/auth/default-workspace
-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.