core/crm-core/docs/api.md
2025-12-27 14:32:00 -03:00

962 B

API Contract

Base path: /api/v1

Accounts

  • POST /accounts
  • GET /accounts
  • GET /accounts/{id}
  • PATCH /accounts/{id}
  • DELETE /accounts/{id} (soft delete)

Contacts

  • POST /contacts
  • GET /contacts
  • GET /contacts/{id}
  • PATCH /contacts/{id}
  • DELETE /contacts/{id} (soft delete)

Pipelines/Stages

  • POST /pipelines
  • GET /pipelines
  • POST /pipelines/{id}/stages
  • GET /pipelines/{id}/stages

Deals

  • POST /deals
  • GET /deals?status=open|won|lost&stageId=&accountId=
  • GET /deals/{id}
  • PATCH /deals/{id}
  • POST /deals/{id}/move-stage
  • POST /deals/{id}/close

Activities

  • POST /activities
  • GET /activities?status=open|done&dealId=&assignedUserId=
  • POST /activities/{id}/complete
  • DELETE /activities/{id} (cancel)

Notes

  • POST /notes
  • GET /notes?entityType=&entityId=

Tags

  • POST /tags
  • GET /tags
  • POST /tags/assign
  • POST /tags/unassign

Health

  • GET /health