CRM endpoints

Every endpoint in CRM: 200 operations across 15 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.

Tasks

GET/api/crm/tasks

List tasks, filtered, sorted and paged

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

GET/api/crm/tasks/{id}

Read one task in full

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

GET/api/crm/tasks/{id}/comments

List the comments for a task

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

GET/api/crm/tasks/{id}/dependencies

List what would break if a task were deleted

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

GET/api/crm/tasks/{id}/email-check

List the email check for a task

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

GET/api/crm/tasks/{id}/related

List the related for a task

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

GET/api/crm/tasks/{id}/related/{module}

List the related for a task

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

GET/api/crm/tasks/{id}/similar

Find tasks that look like duplicates of this one

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

GET/api/crm/tasks/{id}/timeline

Read everything that has happened to a task

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

GET/api/crm/tasks/export.csv

Download tasks as a CSV file

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

GET/api/crm/tasks/kanban

Read tasks arranged as a board

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

GET/api/crm/tasks/mine

List the mine for a task

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

GET/api/crm/tasks/pivot

Summarise tasks as a pivot table

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

POST/api/crm/tasks

Create a task

Body

curl -X POST https://app.jaicrm.ai/api/crm/tasks 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "title": "…",
    "description": "…",
    "type": "…",
    "status": "…"
  }'

POST/api/crm/tasks/{id}/assignees

Put somebody on a task

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

POST/api/crm/tasks/{id}/comments

Add to the comments of a task

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

POST/api/crm/tasks/{id}/complete

Add to the complete of a task

curl -X POST https://app.jaicrm.ai/api/crm/tasks/RECORD_ID/complete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/crm/tasks/{id}/email

Send an email about a task

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

POST/api/crm/tasks/{id}/notes

Add a note to a task

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

POST/api/crm/tasks/{id}/reopen

Add to the reopen of a task

curl -X POST https://app.jaicrm.ai/api/crm/tasks/RECORD_ID/reopen 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/crm/tasks/bulk

Change several tasks at once

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

POST/api/crm/tasks/bulk/assign

Assign several tasks to somebody at once

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

POST/api/crm/tasks/bulk/delete

Delete several tasks at once

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

POST/api/crm/tasks/import

Import tasks from a CSV file

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

PATCH/api/crm/tasks/{id}

Change a task

Body

curl -X PATCH https://app.jaicrm.ai/api/crm/tasks/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "title": "…",
    "description": "…",
    "type": "…",
    "status": "…"
  }'

PATCH/api/crm/tasks/{id}/notes/{noteId}

Change or remove a note on a task

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

DELETE/api/crm/tasks/{id}

Delete a task

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

DELETE/api/crm/tasks/{id}/assignees/{userId}

Take somebody off a task

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

DELETE/api/crm/tasks/{id}/comments/{commentId}

Remove from the comments of a task

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

DELETE/api/crm/tasks/{id}/notes/{noteId}

Change or remove a note on a task

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

Leads

GET/api/crm/leads

List leads, filtered, sorted and paged

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

GET/api/crm/leads/{id}

Read one lead in full

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

GET/api/crm/leads/{id}/comments

List the comments for a lead

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

GET/api/crm/leads/{id}/convert/company

List the company for a lead

curl -X GET https://app.jaicrm.ai/api/crm/leads/RECORD_ID/convert/company 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/crm/leads/{id}/dependencies

List what would break if a lead were deleted

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

GET/api/crm/leads/{id}/email-check

List the email check for a lead

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

GET/api/crm/leads/{id}/related

List the related for a lead

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

GET/api/crm/leads/{id}/related/{module}

List the related for a lead

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

GET/api/crm/leads/{id}/similar

Find leads that look like duplicates of this one

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

GET/api/crm/leads/{id}/timeline

Read everything that has happened to a lead

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

GET/api/crm/leads/export.csv

Download leads as a CSV file

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

GET/api/crm/leads/kanban

Read leads arranged as a board

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

GET/api/crm/leads/pivot

Summarise leads as a pivot table

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

POST/api/crm/leads

Create a lead

Body

curl -X POST https://app.jaicrm.ai/api/crm/leads 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "partnerId": "…",
    "name": "…",
    "companyName": "…",
    "number": "…"
  }'

POST/api/crm/leads/{id}/assignees

Put somebody on a lead

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

POST/api/crm/leads/{id}/comments

Add to the comments of a lead

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

POST/api/crm/leads/{id}/convert

Convert a lead into the next document

curl -X POST https://app.jaicrm.ai/api/crm/leads/RECORD_ID/convert 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/crm/leads/{id}/email

Send an email about a lead

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

POST/api/crm/leads/{id}/notes

Add a note to a lead

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

POST/api/crm/leads/bulk

Change several leads at once

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

POST/api/crm/leads/bulk/assign

Assign several leads to somebody at once

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

POST/api/crm/leads/bulk/delete

Delete several leads at once

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

POST/api/crm/leads/import

Import leads from a CSV file

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

PATCH/api/crm/leads/{id}

Change a lead

Body

curl -X PATCH https://app.jaicrm.ai/api/crm/leads/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "partnerId": "…",
    "name": "…",
    "companyName": "…",
    "number": "…"
  }'

PATCH/api/crm/leads/{id}/notes/{noteId}

Change or remove a note on a lead

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

DELETE/api/crm/leads/{id}

Delete a lead

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

DELETE/api/crm/leads/{id}/assignees/{userId}

Take somebody off a lead

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

DELETE/api/crm/leads/{id}/comments/{commentId}

Remove from the comments of a lead

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

DELETE/api/crm/leads/{id}/notes/{noteId}

Change or remove a note on a lead

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

Visits

GET/api/crm/visits

List visits, filtered, sorted and paged

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

GET/api/crm/visits/{id}

Read one visit in full

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

GET/api/crm/visits/{id}/comments

List the comments for a visit

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

GET/api/crm/visits/{id}/dependencies

List what would break if a visit were deleted

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

GET/api/crm/visits/{id}/email-check

List the email check for a visit

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

GET/api/crm/visits/{id}/related

List the related for a visit

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

GET/api/crm/visits/{id}/related/{module}

List the related for a visit

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

GET/api/crm/visits/{id}/similar

Find visits that look like duplicates of this one

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

GET/api/crm/visits/{id}/timeline

Read everything that has happened to a visit

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

GET/api/crm/visits/export.csv

Download visits as a CSV file

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

GET/api/crm/visits/kanban

Read visits arranged as a board

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

GET/api/crm/visits/pivot

Summarise visits as a pivot table

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

POST/api/crm/visits

Create a visit

Body

curl -X POST https://app.jaicrm.ai/api/crm/visits 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "purpose": "…",
    "status": "planned",
    "ownerId": "…",
    "plannedAt": "…"
  }'

POST/api/crm/visits/{id}/assignees

Put somebody on a visit

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

POST/api/crm/visits/{id}/cancel

Cancel a visit

curl -X POST https://app.jaicrm.ai/api/crm/visits/RECORD_ID/cancel 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/crm/visits/{id}/comments

Add to the comments of a visit

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

POST/api/crm/visits/{id}/complete

Add to the complete of a visit

curl -X POST https://app.jaicrm.ai/api/crm/visits/RECORD_ID/complete 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/crm/visits/{id}/email

Send an email about a visit

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

POST/api/crm/visits/{id}/notes

Add a note to a visit

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

POST/api/crm/visits/bulk

Change several visits at once

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

POST/api/crm/visits/bulk/assign

Assign several visits to somebody at once

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

POST/api/crm/visits/bulk/delete

Delete several visits at once

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

POST/api/crm/visits/import

Import visits from a CSV file

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

PATCH/api/crm/visits/{id}

Change a visit

Body

curl -X PATCH https://app.jaicrm.ai/api/crm/visits/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "purpose": "…",
    "status": "planned",
    "ownerId": "…",
    "plannedAt": "…"
  }'

PATCH/api/crm/visits/{id}/notes/{noteId}

Change or remove a note on a visit

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

DELETE/api/crm/visits/{id}

Delete a visit

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

DELETE/api/crm/visits/{id}/assignees/{userId}

Take somebody off a visit

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

DELETE/api/crm/visits/{id}/comments/{commentId}

Remove from the comments of a visit

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

DELETE/api/crm/visits/{id}/notes/{noteId}

Change or remove a note on a visit

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

Customers

GET/api/crm/customers

List customers, filtered, sorted and paged

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

GET/api/crm/customers/{id}

Read one customer in full

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

GET/api/crm/customers/{id}/comments

List the comments for a customer

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

GET/api/crm/customers/{id}/dependencies

List what would break if a customer were deleted

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

GET/api/crm/customers/{id}/email-check

List the email check for a customer

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

GET/api/crm/customers/{id}/related

List the related for a customer

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

GET/api/crm/customers/{id}/related/{module}

List the related for a customer

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

GET/api/crm/customers/{id}/similar

Find customers that look like duplicates of this one

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

GET/api/crm/customers/{id}/statement

List the statement for a customer

curl -X GET https://app.jaicrm.ai/api/crm/customers/RECORD_ID/statement 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/crm/customers/{id}/timeline

Read everything that has happened to a customer

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

GET/api/crm/customers/export.csv

Download customers as a CSV file

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

GET/api/crm/customers/kanban

Read customers arranged as a board

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

GET/api/crm/customers/pivot

Summarise customers as a pivot table

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

POST/api/crm/customers

Create a customer

Body

curl -X POST https://app.jaicrm.ai/api/crm/customers 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "partnerId": "…",
    "name": "…",
    "code": "…",
    "companyId": "…"
  }'

POST/api/crm/customers/{id}/assignees

Put somebody on a customer

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

POST/api/crm/customers/{id}/comments

Add to the comments of a customer

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

POST/api/crm/customers/{id}/email

Send an email about a customer

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

POST/api/crm/customers/{id}/notes

Add a note to a customer

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

POST/api/crm/customers/bulk

Change several customers at once

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

POST/api/crm/customers/bulk/assign

Assign several customers to somebody at once

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

POST/api/crm/customers/bulk/delete

Delete several customers at once

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

POST/api/crm/customers/import

Import customers from a CSV file

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

PATCH/api/crm/customers/{id}

Change a customer

Body

curl -X PATCH https://app.jaicrm.ai/api/crm/customers/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "partnerId": "…",
    "name": "…",
    "code": "…",
    "companyId": "…"
  }'

PATCH/api/crm/customers/{id}/notes/{noteId}

Change or remove a note on a customer

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

DELETE/api/crm/customers/{id}

Delete a customer

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

DELETE/api/crm/customers/{id}/assignees/{userId}

Take somebody off a customer

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

DELETE/api/crm/customers/{id}/comments/{commentId}

Remove from the comments of a customer

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

DELETE/api/crm/customers/{id}/notes/{noteId}

Change or remove a note on a customer

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

Deals

GET/api/crm/deals

List deals, filtered, sorted and paged

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

GET/api/crm/deals/{id}

Read one deal in full

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

GET/api/crm/deals/{id}/comments

List the comments for a deal

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

GET/api/crm/deals/{id}/dependencies

List what would break if a deal were deleted

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

GET/api/crm/deals/{id}/email-check

List the email check for a deal

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

GET/api/crm/deals/{id}/related

List the related for a deal

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

GET/api/crm/deals/{id}/related/{module}

List the related for a deal

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

GET/api/crm/deals/{id}/similar

Find deals that look like duplicates of this one

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

GET/api/crm/deals/{id}/timeline

Read everything that has happened to a deal

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

GET/api/crm/deals/export.csv

Download deals as a CSV file

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

GET/api/crm/deals/kanban

Read deals arranged as a board

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

GET/api/crm/deals/pivot

Summarise deals as a pivot table

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

POST/api/crm/deals

Create a deal

Body

curl -X POST https://app.jaicrm.ai/api/crm/deals 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "number": "…",
    "customerId": "…",
    "companyId": "…"
  }'

POST/api/crm/deals/{id}/assignees

Put somebody on a deal

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

POST/api/crm/deals/{id}/close

Add to the close of a deal

curl -X POST https://app.jaicrm.ai/api/crm/deals/RECORD_ID/close 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/crm/deals/{id}/comments

Add to the comments of a deal

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

POST/api/crm/deals/{id}/email

Send an email about a deal

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

POST/api/crm/deals/{id}/notes

Add a note to a deal

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

POST/api/crm/deals/bulk

Change several deals at once

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

POST/api/crm/deals/bulk/assign

Assign several deals to somebody at once

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

POST/api/crm/deals/bulk/delete

Delete several deals at once

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

POST/api/crm/deals/import

Import deals from a CSV file

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

PATCH/api/crm/deals/{id}

Change a deal

Body

curl -X PATCH https://app.jaicrm.ai/api/crm/deals/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "number": "…",
    "customerId": "…",
    "companyId": "…"
  }'

PATCH/api/crm/deals/{id}/notes/{noteId}

Change or remove a note on a deal

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

DELETE/api/crm/deals/{id}

Delete a deal

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

DELETE/api/crm/deals/{id}/assignees/{userId}

Take somebody off a deal

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

DELETE/api/crm/deals/{id}/comments/{commentId}

Remove from the comments of a deal

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

DELETE/api/crm/deals/{id}/notes/{noteId}

Change or remove a note on a deal

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

Companies

GET/api/crm/companies

List companies, filtered, sorted and paged

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

GET/api/crm/companies/{id}

Read one company in full

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

GET/api/crm/companies/{id}/comments

List the comments for a company

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

GET/api/crm/companies/{id}/dependencies

List what would break if a company were deleted

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

GET/api/crm/companies/{id}/email-check

List the email check for a company

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

GET/api/crm/companies/{id}/related

List the related for a company

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

GET/api/crm/companies/{id}/related/{module}

List the related for a company

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

GET/api/crm/companies/{id}/similar

Find companies that look like duplicates of this one

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

GET/api/crm/companies/{id}/timeline

Read everything that has happened to a company

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

GET/api/crm/companies/export.csv

Download companies as a CSV file

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

GET/api/crm/companies/kanban

Read companies arranged as a board

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

GET/api/crm/companies/pivot

Summarise companies as a pivot table

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

POST/api/crm/companies

Create a company

Body

curl -X POST https://app.jaicrm.ai/api/crm/companies 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "legalName": "…",
    "industry": "…",
    "segment": "…"
  }'

POST/api/crm/companies/{id}/assignees

Put somebody on a company

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

POST/api/crm/companies/{id}/comments

Add to the comments of a company

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

POST/api/crm/companies/{id}/email

Send an email about a company

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

POST/api/crm/companies/{id}/notes

Add a note to a company

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

POST/api/crm/companies/bulk

Change several companies at once

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

POST/api/crm/companies/bulk/assign

Assign several companies to somebody at once

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

POST/api/crm/companies/bulk/delete

Delete several companies at once

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

POST/api/crm/companies/import

Import companies from a CSV file

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

PATCH/api/crm/companies/{id}

Change a company

Body

curl -X PATCH https://app.jaicrm.ai/api/crm/companies/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "…",
    "legalName": "…",
    "industry": "…",
    "segment": "…"
  }'

PATCH/api/crm/companies/{id}/notes/{noteId}

Change or remove a note on a company

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

DELETE/api/crm/companies/{id}

Delete a company

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

DELETE/api/crm/companies/{id}/assignees/{userId}

Take somebody off a company

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

DELETE/api/crm/companies/{id}/comments/{commentId}

Remove from the comments of a company

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

DELETE/api/crm/companies/{id}/notes/{noteId}

Change or remove a note on a company

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

Contacts

GET/api/crm/contacts

List contacts

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

GET/api/crm/contacts/{id}

Read one contact

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

GET/api/crm/contacts/{id}/dependencies

List dependencies

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

GET/api/crm/contacts/export.csv

List export.csv

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

GET/api/crm/contacts/summary

Read a summary for sales

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

POST/api/crm/contacts

Create a contact

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

POST/api/crm/contacts/bulk/delete

Create a delete

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

PATCH/api/crm/contacts/{id}

Change a contact

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

DELETE/api/crm/contacts/{id}

Delete a contact

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

Pipelines

GET/api/crm/pipelines

List pipelines

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

POST/api/crm/pipelines

Create a pipeline

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

POST/api/crm/pipelines/{id}/default

Create a default

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

POST/api/crm/pipelines/{id}/delete

Create a delete

curl -X POST https://app.jaicrm.ai/api/crm/pipelines/RECORD_ID/delete 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/crm/pipelines/{id}

Change a pipeline

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

PUT/api/crm/pipelines/{id}/stages

Change a stage

curl -X PUT https://app.jaicrm.ai/api/crm/pipelines/RECORD_ID/stages 
  -H 'Authorization: Bearer YOUR_API_KEY'

Activities

GET/api/crm/activities

List activities

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

GET/api/crm/activities/{id}

Read one activity

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

POST/api/crm/activities

Create an activity

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

PATCH/api/crm/activities/{id}

Change an activity

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

DELETE/api/crm/activities/{id}

Delete an activity

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

Tags

GET/api/crm/tags

List the tags in use, with how many records carry each

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

POST/api/crm/tags/apply

Add or remove tags on several records at once

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

PATCH/api/crm/tags/{name}

Rename a tag on every record that carries it

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

DELETE/api/crm/tags/{name}

Remove a tag from every record that carries it

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

Search

GET/api/crm/search

Search across sales

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

Summary

GET/api/crm/summary

Read a summary for sales

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

Read only

GET/api/crm/read-only/{entity}/{id}

Read one read only

curl -X GET https://app.jaicrm.ai/api/crm/read-only/RECORD_ID/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Only marked

GET/api/crm/only-marked/{entity}/{id}

Read one only marked

curl -X GET https://app.jaicrm.ai/api/crm/only-marked/RECORD_ID/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

CRM

GET/api/crm/

List crm

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