Deals

Get all deals

Method : GET Endpoint : /api/deals

{
	"current_page": 1,
	"data": [
		{
			"DEAL_ID": 1,
			"PIPELINE_STEP_ID": 3,
			"CLIENT_ID": 12,
			"NAME": "Deal title",
			"AMOUNT": "1500.00",
			"DELETED": 0,
			"EXPECTED_END_DATE": "31.12.2026",
			"WEB_DEAL": null,
			"managers": [
				{
					"DEAL_ID": 1,
					"MANAGER_ID": 5
				}
			],
			"notes": [
				{
					"DEAL_NOTE_ID": 1,
					"DEAL_ID": 1,
					"TEXT": "Note text"
				}
			]
		}
	],
	"first_page_url": "/api/deals?page=1",
	"from": 1,
	"last_page": 1,
	"last_page_url": "/api/deals?page=1",
	"next_page_url": "/api/deals?page=1",
	"path": "/api/deals",
	"per_page": 100,
	"prev_page_url": null,
	"to": 100,
	"total": 12
}

Get single deal

Method : GET Endpoint : /api/deals/{id}

{
	"DEAL_ID": 1,
	"PIPELINE_STEP_ID": 3,
	"CLIENT_ID": 12,
	"NAME": "Deal title",
	"AMOUNT": "1500.00",
	"DELETED": 0,
	"EXPECTED_END_DATE": "31.12.2026",
	"WEB_DEAL": null,
	"managers": [
		{
			"DEAL_ID": 1,
			"MANAGER_ID": 5
		}
	],
	"notes": [
		{
			"DEAL_NOTE_ID": 1,
			"DEAL_ID": 1,
			"TEXT": "Note text"
		}
	]
}

Create deal

Method : POST Endpoint : /api/deals

Field	Type	Required
TITLE	String	✔
PIPELINE	String	✔
PIPELINE_STEP	String	✔
AMOUNT	Decimal
CLIENT_ID	Integer,Id
EXPECTED_END_DATE	Date
WEB_DEAL	String

TIP

PIPELINE and PIPELINE_STEP are matched by title. If they do not exist they will be created automatically.

Example

{
	"TITLE": "Deal title",
	"PIPELINE": "Sales",
	"PIPELINE_STEP": "New",
	"AMOUNT": "1500.00",
	"CLIENT_ID": 12,
	"EXPECTED_END_DATE": "2026-12-31"
}

Update deal

Method : PUT Endpoint : /api/deals/{id}

Delete deal

Method : DELETE Endpoint : /api/deals/{id}

{
	"message": "Successfully deleted!"
}

---

Managers

Add manager to deal

Method : POST Endpoint : /api/deals/{id}/managers

Field	Type	Required
MANAGER_ID	Integer,Id	✔

{
	"DEAL_ID": 1,
	"MANAGER_ID": 5
}

Remove manager from deal

Method : DELETE Endpoint : /api/deals/{id}/managers/{manager_id}

TIP

{manager_id} is the MANAGER_ID of the manager to remove (not a junction record ID).

{
	"message": "Manager removed"
}

---

Notes

Add note to deal

Method : POST Endpoint : /api/deals/{id}/notes

Field	Type	Required
TEXT	Text	✔

{
	"DEAL_ID": 1,
	"TEXT": "Note text"
}

Delete note

Method : DELETE Endpoint : /api/deals/{id}/notes/{note_id}

{
	"message": "Note deleted"
}

---

Pipelines

Get all pipelines

Method : GET Endpoint : /api/deals/pipelines

[
	{
		"PIPELINE_ID": 1,
		"TITLE": "Sales",
		"steps": [
			{
				"PIPELINE_STEP_ID": 1,
				"PIPELINE_ID": 1,
				"TITLE": "New"
			},
			{
				"PIPELINE_STEP_ID": 2,
				"PIPELINE_ID": 1,
				"TITLE": "In Progress"
			}
		]
	}
]

Create pipeline

Method : POST Endpoint : /api/deals/pipelines

Field	Type	Required
TITLE	String	✔

{
	"PIPELINE_ID": 2,
	"TITLE": "Support"
}

Delete pipeline

Method : DELETE Endpoint : /api/deals/pipelines/{pipeline_id}

{
	"message": "Pipeline deleted"
}

Add step to pipeline

Method : POST Endpoint : /api/deals/pipelines/{pipeline_id}/steps

Field	Type	Required
TITLE	String	✔

{
	"PIPELINE_STEP_ID": 3,
	"PIPELINE_ID": 2,
	"TITLE": "Closed"
}

Delete pipeline step

Method : DELETE Endpoint : /api/deals/pipelines/{pipeline_id}/steps/{step_id}

{
	"message": "Pipeline step deleted"
}