CRM Endpoints | Bro World

A) Companies

List companies

/api/crm/general/companies

GET

{
  "page": 1,
  "limit": 20
}

Query JSON

Ex: page=1, limit=20

Get company

/api/crm/general/companies/{company}

GET

Param: company

{}

Query JSON

Ex: page=1, limit=20

Create company

/api/crm/general/companies

POST

{}

Query JSON

Ex: page=1, limit=20

{
  "crmId": "crm-uuid",
  "name": "Acme Corporation",
  "industry": "SaaS",
  "website": "https://acme.test",
  "contactEmail": "contact@acme.test",
  "phone": "+33123456789"
}

Body JSON

Ex: name=Acme

Update company

/api/crm/general/companies/{company}

PATCH

Param: company

{}

Query JSON

Ex: page=1, limit=20

{
  "name": "Acme Intl",
  "industry": "Software",
  "website": "https://acme.io",
  "contactEmail": "hello@acme.io",
  "phone": "+33999999999"
}

Body JSON

Ex: name=Acme

Delete company

/api/crm/general/companies/{company}

DELETE

Param: company

{}

Query JSON

Ex: page=1, limit=20

B) Contacts

List contacts

/api/crm/general/contacts

GET

{
  "page": 1,
  "limit": 20
}

Query JSON

Ex: page=1, limit=20

Get contact

/api/crm/general/contacts/{contact}

GET

Param: contact

{}

Query JSON

Ex: page=1, limit=20

C) Projects

List projects

/api/crm/general/projects

GET

{
  "page": 1,
  "limit": 20
}

Query JSON

Ex: page=1, limit=20

Get project

/api/crm/general/projects/{project}

GET

Param: project

{}

Query JSON

Ex: page=1, limit=20

Create project

/api/crm/general/projects

POST

{}

Query JSON

Ex: page=1, limit=20

{
  "companyId": "company-uuid",
  "name": "Migration CRM",
  "code": "CRM-MIG",
  "description": "Projet de migration",
  "status": "planned",
  "startedAt": "2026-05-01T10:00:00+00:00",
  "dueAt": "2026-06-01T10:00:00+00:00"
}

Body JSON

Ex: name=Acme

Update project

/api/crm/general/projects/{project}

PATCH

Param: project

{}

Query JSON

Ex: page=1, limit=20

{
  "name": "Migration CRM v2",
  "code": "CRM-MIG-V2",
  "description": "Update",
  "status": "in_progress",
  "startedAt": "2026-05-10T09:00:00+00:00",
  "dueAt": "2026-06-10T09:00:00+00:00"
}

Body JSON

Ex: name=Acme

Delete project

/api/crm/general/projects/{project}

DELETE

Param: project

{}

Query JSON

Ex: page=1, limit=20

Attach project assignee

/api/crm/general/projects/{project}/assignees/{user}

PUT

Param: project

Param: user

{}

Query JSON

Ex: page=1, limit=20

{}

Body JSON

Ex: name=Acme

Detach project assignee

/api/crm/general/projects/{project}/assignees/{user}

DELETE

Param: project

Param: user

{}

Query JSON

Ex: page=1, limit=20

D) Sprints

List sprints

/api/crm/general/sprints

GET

{
  "page": 1,
  "limit": 20
}

Query JSON

Ex: page=1, limit=20

Get sprint

/api/crm/general/sprints/{sprint}

GET

Param: sprint

{}

Query JSON

Ex: page=1, limit=20

Create sprint

/api/crm/general/sprints

POST

{}

Query JSON

Ex: page=1, limit=20

{
  "projectId": "project-uuid",
  "name": "Sprint 1",
  "goal": "Livrer le MVP",
  "status": "planned",
  "startDate": "2026-05-01T10:00:00+00:00",
  "endDate": "2026-05-15T10:00:00+00:00"
}

Body JSON

Ex: name=Acme

Update sprint

/api/crm/general/sprints/{sprint}

PATCH

Param: sprint

{}

Query JSON

Ex: page=1, limit=20

{
  "name": "Sprint 1 - updated",
  "goal": "Stabiliser le MVP",
  "status": "in_progress",
  "startDate": "2026-05-02T10:00:00+00:00",
  "endDate": "2026-05-16T10:00:00+00:00"
}

Body JSON

Ex: name=Acme

Delete sprint

/api/crm/general/sprints/{sprint}

DELETE

Param: sprint

{}

Query JSON

Ex: page=1, limit=20

Attach sprint assignee

/api/crm/general/sprints/{sprint}/assignees/{user}

PUT

Param: sprint

Param: user

{}

Query JSON

Ex: page=1, limit=20

{}

Body JSON

Ex: name=Acme

Detach sprint assignee

/api/crm/general/sprints/{sprint}/assignees/{user}

DELETE

Param: sprint

Param: user

{}

Query JSON

Ex: page=1, limit=20

Attach sprint task

/api/crm/general/sprints/{sprint}/tasks/{task}

PUT

Param: sprint

Param: task

{}

Query JSON

Ex: page=1, limit=20

{}

Body JSON

Ex: name=Acme

Detach sprint task

/api/crm/general/sprints/{sprint}/tasks/{task}

DELETE

Param: sprint

Param: task

{}

Query JSON

Ex: page=1, limit=20

E) Tasks + Subtasks

List tasks

/api/crm/general/tasks

GET

{
  "page": 1,
  "limit": 20
}

Query JSON

Ex: page=1, limit=20

Get task

/api/crm/general/tasks/{task}

GET

Param: task

{}

Query JSON

Ex: page=1, limit=20

Create task

/api/crm/general/tasks

POST

{}

Query JSON

Ex: page=1, limit=20

{
  "projectId": "project-uuid",
  "title": "Implémenter migration",
  "description": "Créer scripts SQL",
  "status": "todo",
  "priority": "medium",
  "dueAt": "2026-05-20T10:00:00+00:00",
  "estimatedHours": 8,
  "sprintId": "sprint-uuid",
  "parentTaskId": null
}

Body JSON

Ex: name=Acme

Update task

/api/crm/general/tasks/{task}

PATCH

Param: task

{}

Query JSON

Ex: page=1, limit=20

{
  "title": "Implémenter migration v2",
  "description": "Update",
  "status": "in_progress",
  "priority": "high",
  "dueAt": "2026-05-22T10:00:00+00:00",
  "estimatedHours": 10,
  "projectId": "project-uuid",
  "parentTaskId": null
}

Body JSON

Ex: name=Acme

Delete task

/api/crm/general/tasks/{task}

DELETE

Param: task

{}

Query JSON

Ex: page=1, limit=20

Attach task assignee

/api/crm/general/tasks/{task}/assignees/{user}

PUT

Param: task

Param: user

{}

Query JSON

Ex: page=1, limit=20

{}

Body JSON

Ex: name=Acme

Detach task assignee

/api/crm/general/tasks/{task}/assignees/{user}

DELETE

Param: task

Param: user

{}

Query JSON

Ex: page=1, limit=20

Create subtask

/api/crm/general/tasks/{task}/subtasks

POST

Param: task

{}

Query JSON

Ex: page=1, limit=20

{
  "title": "Créer migration table users",
  "description": "DDL + index",
  "status": "todo",
  "priority": "medium",
  "dueAt": "2026-05-18T10:00:00+00:00",
  "estimatedHours": 3,
  "sprintId": "sprint-uuid"
}

Body JSON

Ex: name=Acme

Update subtask

/api/crm/general/subtasks/{subtask}

PATCH

Param: subtask

{}

Query JSON

Ex: page=1, limit=20

{
  "title": "Créer migration users + roles",
  "description": "Ajout table roles",
  "status": "in_progress",
  "priority": "high",
  "dueAt": "2026-05-19T10:00:00+00:00",
  "estimatedHours": 5,
  "parentTaskId": "task-uuid"
}

Body JSON

Ex: name=Acme

Delete subtask

/api/crm/general/subtasks/{subtask}

DELETE

Param: subtask

{}

Query JSON

Ex: page=1, limit=20

Attach subtask to task

/api/crm/general/tasks/{task}/subtasks/{subtask}

PUT

Param: task

Param: subtask

{}

Query JSON

Ex: page=1, limit=20

{}

Body JSON

Ex: name=Acme

Detach subtask from task

/api/crm/general/tasks/{task}/subtasks/{subtask}

DELETE

Param: task

Param: subtask

{}

Query JSON

Ex: page=1, limit=20

F) Billings

List billings

/api/crm/general/billings

GET

{}

Query JSON

Ex: page=1, limit=20

Get billing

/api/crm/general/billings/{billing}

GET

Param: billing

{}

Query JSON

Ex: page=1, limit=20

Create billing

/api/crm/general/billings

POST

{}

Query JSON

Ex: page=1, limit=20

{
  "companyId": "company-uuid",
  "label": "Licence",
  "amount": 149.9,
  "currency": "EUR",
  "status": "pending",
  "dueAt": "2026-05-01T10:00:00+00:00",
  "paidAt": null
}

Body JSON

Ex: name=Acme

Update billing

/api/crm/general/billings/{billing}

PATCH

Param: billing

{}

Query JSON

Ex: page=1, limit=20

{
  "label": "Licence annuelle",
  "amount": 199,
  "currency": "EUR",
  "status": "paid",
  "dueAt": "2026-05-01T10:00:00+00:00",
  "paidAt": "2026-05-02T12:00:00+00:00"
}

Body JSON

Ex: name=Acme

Delete billing

/api/crm/general/billings/{billing}

DELETE

Param: billing

{}

Query JSON

Ex: page=1, limit=20

G) Task requests

List task requests

/api/crm/general/task-requests

GET

{}

Query JSON

Ex: page=1, limit=20

Get task request

/api/crm/general/task-requests/{taskRequest}

GET

Param: taskRequest

{}

Query JSON

Ex: page=1, limit=20

Create task request

/api/crm/general/task-requests

POST

{}

Query JSON

Ex: page=1, limit=20

{
  "taskId": "task-uuid",
  "repositoryId": "repo-uuid",
  "title": "Créer branche feature",
  "description": "Détails",
  "status": "pending",
  "requestedAt": "2026-05-01T10:00:00+00:00",
  "resolvedAt": null
}

Body JSON

Ex: name=Acme

Update task request

/api/crm/general/task-requests/{taskRequest}

PATCH

Param: taskRequest

{}

Query JSON

Ex: page=1, limit=20

{
  "title": "Créer branche feature/login",
  "description": "Préciser naming",
  "status": "approved",
  "resolvedAt": "2026-05-03T10:00:00+00:00"
}

Body JSON

Ex: name=Acme

Delete task request

/api/crm/general/task-requests/{taskRequest}

DELETE

Param: taskRequest

{}

Query JSON

Ex: page=1, limit=20

H) Dashboard / Reports

Get dashboard

/api/crm/general/dashboard

GET

{}

Query JSON

Ex: page=1, limit=20

Get report JSON

/api/crm/general/reports

GET

{
  "format": "json"
}

Query JSON

Ex: page=1, limit=20

Get report CSV

/api/crm/general/reports

GET

{
  "format": "csv"
}

Query JSON

Ex: page=1, limit=20

Get report PDF

/api/crm/general/reports

GET

{
  "format": "pdf"
}

Query JSON

Ex: page=1, limit=20

CRM Endpoints Playground

A) Companies

B) Contacts

C) Projects

D) Sprints

E) Tasks + Subtasks

F) Billings

G) Task requests

H) Dashboard / Reports