JAI CRM
Home Documentation API Projects endpoints

Projects endpoints

56 endpoints: Identity, Summary, Projects, Kanban and more.

Every endpoint in Projects: 56 operations across 18 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.

Tasks

GET/api/projects/tasks

List the tasks for a project

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

GET/api/projects/tasks/{id}

List the tasks for a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/tasks/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/projects/tasks/{id}/attachments

Attach a file to a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/tasks/RECORD_ID/attachments 
  -H 'Authorization: Bearer YOUR_API_KEY'

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

List the comments for a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/tasks/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

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

List what would break if a project were deleted

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/tasks/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/projects/tasks/{id}/history

Read the history of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/tasks/RECORD_ID/history 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/projects/tasks/{id}/subtasks

List the subtasks for a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/tasks/RECORD_ID/subtasks 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/projects/tasks/board

List the board for a project

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

GET/api/projects/tasks/calendar

List the calendar for a project

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

GET/api/projects/tasks/cards

List the cards for a project

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

GET/api/projects/tasks/timeline

Read everything that has happened to a project

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

POST/api/projects/tasks

Add to the tasks of a project

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

POST/api/projects/tasks/{id}/attachments

Attach a file to a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X POST https://app.jaicrm.ai/api/projects/tasks/RECORD_ID/attachments 
  -H 'Authorization: Bearer YOUR_API_KEY'

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

Add to the comments of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X POST https://app.jaicrm.ai/api/projects/tasks/RECORD_ID/comments 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/projects/tasks/{id}

Change the tasks of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X PATCH https://app.jaicrm.ai/api/projects/tasks/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/projects/tasks/{id}/status

Change the status of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X PATCH https://app.jaicrm.ai/api/projects/tasks/RECORD_ID/status 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/projects/tasks/{id}

Remove from the tasks of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X DELETE https://app.jaicrm.ai/api/projects/tasks/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/projects/tasks/{id}/attachments/{attachmentId}

Remove from the attachments of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
attachmentIdstringRequiredThe record’s id.
 
curl -X DELETE https://app.jaicrm.ai/api/projects/tasks/RECORD_ID/attachments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

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

Remove from the comments of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
commentIdstringRequiredThe record’s id.
 
curl -X DELETE https://app.jaicrm.ai/api/projects/tasks/RECORD_ID/comments/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Milestones

GET/api/projects/{id}/milestones

List the milestones for a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/RECORD_ID/milestones 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/projects/milestones/{id}/dependencies

List what would break if a project were deleted

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/milestones/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/projects/{id}/milestones

Add to the milestones of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X POST https://app.jaicrm.ai/api/projects/RECORD_ID/milestones 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/projects/milestones/{id}/complete

Add to the complete of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X POST https://app.jaicrm.ai/api/projects/milestones/RECORD_ID/complete 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/projects/milestones/{id}

Change the milestones of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X PATCH https://app.jaicrm.ai/api/projects/milestones/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/projects/milestones/{id}

Remove from the milestones of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X DELETE https://app.jaicrm.ai/api/projects/milestones/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Timesheets

GET/api/projects/timesheets

List the timesheets for a project

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

GET/api/projects/timesheets/{id}/dependencies

List what would break if a project were deleted

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/timesheets/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/projects/timesheets

Add to the timesheets of a project

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

POST/api/projects/timesheets/{id}/approve

Approve a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X POST https://app.jaicrm.ai/api/projects/timesheets/RECORD_ID/approve 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/projects/timesheets/{id}

Change the timesheets of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X PATCH https://app.jaicrm.ai/api/projects/timesheets/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/projects/timesheets/{id}

Remove from the timesheets of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X DELETE https://app.jaicrm.ai/api/projects/timesheets/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Projects

GET/api/projects/

List projects, filtered, sorted and paged

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

GET/api/projects/{id}

Read one project in full

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/projects/

Create a project

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

PATCH/api/projects/{id}

Change a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X PATCH https://app.jaicrm.ai/api/projects/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/projects/{id}

Delete a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X DELETE https://app.jaicrm.ai/api/projects/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Notes

GET/api/projects/{id}/notes

Add a note to a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/RECORD_ID/notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/projects/{id}/notes

Add a note to a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X POST https://app.jaicrm.ai/api/projects/RECORD_ID/notes 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/projects/{id}/notes/{noteId}

Change or remove a note on a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
noteIdstringRequiredThe record’s id.
 
curl -X PATCH https://app.jaicrm.ai/api/projects/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/projects/{id}/notes/{noteId}

Change or remove a note on a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
noteIdstringRequiredThe record’s id.
 
curl -X DELETE https://app.jaicrm.ai/api/projects/RECORD_ID/notes/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Identity

GET/api/projects/identity

List the identity for a project

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

GET/api/projects/identity/preview

List the preview for a project

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

PATCH/api/projects/identity

Change the identity of a project

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

Members

GET/api/projects/{id}/members

List the members for a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/RECORD_ID/members 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/projects/{id}/members

Change the members of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X PUT https://app.jaicrm.ai/api/projects/RECORD_ID/members 
  -H 'Authorization: Bearer YOUR_API_KEY'

Summary

GET/api/projects/summary

List the summary for a project

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

Kanban

GET/api/projects/kanban

Read projects arranged as a board

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

Pivot

GET/api/projects/pivot

Summarise projects as a pivot table

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

Import

POST/api/projects/import

Import projects from a CSV file

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

Export.csv

GET/api/projects/export.csv

Download projects as a CSV file

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

Bulk

POST/api/projects/bulk/delete

Delete several projects at once

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

Dependencies

GET/api/projects/{id}/dependencies

List what would break if a project were deleted

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/RECORD_ID/dependencies 
  -H 'Authorization: Bearer YOUR_API_KEY'

Restore

POST/api/projects/{id}/restore

Restore a project from the trash

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X POST https://app.jaicrm.ai/api/projects/RECORD_ID/restore 
  -H 'Authorization: Bearer YOUR_API_KEY'

Member options

GET/api/projects/member-options

List the member options for a project

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

Unbilled time

GET/api/projects/{id}/unbilled-time

List the unbilled time for a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X GET https://app.jaicrm.ai/api/projects/RECORD_ID/unbilled-time 
  -H 'Authorization: Bearer YOUR_API_KEY'

Invoice time

POST/api/projects/{id}/invoice-time

Add to the invoice time of a project

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
 
curl -X POST https://app.jaicrm.ai/api/projects/RECORD_ID/invoice-time 
  -H 'Authorization: Bearer YOUR_API_KEY'
Next in api Inventory endpoints → Charcha endpoints →

Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.