Settings endpoints

Every endpoint in Settings: 202 operations across 41 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.

Assignment

GET/api/settings/assignment/assignable-users

List assignable users

curl -X GET https://app.jaicrm.ai/api/settings/assignment/assignable-users 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/assignment/log

List log

curl -X GET https://app.jaicrm.ai/api/settings/assignment/log 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/assignment/reallocation

List reallocation

curl -X GET https://app.jaicrm.ai/api/settings/assignment/reallocation 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/assignment/rules

List rules

curl -X GET https://app.jaicrm.ai/api/settings/assignment/rules 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/assignment/settings

List settings

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

GET/api/settings/assignment/thresholds

List thresholds

curl -X GET https://app.jaicrm.ai/api/settings/assignment/thresholds 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/assignment/reallocation/run

Create a run

curl -X POST https://app.jaicrm.ai/api/settings/assignment/reallocation/run 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/assignment/rules

Create a rule

curl -X POST https://app.jaicrm.ai/api/settings/assignment/rules 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/assignment/rules/{id}/entries

Create an entry

curl -X POST https://app.jaicrm.ai/api/settings/assignment/rules/RECORD_ID/entries 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/assignment/entries/{id}

Change an entry

curl -X PATCH https://app.jaicrm.ai/api/settings/assignment/entries/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/assignment/rules/{id}

Change a rule

curl -X PATCH https://app.jaicrm.ai/api/settings/assignment/rules/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/settings/assignment/reallocation

Change a reallocation

curl -X PUT https://app.jaicrm.ai/api/settings/assignment/reallocation 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/settings/assignment/settings

Change a setting

curl -X PUT https://app.jaicrm.ai/api/settings/assignment/settings 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/settings/assignment/thresholds

Change a threshold

curl -X PUT https://app.jaicrm.ai/api/settings/assignment/thresholds 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/assignment/entries/{id}

Delete an entry

curl -X DELETE https://app.jaicrm.ai/api/settings/assignment/entries/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/assignment/rules/{id}

Delete a rule

curl -X DELETE https://app.jaicrm.ai/api/settings/assignment/rules/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/assignment/thresholds/{id}

Delete a threshold

curl -X DELETE https://app.jaicrm.ai/api/settings/assignment/thresholds/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Fields

GET/api/settings/fields/{module}

Read one field

curl -X GET https://app.jaicrm.ai/api/settings/fields/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/fields/{module}/borrowable

List borrowable

curl -X GET https://app.jaicrm.ai/api/settings/fields/RECORD_ID/borrowable 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/fields/{module}/rules

List rules

curl -X GET https://app.jaicrm.ai/api/settings/fields/RECORD_ID/rules 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/fields/{module}

Act on a field

curl -X POST https://app.jaicrm.ai/api/settings/fields/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/fields/{module}/link

Create a link

curl -X POST https://app.jaicrm.ai/api/settings/fields/RECORD_ID/link 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/fields/{module}/rollup

Create a rollup

curl -X POST https://app.jaicrm.ai/api/settings/fields/RECORD_ID/rollup 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/fields/{module}/rules

Create a rule

curl -X POST https://app.jaicrm.ai/api/settings/fields/RECORD_ID/rules 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/fields/{module}/rules/test

Create a test

curl -X POST https://app.jaicrm.ai/api/settings/fields/RECORD_ID/rules/test 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/fields/{module}/{id}

Change a field

curl -X PATCH https://app.jaicrm.ai/api/settings/fields/RECORD_ID/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/fields/{module}/order

Change an order

curl -X PATCH https://app.jaicrm.ai/api/settings/fields/RECORD_ID/order 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/fields/{module}/rules/{id}

Change a rule

curl -X PATCH https://app.jaicrm.ai/api/settings/fields/RECORD_ID/rules/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/fields/{module}/{id}

Delete a field

curl -X DELETE https://app.jaicrm.ai/api/settings/fields/RECORD_ID/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/fields/{module}/rules/{id}

Delete a rule

curl -X DELETE https://app.jaicrm.ai/api/settings/fields/RECORD_ID/rules/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Users

GET/api/settings/users

List users

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

GET/api/settings/users/{id}

Read one user

curl -X GET https://app.jaicrm.ai/api/settings/users/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/users/{id}/dependencies

List dependencies

curl -X GET https://app.jaicrm.ai/api/settings/users/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/users/{id}/effective-permissions

List effective permissions

curl -X GET https://app.jaicrm.ai/api/settings/users/RECORD_ID/effective-permissions 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/users

Create an user

curl -X POST https://app.jaicrm.ai/api/settings/users 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/users/{id}/resend-invitation

Create a resend invitation

curl -X POST https://app.jaicrm.ai/api/settings/users/RECORD_ID/resend-invitation 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/users/permission-preview

Create a permission preview

curl -X POST https://app.jaicrm.ai/api/settings/users/permission-preview 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/users/{id}

Change an user

curl -X PATCH https://app.jaicrm.ai/api/settings/users/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/users/{id}/permissions

Change a permission

curl -X PATCH https://app.jaicrm.ai/api/settings/users/RECORD_ID/permissions 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/users/{id}

Delete an user

curl -X DELETE https://app.jaicrm.ai/api/settings/users/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Reporting tags

GET/api/settings/reporting-tags

List reporting tags

curl -X GET https://app.jaicrm.ai/api/settings/reporting-tags 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/reporting-tags/available

List available

curl -X GET https://app.jaicrm.ai/api/settings/reporting-tags/available 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/reporting-tags/links

List links

curl -X GET https://app.jaicrm.ai/api/settings/reporting-tags/links 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/reporting-tags

Create a reporting tag

curl -X POST https://app.jaicrm.ai/api/settings/reporting-tags 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/reporting-tags/{id}/options

Create an option

curl -X POST https://app.jaicrm.ai/api/settings/reporting-tags/RECORD_ID/options 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/reporting-tags/{id}

Change a reporting tag

curl -X PATCH https://app.jaicrm.ai/api/settings/reporting-tags/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/reporting-tags/{id}/options/{optionId}

Change an option

curl -X PATCH https://app.jaicrm.ai/api/settings/reporting-tags/RECORD_ID/options/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/settings/reporting-tags/links

Change a link

curl -X PUT https://app.jaicrm.ai/api/settings/reporting-tags/links 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/reporting-tags/{id}

Delete a reporting tag

curl -X DELETE https://app.jaicrm.ai/api/settings/reporting-tags/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/reporting-tags/{id}/options/{optionId}

Delete an option

curl -X DELETE https://app.jaicrm.ai/api/settings/reporting-tags/RECORD_ID/options/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Sharing

GET/api/settings/sharing/modules

List modules

curl -X GET https://app.jaicrm.ai/api/settings/sharing/modules 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/sharing/options

List options

curl -X GET https://app.jaicrm.ai/api/settings/sharing/options 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/sharing/org-permissions

List org permissions

curl -X GET https://app.jaicrm.ai/api/settings/sharing/org-permissions 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/sharing/rules

List rules

curl -X GET https://app.jaicrm.ai/api/settings/sharing/rules 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/sharing/rules

Create a rule

curl -X POST https://app.jaicrm.ai/api/settings/sharing/rules 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/sharing/rules/{id}/duplicate

Create a duplicate

curl -X POST https://app.jaicrm.ai/api/settings/sharing/rules/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/sharing/options

Change an option

curl -X PATCH https://app.jaicrm.ai/api/settings/sharing/options 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/sharing/org-permissions/{module}

Change an org permission

curl -X PATCH https://app.jaicrm.ai/api/settings/sharing/org-permissions/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/sharing/rules/{id}

Change a rule

curl -X PATCH https://app.jaicrm.ai/api/settings/sharing/rules/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/sharing/rules/{id}

Delete a rule

curl -X DELETE https://app.jaicrm.ai/api/settings/sharing/rules/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Roles

GET/api/settings/roles

List roles

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

GET/api/settings/roles/{id}

Read one role

curl -X GET https://app.jaicrm.ai/api/settings/roles/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/roles/{id}/dependencies

List dependencies

curl -X GET https://app.jaicrm.ai/api/settings/roles/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/roles/matrix

List matrix

curl -X GET https://app.jaicrm.ai/api/settings/roles/matrix 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/roles/tree

List tree

curl -X GET https://app.jaicrm.ai/api/settings/roles/tree 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/roles

Create a role

curl -X POST https://app.jaicrm.ai/api/settings/roles 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/roles/{id}/duplicate

Create a duplicate

curl -X POST https://app.jaicrm.ai/api/settings/roles/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/roles/{id}

Change a role

curl -X PATCH https://app.jaicrm.ai/api/settings/roles/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/roles/{id}

Delete a role

curl -X DELETE https://app.jaicrm.ai/api/settings/roles/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Templates

GET/api/settings/templates

List templates

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

GET/api/settings/templates/{id}

Read one template

curl -X GET https://app.jaicrm.ai/api/settings/templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/templates/meta

List meta

curl -X GET https://app.jaicrm.ai/api/settings/templates/meta 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/templates

Create a template

curl -X POST https://app.jaicrm.ai/api/settings/templates 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/templates/{id}/default

Create a default

curl -X POST https://app.jaicrm.ai/api/settings/templates/RECORD_ID/default 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/templates/{id}/duplicate

Create a duplicate

curl -X POST https://app.jaicrm.ai/api/settings/templates/RECORD_ID/duplicate 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/templates/{id}/preview

Create a preview

curl -X POST https://app.jaicrm.ai/api/settings/templates/RECORD_ID/preview 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/templates/{id}

Change a template

curl -X PATCH https://app.jaicrm.ai/api/settings/templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/templates/{id}

Delete a template

curl -X DELETE https://app.jaicrm.ai/api/settings/templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Groups

GET/api/settings/groups

List groups

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

GET/api/settings/groups/{id}

Read one group

curl -X GET https://app.jaicrm.ai/api/settings/groups/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/groups/{id}/dependencies

List dependencies

curl -X GET https://app.jaicrm.ai/api/settings/groups/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/groups

Create a group

curl -X POST https://app.jaicrm.ai/api/settings/groups 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/groups/{id}/members

Create a member

curl -X POST https://app.jaicrm.ai/api/settings/groups/RECORD_ID/members 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/groups/{id}

Change a group

curl -X PATCH https://app.jaicrm.ai/api/settings/groups/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/groups/{groupId}/members/{memberId}

Delete a member

curl -X DELETE https://app.jaicrm.ai/api/settings/groups/RECORD_ID/members/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/groups/{id}

Delete a group

curl -X DELETE https://app.jaicrm.ai/api/settings/groups/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Circles

GET/api/settings/circles

List circles, filtered, sorted and paged

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

GET/api/settings/circles/{id}

Read one circle in full

curl -X GET https://app.jaicrm.ai/api/settings/circles/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/circles/{id}/dependencies

List what would break if a circle were deleted

curl -X GET https://app.jaicrm.ai/api/settings/circles/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/circles

Create a circle

curl -X POST https://app.jaicrm.ai/api/settings/circles 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/circles/{id}/members

Add to the members of a circle

curl -X POST https://app.jaicrm.ai/api/settings/circles/RECORD_ID/members 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/circles/{id}

Change a circle

curl -X PATCH https://app.jaicrm.ai/api/settings/circles/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/circles/{groupId}/members/{memberId}

Remove from the members of a circle

curl -X DELETE https://app.jaicrm.ai/api/settings/circles/RECORD_ID/members/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/circles/{id}

Delete a circle

curl -X DELETE https://app.jaicrm.ai/api/settings/circles/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Teams

GET/api/settings/teams

List teams

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

GET/api/settings/teams/{id}

Read one team

curl -X GET https://app.jaicrm.ai/api/settings/teams/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/teams/{id}/dependencies

List dependencies

curl -X GET https://app.jaicrm.ai/api/settings/teams/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/teams

Create a team

curl -X POST https://app.jaicrm.ai/api/settings/teams 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/teams/{id}/members

Create a member

curl -X POST https://app.jaicrm.ai/api/settings/teams/RECORD_ID/members 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/teams/{id}

Change a team

curl -X PATCH https://app.jaicrm.ai/api/settings/teams/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/teams/{groupId}/members/{memberId}

Delete a member

curl -X DELETE https://app.jaicrm.ai/api/settings/teams/RECORD_ID/members/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/teams/{id}

Delete a team

curl -X DELETE https://app.jaicrm.ai/api/settings/teams/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Taxes

GET/api/settings/taxes

List taxes

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

GET/api/settings/taxes/{id}

Read one taxe

curl -X GET https://app.jaicrm.ai/api/settings/taxes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/taxes/{id}/dependencies

List dependencies

curl -X GET https://app.jaicrm.ai/api/settings/taxes/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/taxes/defaults

List defaults

curl -X GET https://app.jaicrm.ai/api/settings/taxes/defaults 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/taxes

Create a taxe

curl -X POST https://app.jaicrm.ai/api/settings/taxes 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/taxes/preview

Create a preview

curl -X POST https://app.jaicrm.ai/api/settings/taxes/preview 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/taxes/{id}

Change a taxe

curl -X PATCH https://app.jaicrm.ai/api/settings/taxes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/taxes/{id}

Delete a taxe

curl -X DELETE https://app.jaicrm.ai/api/settings/taxes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Storage

GET/api/settings/storage

List storage

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

GET/api/settings/storage/breakdown

List breakdown

curl -X GET https://app.jaicrm.ai/api/settings/storage/breakdown 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/storage/explore

List explore

curl -X GET https://app.jaicrm.ai/api/settings/storage/explore 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/storage/mine

List mine

curl -X GET https://app.jaicrm.ai/api/settings/storage/mine 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/storage/requests

List requests

curl -X GET https://app.jaicrm.ai/api/settings/storage/requests 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/storage/{code}

Act on a storage

curl -X POST https://app.jaicrm.ai/api/settings/storage/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/storage/requests

Create a request

curl -X POST https://app.jaicrm.ai/api/settings/storage/requests 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/storage/requests/{id}/decide

Create a decide

curl -X POST https://app.jaicrm.ai/api/settings/storage/requests/RECORD_ID/decide 
  -H 'Authorization: Bearer YOUR_API_KEY'

Branches

GET/api/settings/branches

List branches

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

GET/api/settings/branches/{id}

Read one branche

curl -X GET https://app.jaicrm.ai/api/settings/branches/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/branches/{id}/dependencies

List dependencies

curl -X GET https://app.jaicrm.ai/api/settings/branches/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/branches

Create a branche

curl -X POST https://app.jaicrm.ai/api/settings/branches 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/branches/{id}

Change a branche

curl -X PATCH https://app.jaicrm.ai/api/settings/branches/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/branches/{id}

Delete a branche

curl -X DELETE https://app.jaicrm.ai/api/settings/branches/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Views

GET/api/settings/views/{module}

Read one view

curl -X GET https://app.jaicrm.ai/api/settings/views/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/views

Create a view

curl -X POST https://app.jaicrm.ai/api/settings/views 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/views/{id}/default

Create a default

curl -X POST https://app.jaicrm.ai/api/settings/views/RECORD_ID/default 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/views/{id}

Change a view

curl -X PATCH https://app.jaicrm.ai/api/settings/views/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/views/{id}

Delete a view

curl -X DELETE https://app.jaicrm.ai/api/settings/views/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Email templates

GET/api/settings/email-templates

List email templates

curl -X GET https://app.jaicrm.ai/api/settings/email-templates 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/email-templates/{id}

Read one email template

curl -X GET https://app.jaicrm.ai/api/settings/email-templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/email-templates

Create an email template

curl -X POST https://app.jaicrm.ai/api/settings/email-templates 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/email-templates/{id}

Change an email template

curl -X PATCH https://app.jaicrm.ai/api/settings/email-templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/email-templates/{id}

Delete an email template

curl -X DELETE https://app.jaicrm.ai/api/settings/email-templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Menu items

GET/api/settings/menu-items

List menu items

curl -X GET https://app.jaicrm.ai/api/settings/menu-items 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/menu-items

Create a menu item

curl -X POST https://app.jaicrm.ai/api/settings/menu-items 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/menu-items/{id}

Change a menu item

curl -X PATCH https://app.jaicrm.ai/api/settings/menu-items/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/menu-items/order

Change an order

curl -X PATCH https://app.jaicrm.ai/api/settings/menu-items/order 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/menu-items/{id}

Delete a menu item

curl -X DELETE https://app.jaicrm.ai/api/settings/menu-items/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Bank accounts

GET/api/settings/bank-accounts

List bank accounts

curl -X GET https://app.jaicrm.ai/api/settings/bank-accounts 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/settings/bank-accounts/{id}/dependencies

List dependencies

curl -X GET https://app.jaicrm.ai/api/settings/bank-accounts/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/bank-accounts

Create a bank account

curl -X POST https://app.jaicrm.ai/api/settings/bank-accounts 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/bank-accounts/{id}

Change a bank account

curl -X PATCH https://app.jaicrm.ai/api/settings/bank-accounts/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/bank-accounts/{id}

Delete a bank account

curl -X DELETE https://app.jaicrm.ai/api/settings/bank-accounts/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

My email

GET/api/settings/my-email

List my email

curl -X GET https://app.jaicrm.ai/api/settings/my-email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/my-email/receive

Create a receive

curl -X POST https://app.jaicrm.ai/api/settings/my-email/receive 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/my-email/test

Create a test

curl -X POST https://app.jaicrm.ai/api/settings/my-email/test 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/settings/my-email

Change a my email

curl -X PUT https://app.jaicrm.ai/api/settings/my-email 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/my-email

Delete a my email

curl -X DELETE https://app.jaicrm.ai/api/settings/my-email 
  -H 'Authorization: Bearer YOUR_API_KEY'

Withholding

GET/api/settings/withholding

List withholding

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

POST/api/settings/withholding

Create a withholding

curl -X POST https://app.jaicrm.ai/api/settings/withholding 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/withholding/{id}

Change a withholding

curl -X PATCH https://app.jaicrm.ai/api/settings/withholding/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/withholding/{id}

Delete a withholding

curl -X DELETE https://app.jaicrm.ai/api/settings/withholding/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Modules

GET/api/settings/modules

List modules

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

PATCH/api/settings/modules/{moduleKey}

Change a module

curl -X PATCH https://app.jaicrm.ai/api/settings/modules/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/modules/{moduleKey}/{submoduleKey}

Change a module

curl -X PATCH https://app.jaicrm.ai/api/settings/modules/RECORD_ID/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/modules/order

Change an order

curl -X PATCH https://app.jaicrm.ai/api/settings/modules/order 
  -H 'Authorization: Bearer YOUR_API_KEY'

Dependencies

GET/api/settings/dependencies

List dependencies

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

POST/api/settings/dependencies

Create a dependency

curl -X POST https://app.jaicrm.ai/api/settings/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/settings/dependencies/{id}

Change a dependency

curl -X PATCH https://app.jaicrm.ai/api/settings/dependencies/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/dependencies/{id}

Delete a dependency

curl -X DELETE https://app.jaicrm.ai/api/settings/dependencies/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Webhooks

GET/api/settings/webhooks

List webhooks

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

POST/api/settings/webhooks

Create a webhook

curl -X POST https://app.jaicrm.ai/api/settings/webhooks 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/webhooks/{id}/test

Create a test

curl -X POST https://app.jaicrm.ai/api/settings/webhooks/RECORD_ID/test 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/webhooks/{id}

Delete a webhook

curl -X DELETE https://app.jaicrm.ai/api/settings/webhooks/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Option sets

GET/api/settings/option-sets

List option sets

curl -X GET https://app.jaicrm.ai/api/settings/option-sets 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/option-sets

Create an option set

curl -X POST https://app.jaicrm.ai/api/settings/option-sets 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/settings/option-sets/{id}/values

Change a value

curl -X PUT https://app.jaicrm.ai/api/settings/option-sets/RECORD_ID/values 
  -H 'Authorization: Bearer YOUR_API_KEY'

HSN

GET/api/settings/hsn

List hsn

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

POST/api/settings/hsn

Create a hsn

curl -X POST https://app.jaicrm.ai/api/settings/hsn 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/hsn/{id}

Delete a hsn

curl -X DELETE https://app.jaicrm.ai/api/settings/hsn/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Snippets

GET/api/settings/snippets

List snippets

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

POST/api/settings/snippets

Create a snippet

curl -X POST https://app.jaicrm.ai/api/settings/snippets 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/snippets/{id}

Delete a snippet

curl -X DELETE https://app.jaicrm.ai/api/settings/snippets/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

API keys

GET/api/settings/api-keys

List api keys

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

POST/api/settings/api-keys

Create an api key

curl -X POST https://app.jaicrm.ai/api/settings/api-keys 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/api-keys/{id}

Delete an api key

curl -X DELETE https://app.jaicrm.ai/api/settings/api-keys/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Workspace email

GET/api/settings/workspace-email

List workspace email

curl -X GET https://app.jaicrm.ai/api/settings/workspace-email 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/settings/workspace-email

Change a workspace email

curl -X PUT https://app.jaicrm.ai/api/settings/workspace-email 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/settings/workspace-email

Delete a workspace email

curl -X DELETE https://app.jaicrm.ai/api/settings/workspace-email 
  -H 'Authorization: Bearer YOUR_API_KEY'

Organisation

GET/api/settings/organisation

List organisation

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

PATCH/api/settings/organisation

Change an organisation

curl -X PATCH https://app.jaicrm.ai/api/settings/organisation 
  -H 'Authorization: Bearer YOUR_API_KEY'

Settings

GET/api/settings/settings

List settings

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

PATCH/api/settings/settings

Change a setting

curl -X PATCH https://app.jaicrm.ai/api/settings/settings 
  -H 'Authorization: Bearer YOUR_API_KEY'

Plugins

GET/api/settings/plugins

List plugins

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

POST/api/settings/plugins/{key}

Act on a plugin

curl -X POST https://app.jaicrm.ai/api/settings/plugins/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Addons

GET/api/settings/addons

List addons

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

POST/api/settings/addons/{key}

Act on an addon

curl -X POST https://app.jaicrm.ai/api/settings/addons/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Numbering

GET/api/settings/numbering

List numbering

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

PATCH/api/settings/numbering/{id}

Change a numbering

curl -X PATCH https://app.jaicrm.ai/api/settings/numbering/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Audit

GET/api/settings/audit

List audit

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

GET/api/settings/audit/export.csv

List export.csv

curl -X GET https://app.jaicrm.ai/api/settings/audit/export.csv 
  -H 'Authorization: Bearer YOUR_API_KEY'

Recycle bin

GET/api/settings/recycle-bin

List recycle bin

curl -X GET https://app.jaicrm.ai/api/settings/recycle-bin 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/settings/recycle-bin/restore

Create a restore

curl -X POST https://app.jaicrm.ai/api/settings/recycle-bin/restore 
  -H 'Authorization: Bearer YOUR_API_KEY'

Mail sharing

GET/api/settings/mail-sharing

List mail sharing

curl -X GET https://app.jaicrm.ai/api/settings/mail-sharing 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/settings/mail-sharing

Change a mail sharing

curl -X PUT https://app.jaicrm.ai/api/settings/mail-sharing 
  -H 'Authorization: Bearer YOUR_API_KEY'

People

GET/api/settings/people

List people

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

Permission scopes

GET/api/settings/permission-scopes

List permission scopes

curl -X GET https://app.jaicrm.ai/api/settings/permission-scopes 
  -H 'Authorization: Bearer YOUR_API_KEY'

Field modules

GET/api/settings/field-modules

List field modules

curl -X GET https://app.jaicrm.ai/api/settings/field-modules 
  -H 'Authorization: Bearer YOUR_API_KEY'

Integrations

GET/api/settings/integrations

List integrations

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

Menu

GET/api/settings/menu

List menu

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

Mail delete

PUT/api/settings/mail-delete

Change a mail delete

curl -X PUT https://app.jaicrm.ai/api/settings/mail-delete 
  -H 'Authorization: Bearer YOUR_API_KEY'