Quality endpoints

Every endpoint in Quality: 101 operations across 7 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.

Templates

GET/api/quality/templates

List quality templates, filtered, sorted and paged

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

GET/api/quality/templates/{id}

Read one quality template in full

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

GET/api/quality/templates/{id}/comments

List the comments for a quality template

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

GET/api/quality/templates/{id}/dependencies

List what would break if a quality template were deleted

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

GET/api/quality/templates/{id}/detail

List the detail for a quality template

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

GET/api/quality/templates/{id}/email-check

List the email check for a quality template

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

GET/api/quality/templates/{id}/related

List the related for a quality template

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

GET/api/quality/templates/{id}/related/{module}

List the related for a quality template

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

GET/api/quality/templates/{id}/similar

Find quality templates that look like duplicates of this one

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

GET/api/quality/templates/{id}/timeline

Read everything that has happened to a quality template

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

GET/api/quality/templates/export.csv

Download quality templates as a CSV file

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

GET/api/quality/templates/kanban

Read quality templates arranged as a board

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

GET/api/quality/templates/pivot

Summarise quality templates as a pivot table

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

POST/api/quality/templates

Create a quality template

Body

curl -X POST https://app.jaicrm.ai/api/quality/templates 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "inspectionGuide": "…",
    "isActive": true,
    "custom": "…"
  }'

POST/api/quality/templates/{id}/active

Add to the active of a quality template

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

POST/api/quality/templates/{id}/assignees

Put somebody on a quality template

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

POST/api/quality/templates/{id}/comments

Add to the comments of a quality template

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

POST/api/quality/templates/{id}/email

Send an email about a quality template

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

POST/api/quality/templates/{id}/lines

Add to the lines of a quality template

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

POST/api/quality/templates/{id}/notes

Add a note to a quality template

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

POST/api/quality/templates/bulk

Change several quality templates at once

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

POST/api/quality/templates/bulk/assign

Assign several quality templates to somebody at once

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

POST/api/quality/templates/bulk/delete

Delete several quality templates at once

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

POST/api/quality/templates/import

Import quality templates from a CSV file

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

POST/api/quality/templates/new

Add to the new of a quality template

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

PATCH/api/quality/templates/{id}

Change a quality template

Body

curl -X PATCH https://app.jaicrm.ai/api/quality/templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "inspectionGuide": "…",
    "isActive": true,
    "custom": "…"
  }'

PATCH/api/quality/templates/{id}/notes/{noteId}

Change or remove a note on a quality template

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

DELETE/api/quality/templates/{id}

Delete a quality template

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

DELETE/api/quality/templates/{id}/assignees/{userId}

Take somebody off a quality template

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

DELETE/api/quality/templates/{id}/comments/{commentId}

Remove from the comments of a quality template

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

DELETE/api/quality/templates/{id}/notes/{noteId}

Change or remove a note on a quality template

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

Rules

GET/api/quality/rules

List quality rules, filtered, sorted and paged

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

GET/api/quality/rules/{id}

Read one quality rule in full

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

GET/api/quality/rules/{id}/comments

List the comments for a quality rule

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

GET/api/quality/rules/{id}/dependencies

List what would break if a quality rule were deleted

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

GET/api/quality/rules/{id}/detail

List the detail for a quality rule

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

GET/api/quality/rules/{id}/email-check

List the email check for a quality rule

curl -X GET https://app.jaicrm.ai/api/quality/rules/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/quality/rules/{id}/related

List the related for a quality rule

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

GET/api/quality/rules/{id}/related/{module}

List the related for a quality rule

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

GET/api/quality/rules/{id}/similar

Find quality rules that look like duplicates of this one

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

GET/api/quality/rules/{id}/timeline

Read everything that has happened to a quality rule

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

GET/api/quality/rules/export.csv

Download quality rules as a CSV file

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

GET/api/quality/rules/kanban

Read quality rules arranged as a board

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

GET/api/quality/rules/pivot

Summarise quality rules as a pivot table

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

POST/api/quality/rules

Create a quality rule

Body

curl -X POST https://app.jaicrm.ai/api/quality/rules 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "inspectionGuide": "…",
    "custom": "…"
  }'

POST/api/quality/rules/{id}/assignees

Put somebody on a quality rule

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

POST/api/quality/rules/{id}/comments

Add to the comments of a quality rule

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

POST/api/quality/rules/{id}/email

Send an email about a quality rule

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

POST/api/quality/rules/{id}/lines

Add to the lines of a quality rule

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

POST/api/quality/rules/{id}/notes

Add a note to a quality rule

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

POST/api/quality/rules/{id}/status

Change the status of a quality rule

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

POST/api/quality/rules/bulk

Change several quality rules at once

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

POST/api/quality/rules/bulk/assign

Assign several quality rules to somebody at once

curl -X POST https://app.jaicrm.ai/api/quality/rules/bulk/assign 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/rules/bulk/delete

Delete several quality rules at once

curl -X POST https://app.jaicrm.ai/api/quality/rules/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/rules/import

Import quality rules from a CSV file

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

POST/api/quality/rules/new

Add to the new of a quality rule

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

PATCH/api/quality/rules/{id}

Change a quality rule

Body

curl -X PATCH https://app.jaicrm.ai/api/quality/rules/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "inspectionGuide": "…",
    "status": "…",
    "custom": "…"
  }'

PATCH/api/quality/rules/{id}/notes/{noteId}

Change or remove a note on a quality rule

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

DELETE/api/quality/rules/{id}

Delete a quality rule

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

DELETE/api/quality/rules/{id}/assignees/{userId}

Take somebody off a quality rule

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

DELETE/api/quality/rules/{id}/comments/{commentId}

Remove from the comments of a quality rule

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

DELETE/api/quality/rules/{id}/notes/{noteId}

Change or remove a note on a quality rule

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

Inspections

GET/api/quality/inspections

List quality inspections, filtered, sorted and paged

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

GET/api/quality/inspections/{id}

Read one quality inspection in full

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

GET/api/quality/inspections/{id}/comments

List the comments for a quality inspection

curl -X GET https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/quality/inspections/{id}/dependencies

List what would break if a quality inspection were deleted

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

GET/api/quality/inspections/{id}/detail

List the detail for a quality inspection

curl -X GET https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/detail 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/quality/inspections/{id}/email-check

List the email check for a quality inspection

curl -X GET https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/email-check 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/quality/inspections/{id}/related

List the related for a quality inspection

curl -X GET https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/related 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/quality/inspections/{id}/related/{module}

List the related for a quality inspection

curl -X GET https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/related/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/quality/inspections/{id}/similar

Find quality inspections that look like duplicates of this one

curl -X GET https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/similar 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/quality/inspections/{id}/timeline

Read everything that has happened to a quality inspection

curl -X GET https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/timeline 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/quality/inspections/export.csv

Download quality inspections as a CSV file

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

GET/api/quality/inspections/kanban

Read quality inspections arranged as a board

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

GET/api/quality/inspections/pivot

Summarise quality inspections as a pivot table

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

POST/api/quality/inspections

Create a quality inspection

Body

curl -X POST https://app.jaicrm.ai/api/quality/inspections 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "remarks": "…"
  }'

POST/api/quality/inspections/{id}/assignees

Put somebody on a quality inspection

curl -X POST https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/assignees 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/inspections/{id}/comments

Add to the comments of a quality inspection

curl -X POST https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/inspections/{id}/email

Send an email about a quality inspection

curl -X POST https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/email 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/inspections/{id}/inspector

Add to the inspector of a quality inspection

curl -X POST https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/inspector 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/inspections/{id}/notes

Add a note to a quality inspection

curl -X POST https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/inspections/bulk

Change several quality inspections at once

curl -X POST https://app.jaicrm.ai/api/quality/inspections/bulk 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/inspections/bulk/assign

Assign several quality inspections to somebody at once

curl -X POST https://app.jaicrm.ai/api/quality/inspections/bulk/assign 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/inspections/bulk/delete

Delete several quality inspections at once

curl -X POST https://app.jaicrm.ai/api/quality/inspections/bulk/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/inspections/import

Import quality inspections from a CSV file

curl -X POST https://app.jaicrm.ai/api/quality/inspections/import 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/quality/inspections/{id}

Change a quality inspection

Body

curl -X PATCH https://app.jaicrm.ai/api/quality/inspections/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "remarks": "…",
    "status": "…"
  }'

PATCH/api/quality/inspections/{id}/notes/{noteId}

Change or remove a note on a quality inspection

curl -X PATCH https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/quality/inspections/{id}

Delete a quality inspection

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

DELETE/api/quality/inspections/{id}/assignees/{userId}

Take somebody off a quality inspection

curl -X DELETE https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/assignees/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/quality/inspections/{id}/comments/{commentId}

Remove from the comments of a quality inspection

curl -X DELETE https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/quality/inspections/{id}/notes/{noteId}

Change or remove a note on a quality inspection

curl -X DELETE https://app.jaicrm.ai/api/quality/inspections/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Worklists

GET/api/quality/worklists

List worklists

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

POST/api/quality/worklists/{id}/finish

Create a finish

curl -X POST https://app.jaicrm.ai/api/quality/worklists/RECORD_ID/finish 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/worklists/{id}/sample

Create a sample

curl -X POST https://app.jaicrm.ai/api/quality/worklists/RECORD_ID/sample 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/quality/worklists/{id}/validate

Create a validate

curl -X POST https://app.jaicrm.ai/api/quality/worklists/RECORD_ID/validate 
  -H 'Authorization: Bearer YOUR_API_KEY'

Reports

GET/api/quality/reports/by-transaction

Run the by transaction report

curl -X GET https://app.jaicrm.ai/api/quality/reports/by-transaction 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/quality/reports/failures

Run the failures report

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

GET/api/quality/reports/summary

Read a summary for summary

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

View

GET/api/quality/view

List view

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

POST/api/quality/view

Create a view

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

Quality

GET/api/quality/

List quality

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