Sales Pipeline Management API
The Sales Pipeline Management API is a comprehensive system for managing sales processes, deals, stages, tasks, meetings, files, notes, and activities. This powerful API allows you to build complete CRM workflows and sales automation systems.
Overview
Sales Pipeline API consists of multiple interconnected modules:
- Pipeline Management: Main pipeline operations
- Deals Management: Individual deal lifecycle
- Stages Management: Pipeline stage configuration
- Tasks Management: Deal-specific task tracking
- Files Management: Document handling for deals
- Meetings Management: Schedule and manage meetings
- Notes Management: Deal notes and communication
- Activities Management: Activity tracking and logging
- Attributes Management: Custom pipeline attributes
Complete Endpoints Overview
Pipeline Management
| Method | Endpoint | Description |
|---|---|---|
GET | /api/public-v1/sales-pipeline | Get all sales pipelines |
POST | /api/public-v1/sales-pipeline | Create a new sales pipeline |
GET | /api/public-v1/sales-pipeline/{uuid} | Get a specific sales pipeline |
PUT / PATCH | /api/public-v1/sales-pipeline/{uuid} | Update a sales pipeline |
DELETE | /api/public-v1/sales-pipeline/{uuid} | Delete a sales pipeline |
POST | /api/public-v1/sales-pipeline/bulk-actions | Perform bulk operations |
Deals Management
| Method | Endpoint | Description |
|---|---|---|
GET | /api/public-v1/sales-pipeline/{uuid}/deals | Get the deals of a stage |
POST | /api/public-v1/sales-pipeline/{uuid}/deals | Create a new deal |
GET | /api/public-v1/sales-pipeline/{uuid}/deals/{id} | Get a specific deal |
PUT / PATCH | /api/public-v1/sales-pipeline/{uuid}/deals/{id} | Update a deal |
DELETE | /api/public-v1/sales-pipeline/{uuid}/deals/{id} | Delete a deal |
POST | /api/public-v1/sales-pipeline/{uuid}/deals/bulk-actions/{id} | Delete a deal (bulk-actions alias) |
POST | /api/public-v1/sales-pipeline/{uuid}/deals/order-change | Change deal order |
Stage Management
| Method | Endpoint | Description |
|---|---|---|
GET | /api/public-v1/sales-pipeline/{uuid}/stage | Get all stages |
POST | /api/public-v1/sales-pipeline/{uuid}/stage | Create a new stage |
PUT / PATCH | /api/public-v1/sales-pipeline/{uuid}/stage/{id} | Update a stage |
DELETE | /api/public-v1/sales-pipeline/{uuid}/stage/{id} | Delete a stage |
POST | /api/public-v1/sales-pipeline/{uuid}/stage/order-change | Change stage order |
POST | /api/public-v1/sales-pipeline/{uuid}/stage/{id}/duplicate | Duplicate a stage |
POST | /api/public-v1/sales-pipeline/{uuid}/stage/{id}/move-all-deal | Move all deals to another stage |
POST | /api/public-v1/sales-pipeline/{uuid}/stage/bulk-actions | Bulk stage operations |
Task Management
| Method | Endpoint | Description |
|---|---|---|
GET | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task | Get all tasks for a deal |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task | Create a new task |
GET | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id} | Get a specific task |
PUT / PATCH | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id} | Update a task |
DELETE | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id} | Delete a task |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/bulk-actions | Bulk task operations |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id}/order-change | Change task order |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id}/complete | Mark task as complete |
File Management
| Method | Endpoint | Description |
|---|---|---|
GET | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/file | Get all files for a deal |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/file | Upload a file |
DELETE | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/file/{file} | Delete a file |
Meeting Management
| Method | Endpoint | Description |
|---|---|---|
GET | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting | Get all meetings |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting | Create a new meeting |
GET | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/{meeting_id} | Get a specific meeting |
PUT / PATCH | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/{meeting_id} | Update a meeting |
DELETE | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/{meeting_id} | Delete a meeting |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/bulk-actions | Bulk meeting operations |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/{meeting_id}/complete | Mark meeting as complete |
Note Management
| Method | Endpoint | Description |
|---|---|---|
GET | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/note | Get all notes |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/note | Create a new note |
PUT / PATCH | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/note/{note_id} | Update a note |
DELETE | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/note/{note_id} | Delete a note |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/note/bulk-actions | Bulk note operations |
Activity Management
| Method | Endpoint | Description |
|---|---|---|
GET | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity | Get all activities |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity | Create a new activity |
PUT / PATCH | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity/{activity_id} | Update an activity |
DELETE | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity/{activity_id} | Delete an activity |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity/bulk-actions | Bulk activity operations |
POST | /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity/send-mail | Send activity email |
Attribute Management
| Method | Endpoint | Description |
|---|---|---|
GET | /api/public-v1/sales-pipeline/attributes | Get all pipeline attributes |
POST | /api/public-v1/sales-pipeline/attributes | Create a new attribute |
PUT / PATCH | /api/public-v1/sales-pipeline/attributes/{id} | Update an attribute |
DELETE | /api/public-v1/sales-pipeline/attributes/{id} | Delete an attribute |
POST | /api/public-v1/sales-pipeline/attributes/bulk-actions | Bulk attribute operations |
Get All Sales Pipelines
Retrieve a list of all sales pipelines in your system.
GET /api/public-v1/sales-pipelineRequest Headers
X-Secret-Key: your-secret-key-here
Content-Type: application/jsonQuery Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number for pagination |
item | integer | No | Pipelines per page (default: 10). 0 returns all pipelines |
search | string | No | Search term for the pipeline title |
Results are ordered newest first. Team members who are not administrators or managers only see pipelines that contain deals they own or are assigned to.
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline?item=20" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json"Example Response
{
"msg": "Sales Pipeline retrieved successfully.",
"data": [
{
"title": "Main Sales Pipeline",
"status": 1,
"uuid": "pipeline-abc123def456",
"created_at": "2 weeks ago",
"stages_count": 6
}
],
"links": {
"first": "https://public-api.taskip.net/api/public-v1/sales-pipeline?page=1",
"last": "https://public-api.taskip.net/api/public-v1/sales-pipeline?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://public-api.taskip.net/api/public-v1/sales-pipeline",
"per_page": 20,
"to": 1,
"total": 1
}
}Error Responses
| Status | Description |
|---|---|
422 | Validation failed (standard Laravel shape: { "message": "...", "errors": { ... } }) |
Create a Sales Pipeline
Create a new sales pipeline with initial configuration.
POST /api/public-v1/sales-pipelineRequest Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Pipeline title (max 191 characters) |
status | integer | No | 0 Draft, 1 Publish (not validated) |
Six default stages are created with the pipeline: Prospecting, Qualification, Proposal/Quotation, Negotiation/Review, Closed/Won and Closed/Lost.
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Enterprise Sales Pipeline",
"status": 1
}'Example Response
{
"msg": "Sales Pipeline stored successfully.",
"data": {
"title": "Enterprise Sales Pipeline",
"status": 1,
"uuid": "pipeline-xyz789abc123",
"created_at": "just now",
"stages_count": null
}
}The response status is 201.
Error Responses
| Status | Description |
|---|---|
403 | The user does not have permission to create sales pipelines |
422 | Validation failed: { "error": { "title": ["..."] } } |
Get a Specific Sales Pipeline
Retrieve detailed information about a specific sales pipeline.
GET /api/public-v1/sales-pipeline/{uuid}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json"Example Response
The response is the pipeline object itself (no data wrapper).
{
"title": "Main Sales Pipeline",
"status": 1,
"uuid": "pipeline-abc123def456",
"created_at": "2 weeks ago",
"stages": [
{
"id": 1,
"title": "Prospecting",
"order": 1,
"color": "slate",
"created_at": "2 weeks ago"
},
{
"id": 2,
"title": "Qualification",
"order": 2,
"color": "yellow",
"created_at": "2 weeks ago"
}
]
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "pipeline not found" }. The pipeline does not exist or is not visible to the user |
Complex Module: Sales Pipeline is the most comprehensive API module with 60+ endpoints. Each sub-module (Deals, Stages, Tasks, etc.) provides full CRUD operations and specialized actions.
Next: Sub-Module Documentation
The Sales Pipeline API includes several specialized sub-modules, documented below:
- Deals Management - Individual deal lifecycle
- Stage Management - Pipeline stage configuration
- Task Management - Deal-specific tasks
- File Management - Document handling
- Meeting Management - Meeting scheduling
- Note Management - Deal notes
- Activity Management - Activity logging
- Attribute Management - Custom attributes
Update a Sales Pipeline
Update the title of an existing sales pipeline. PUT and PATCH are handled identically: the request is validated like Create a Sales Pipeline, so title is required, and only title is written (status is ignored on update).
PUT /api/public-v1/sales-pipeline/{uuid}
PATCH /api/public-v1/sales-pipeline/{uuid}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Pipeline title (max 191 characters) |
Example Request
curl -X PUT "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Updated Sales Pipeline"
}'Example Response
{
"msg": "Pipeline Updated Successfully",
"data": {
"title": "Updated Sales Pipeline",
"status": 1,
"uuid": "pipeline-abc123def456",
"created_at": "2 weeks ago",
"stages_count": null
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "pipeline not found" } |
422 | Validation failed: { "error": { "title": ["..."] } } |
Delete a Sales Pipeline
Delete a specific sales pipeline.
DELETE /api/public-v1/sales-pipeline/{uuid}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
Example Request
curl -X DELETE "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "pipeline deleted successfully."
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "pipeline not found" } |
422 | { "msg": "You don't have permission to delete this sales pipeline." } |
Pipeline Bulk Actions
Delete multiple sales pipelines in one request.
POST /api/public-v1/sales-pipeline/bulk-actionsRequest Body
| Field | Type | Required | Description |
|---|---|---|---|
ids | array | Yes | Pipeline numeric IDs (max 1000). Each must exist in sales_pipelines |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/bulk-actions" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"ids": [
1,
2,
3
]
}'Example Response
{
"msg": "Sales pipeline bulk actions successful"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "pipeline not found" } |
422 | Validation failed (standard Laravel shape: { "message": "...", "errors": { "ids": ["..."] } }) |
Deals Management
Manage individual deals within sales pipelines.
Deals Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
GET | /api/public-v1/sales-pipeline/{uuid}/deals | Get deals of a stage |
POST | /api/public-v1/sales-pipeline/{uuid}/deals | Create a new deal |
GET | /api/public-v1/sales-pipeline/{uuid}/deals/{id} | Get a specific deal |
PUT / PATCH | /api/public-v1/sales-pipeline/{uuid}/deals/{id} | Update a deal |
DELETE | /api/public-v1/sales-pipeline/{uuid}/deals/{id} | Delete a deal |
POST | /api/public-v1/sales-pipeline/{uuid}/deals/bulk-actions/{id} | Delete a deal (bulk-actions alias) |
POST | /api/public-v1/sales-pipeline/{uuid}/deals/order-change | Change deal order / stage |
Get All Deals
Retrieve the deals of one stage of a pipeline, ordered by deal order.
GET /api/public-v1/sales-pipeline/{uuid}/dealsPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
deal_stage_id | integer | Yes | Stage ID (must belong to the pipeline) |
item | integer | No | Deals per page (default: 10). 0 returns all |
page | integer | No | Page number |
search | string | No | Search in deal name |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deals?deal_stage_id=2" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "Sales Pipeline Deals retrieved successfully",
"data": [
{
"id": 156,
"uuid": "3f6c9a1e-2b7d-4e0a-9c11-5d8e7f1a2b33",
"deal_name": "Website Development Deal",
"company": {
"id": 25,
"name": "Tech Solutions Ltd",
"email": "info@techsolutions.com"
},
"contact": {
"id": 15,
"user_id": 40,
"name": "John Smith",
"email": "john@techsolutions.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000040",
"type": 2,
"image": null,
"phone_number": "+15550100",
"reference": null,
"reference_name": null
},
"lead": null,
"deal_stage_id": 2,
"deal_amount": 15000,
"deal_status": 0,
"closing_date": "15/02/24",
"description": "Complete website development project",
"documents": [],
"files": [],
"status": 1,
"currency": "USD",
"order": 1,
"priority": 0,
"lead_type": 0,
"created_at": "15/02/24",
"pipeline_uuid": "pipeline-abc123def456",
"deal_owner": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"stages": {
"id": 2,
"title": "Qualification",
"order": 2,
"color": "yellow",
"created_at": "2 weeks ago"
},
"tags": [],
"custom_fields": []
}
],
"links": {
"first": "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deals?page=1",
"last": "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deals?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deals",
"per_page": 10,
"to": 1,
"total": 1
}
}Error Responses
| Status | Description |
|---|---|
422 | { "error": { "msg": ["pipeline not found"] } } or ["stage not found"]; missing deal_stage_id returns the standard Laravel validation shape |
Create a Deal
Create a new deal in a sales pipeline.
POST /api/public-v1/sales-pipeline/{uuid}/dealsPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
deal_name | string | Yes | Deal name (max 191 characters) |
deal_owner_id | integer | Yes | Deal owner user ID |
deal_stage_id | integer | Yes | Stage ID the deal belongs to |
contact_id | integer | Conditional | Contact ID. Either contact_id or lead_id is required |
lead_id | integer | Conditional | Lead ID. Either contact_id or lead_id is required |
company_id | integer | No | Company ID |
deal_amount | integer | No | Deal amount (default: 0) |
deal_status | integer | No | 0 Open (default), 1 Negotiation, 2 Won, 3 Lost |
closing_date | string | No | Closing date |
description | string | No | Deal description |
currency | string | No | Currency code |
status | integer | No | Deal status flag (default: 1) |
priority | integer | No | Priority (default: 0) |
lead_type | integer | No | 0 Cold (default), 1 Warm, 2 Hot |
tags | array | No | Array of sales pipeline attribute IDs |
documents | array | No | Array of document IDs |
from_email | string | No | From email |
custom_fields | array | No | Custom field values |
invite_client | boolean | No | Send a portal invitation to the contact (create only effect) |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deals" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"deal_name": "Website Development Deal",
"company_id": 25,
"deal_owner_id": 8,
"contact_id": 15,
"deal_stage_id": 2,
"deal_amount": 15000,
"deal_status": 0,
"closing_date": "2024-02-15",
"description": "Complete website development project",
"tags": [
4
]
}'Example Response
{
"msg": "Deal Added Successfully",
"data": {
"id": 156,
"uuid": "3f6c9a1e-2b7d-4e0a-9c11-5d8e7f1a2b33",
"deal_name": "Website Development Deal",
"company": {
"id": 25,
"name": "Tech Solutions Ltd",
"email": "info@techsolutions.com"
},
"contact": {
"id": 15,
"user_id": 40,
"name": "John Smith",
"email": "john@techsolutions.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000040",
"type": 2,
"image": null,
"phone_number": "+15550100",
"reference": null,
"reference_name": null
},
"lead": null,
"deal_stage_id": 2,
"deal_amount": 15000,
"deal_status": 0,
"closing_date": "15/02/24",
"description": "Complete website development project",
"documents": [],
"files": [],
"status": 1,
"currency": "USD",
"order": 1,
"priority": 0,
"lead_type": 0,
"created_at": "15/02/24",
"pipeline_uuid": "pipeline-abc123def456",
"deal_owner": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"stages": {
"id": 2,
"title": "Qualification",
"order": 2,
"color": "yellow",
"created_at": "2 weeks ago"
},
"tags": [],
"custom_fields": []
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "pipeline not found" } |
422 | Validation failed: { "error": { "<field>": ["message"] } } |
Get a Specific Deal
Retrieve details of a specific deal, including its tasks, meetings, activities and notes. The deal must belong to the pipeline in the URL, otherwise a 404 is returned.
GET /api/public-v1/sales-pipeline/{uuid}/deals/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deals/156" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"pipeline_title": "Main Sales Pipeline",
"data": {
"id": 156,
"deal_name": "Website Development Deal",
"company": {
"id": 25,
"name": "Tech Solutions Ltd",
"email": "info@techsolutions.com"
},
"contact": {
"id": 15,
"user_id": 40,
"name": "John Smith",
"email": "john@techsolutions.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000040",
"type": 2,
"image": null,
"phone_number": "+15550100",
"reference": null,
"reference_name": null
},
"deal_stage_id": 2,
"deal_amount": 15000,
"deal_status": 0,
"closing_date": "15/02/24",
"description": "Complete website development project",
"status": 1,
"currency": "USD",
"order": 1,
"created_at": "15/02/24",
"email_sequence": null,
"deal_owner": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"meetings": [],
"activities": [],
"notes": [],
"tasks": [],
"tags": [],
"documents": [],
"files": []
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Pipeline not found" } or { "msg": "Deal not found" } |
Update a Deal
Update an existing deal. PUT and PATCH are handled identically and the deal must belong to the pipeline in the URL. The body is validated like Create a Deal, so deal_name, deal_owner_id, deal_stage_id and contact_id / lead_id (at least one of the two) must always be sent. The remaining optional fields are partial: company_id, contact_id, lead_id, deal_amount, deal_status, closing_date, description, currency, status, from_email, priority, lead_type, tags and documents keep their stored values when omitted. Send tags or documents as an empty array to remove them all.
PUT /api/public-v1/sales-pipeline/{uuid}/deals/{id}
PATCH /api/public-v1/sales-pipeline/{uuid}/deals/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
deal_name | string | Yes | Deal name (max 191 characters) |
deal_owner_id | integer | Yes | Deal owner user ID |
deal_stage_id | integer | Yes | Stage ID the deal belongs to |
contact_id | integer | Conditional | Contact ID. Either contact_id or lead_id must be sent; the one that is omitted keeps its stored value |
lead_id | integer | Conditional | Lead ID. Either contact_id or lead_id must be sent; the one that is omitted keeps its stored value |
company_id | integer | No | Company ID. Keeps the stored value when omitted |
deal_amount | integer | No | Deal amount. Keeps the stored value when omitted |
deal_status | integer | No | 0 Open, 1 Negotiation, 2 Won, 3 Lost. Keeps the stored value when omitted |
closing_date | string | No | Closing date. Keeps the stored value when omitted |
description | string | No | Deal description. Keeps the stored value when omitted |
currency | string | No | Currency code. Keeps the stored value when omitted |
status | integer | No | Deal status flag. Keeps the stored value when omitted |
priority | integer | No | Priority. Keeps the stored value when omitted |
lead_type | integer | No | 0 Cold, 1 Warm, 2 Hot. Keeps the stored value when omitted |
tags | array | No | Array of sales pipeline attribute IDs. Keeps the stored tags when omitted |
documents | array | No | Array of document IDs. Keeps the stored documents when omitted |
from_email | string | No | From email. Keeps the stored value when omitted |
custom_fields | array | No | Custom field values |
invite_client | boolean | No | Send a portal invitation to the contact (create only effect) |
Example Request
curl -X PUT "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deals/156" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"deal_name": "Updated Website Development Deal",
"deal_owner_id": 8,
"contact_id": 15,
"deal_stage_id": 3,
"deal_amount": 18000,
"tags": [
4
]
}'Example Response
{
"msg": "Deal Updated Successfully",
"data": {
"id": 156,
"uuid": "3f6c9a1e-2b7d-4e0a-9c11-5d8e7f1a2b33",
"deal_name": "Updated Website Development Deal",
"company": {
"id": 25,
"name": "Tech Solutions Ltd",
"email": "info@techsolutions.com"
},
"contact": {
"id": 15,
"user_id": 40,
"name": "John Smith",
"email": "john@techsolutions.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000040",
"type": 2,
"image": null,
"phone_number": "+15550100",
"reference": null,
"reference_name": null
},
"lead": null,
"deal_stage_id": 3,
"deal_amount": 18000,
"deal_status": 0,
"closing_date": "15/02/24",
"description": "Complete website development project",
"documents": [],
"files": [],
"status": 1,
"currency": "USD",
"order": 1,
"priority": 0,
"lead_type": 0,
"created_at": "15/02/24",
"pipeline_uuid": "pipeline-abc123def456",
"deal_owner": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"stages": {
"id": 2,
"title": "Qualification",
"order": 2,
"color": "yellow",
"created_at": "2 weeks ago"
},
"tags": [],
"custom_fields": []
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Pipeline not found" } or { "msg": "Deal not found" } |
422 | Validation failed: { "error": { "<field>": ["message"] } } |
Delete a Deal
Delete a specific deal. The stage the deal currently belongs to must be supplied.
DELETE /api/public-v1/sales-pipeline/{uuid}/deals/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
deal_stage_id | integer | Yes | Current stage ID of the deal (query string or body) |
Example Request
curl -X DELETE "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deals/156?deal_stage_id=2" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "Deal Deleted"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Pipeline not found" } or { "msg": "Deal not found" } |
422 | { "error": { "msg": ["stage id is required"] } } or a permission message |
Deals Bulk Actions
Behaves exactly like Delete a Deal for the single deal in the path, using POST.
POST /api/public-v1/sales-pipeline/{uuid}/deals/bulk-actions/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
deal_stage_id | integer | Yes | Current stage ID of the deal |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deals/bulk-actions/156" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"deal_stage_id": 2
}'Example Response
{
"msg": "Deal Deleted"
}Change Deals Order
Set the order of deals and move them into a stage. Every listed deal is assigned to stage_id.
POST /api/public-v1/sales-pipeline/{uuid}/deals/order-changePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
stage_id | integer | Yes | Stage the deals are placed in |
order | array | Yes | Array of { "item_id": <deal ID>, "order": <position> } objects |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deals/order-change" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"stage_id": 3,
"order": [
{
"item_id": 156,
"order": 1
},
{
"item_id": 157,
"order": 2
}
]
}'Example Response
{
"msg": "Deal Order Changed",
"status": 200
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Pipeline not found" } |
422 | Validation failed (standard Laravel shape: { "message": "...", "errors": { ... } }) |
Stage Management
Get All Stages
Retrieve all stages of a pipeline with their deals, ordered by stage order.
GET /api/public-v1/sales-pipeline/{uuid}/stagePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
item | integer | No | Stages per page (default: 10) |
page | integer | No | Page number |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"data": [
{
"id": 2,
"title": "Qualification",
"order": 2,
"color": "yellow",
"created_at": "2 weeks ago",
"deals": [
{
"id": 156,
"uuid": "3f6c9a1e-2b7d-4e0a-9c11-5d8e7f1a2b33",
"deal_name": "Website Development Deal",
"company": {
"id": 25,
"name": "Tech Solutions Ltd",
"email": "info@techsolutions.com"
},
"contact": {
"id": 15,
"user_id": 40,
"name": "John Smith",
"email": "john@techsolutions.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000040",
"type": 2,
"image": null,
"phone_number": "+15550100",
"reference": null,
"reference_name": null
},
"lead": null,
"deal_stage_id": 2,
"deal_amount": 15000,
"deal_status": 0,
"closing_date": "15/02/24",
"description": "Complete website development project",
"documents": [],
"files": [],
"status": 1,
"currency": "USD",
"order": 1,
"priority": 0,
"lead_type": 0,
"created_at": "15/02/24",
"pipeline_uuid": "pipeline-abc123def456",
"deal_owner": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"stages": {
"id": 2,
"title": "Qualification",
"order": 2,
"color": "yellow",
"created_at": "2 weeks ago"
},
"tags": [],
"custom_fields": []
}
],
"deals_count": 1
}
],
"links": {
"first": "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage?page=1",
"last": "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage",
"per_page": 10,
"to": 1,
"total": 1
}
}There is no endpoint to retrieve a single stage; use this list.
Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } |
Create a Stage
Create a new stage in a pipeline.
POST /api/public-v1/sales-pipeline/{uuid}/stagePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Stage title (max 191 characters) |
order | integer | No | Stage order |
color | string | No | Stage color name or value |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Contract Sent",
"color": "blue",
"order": 5
}'Example Response
{
"msg": "Pipeline Stage Added Successfully",
"data": {
"id": 9,
"title": "Contract Sent",
"order": 5,
"color": "blue",
"created_at": "just now",
"deals": [],
"deals_count": null
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } |
422 | Validation failed: { "error": { "title": ["..."] } } |
Update a Stage
Update a stage. PUT and PATCH are handled identically: title is required. color and order are only changed when sent with a non-empty value.
PUT /api/public-v1/sales-pipeline/{uuid}/stage/{id}
PATCH /api/public-v1/sales-pipeline/{uuid}/stage/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Stage ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Stage title (max 191 characters) |
order | integer | No | Stage order |
color | string | No | Stage color |
Example Request
curl -X PUT "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage/2" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Qualified Leads",
"color": "green"
}'Example Response
{
"msg": "Pipeline Stage Updated Successfully",
"data": {
"id": 2,
"title": "Qualified Leads",
"order": 2,
"color": "green",
"created_at": "2 weeks ago",
"deals": [],
"deals_count": null
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "pipeline stage not found" } |
422 | Validation failed: { "error": { "title": ["..."] } } |
Delete a Stage
Delete a stage.
DELETE /api/public-v1/sales-pipeline/{uuid}/stage/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Stage ID |
Example Request
curl -X DELETE "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage/2" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "Pipeline Stage Deleted"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "pipeline stage not found" } |
500 | { "msg": "Failed to delete sales pipeline stage" } when the deletion throws an error |
Change Stage Order
Update the order of several stages.
POST /api/public-v1/sales-pipeline/{uuid}/stage/order-changePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
order | array | Yes | Array of { "stage_id": <stage ID>, "order": <position> } objects |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage/order-change" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"order": [
{
"stage_id": 1,
"order": 2
},
{
"stage_id": 2,
"order": 1
}
]
}'Example Response
{
"msg": "Order changed"
}Error Responses
| Status | Description |
|---|---|
200 | { "msg": "Failed to update order stage" } when a stage in the list does not belong to the pipeline |
422 | { "error": { "msg": ["Order field is required"] } } |
Duplicate Stage
Duplicate a stage, optionally with its deals.
POST /api/public-v1/sales-pipeline/{uuid}/stage/{id}/duplicatePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Stage ID to duplicate |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
with_content | boolean | No | Also duplicate the stage content (deals) |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage/2/duplicate" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"with_content": true
}'Example Response
{
"msg": "SalesPipeline Stage Duplicated Successfully",
"data": {
"id": 10,
"title": "Qualification",
"order": 7,
"color": "yellow",
"created_at": "just now",
"deals": [],
"deals_count": null
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } |
422 | { "error": { "msg": ["Stage not found"] } } |
Move All Deals
Move all deals of a stage into another stage. The target stage must belong to the same pipeline.
POST /api/public-v1/sales-pipeline/{uuid}/stage/{id}/move-all-dealPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Source stage ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
deal_stage_id | integer | Yes | Target stage ID. Must be a stage of the same pipeline |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage/2/move-all-deal" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"deal_stage_id": 3
}'Example Response
{
"msg": "Pipeline Stage Move All Deal Successfully"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Stages id is required" } (missing deal_stage_id) or { "msg": "Sales Pipeline not found" } |
422 | { "msg": "Target stage not found" } when deal_stage_id is not a stage of this pipeline |
Stage Bulk Actions
Delete several stages in one request.
POST /api/public-v1/sales-pipeline/{uuid}/stage/bulk-actionsPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
ids | array | Yes | Stage IDs to delete |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/stage/bulk-actions" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"ids": [
7,
8
]
}'Example Response
(empty body)On success the response is 200 with an empty body.
Error Responses
| Status | Description |
|---|---|
422 | { "error": { "msg": ["Please select at least one stage"] } }, or the error of the first stage that could not be deleted |
Task Management
Get All Tasks
Retrieve all tasks of a deal, newest first. The result is not paginated.
GET /api/public-v1/sales-pipeline/{uuid}/deal/{id}/taskPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/task" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"data": [
{
"id": 12,
"title": "Follow up with client",
"deal_id": 156,
"type": 1,
"due_date": "2024-02-15",
"due_time": "14:30:00",
"priority": 2,
"description": "Call client to discuss project requirements",
"is_completed": false,
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignees": [],
"reminder": {
"id": 3,
"type": 1,
"date": null,
"time": null
},
"repeat": null
}
]
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } |
Create a Task
Create a task for a deal.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/taskPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Task title (max 191 characters) |
type | integer | Yes | 0 Todo, 1 Call, 2 Email, 3 SMS |
assignee_id | integer | Yes | Assignee user ID |
priority | integer | Yes | 0 Low, 1 Medium, 2 High, 3 Urgent |
due_date | string | No | Due date (for example 2024-02-15) |
due_time | string | Conditional | Required when due_date is sent (for example 14:30) |
description | string | No | Task description |
repeat | integer | No | 0 every week, 1 every two weeks, 2 every month, 3 every three months, 4 every four months, 5 every six months, 6 every year |
repeat_until | string | Conditional | Required when repeat is sent |
repeat_day | integer | No | Day of month, 1-28 |
reminder | integer | No | 0 at due time, 1 30 minutes before, 2 1 hour before, 3 1 day before, 4 1 week before, 5 custom date |
reminder_date | string | No | Reminder date (custom reminder) |
reminder_time | string | No | Reminder time (custom reminder) |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/task" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Follow up with client",
"type": 1,
"assignee_id": 8,
"priority": 2,
"due_date": "2024-02-15",
"due_time": "14:30",
"description": "Call client to discuss project requirements",
"reminder": 1
}'Example Response
{
"msg": "Deal Task Added Successfully",
"data": {
"id": 12,
"title": "Follow up with client",
"deal_id": 156,
"type": 1,
"due_date": "2024-02-15",
"due_time": "14:30:00",
"priority": 2,
"description": "Call client to discuss project requirements",
"is_completed": false,
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignees": [],
"reminder": {
"id": 3,
"type": 1,
"date": null,
"time": null
},
"repeat": null
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
422 | Validation failed: { "error": { "<field>": ["message"] } } |
Get a Specific Task
Retrieve a specific task.
GET /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
task_id | integer | Yes | Task ID |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/task/12" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"id": 12,
"title": "Follow up with client",
"deal_id": 156,
"type": 1,
"due_date": "2024-02-15",
"due_time": "14:30:00",
"priority": 2,
"description": "Call client to discuss project requirements",
"is_completed": false,
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignees": [],
"reminder": {
"id": 3,
"type": 1,
"date": null,
"time": null
},
"repeat": null
}Note: The response is the task object itself (no
datawrapper).
Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "task not found" } |
Update a Task
Update a task. PUT and PATCH are handled identically: the body is validated like Create a Task, so title, type, assignee_id and priority must always be sent. type is not changed by an update. Sending repeat creates or updates the repeat settings; omitting it removes them. reminder is only changed when sent.
PUT /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id}
PATCH /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
task_id | integer | Yes | Task ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Task title (max 191 characters) |
type | integer | Yes | 0 Todo, 1 Call, 2 Email, 3 SMS |
assignee_id | integer | Yes | Assignee user ID |
priority | integer | Yes | 0 Low, 1 Medium, 2 High, 3 Urgent |
due_date | string | No | Due date (for example 2024-02-15) |
due_time | string | Conditional | Required when due_date is sent (for example 14:30) |
description | string | No | Task description |
repeat | integer | No | 0 every week, 1 every two weeks, 2 every month, 3 every three months, 4 every four months, 5 every six months, 6 every year |
repeat_until | string | Conditional | Required when repeat is sent |
repeat_day | integer | No | Day of month, 1-28 |
reminder | integer | No | 0 at due time, 1 30 minutes before, 2 1 hour before, 3 1 day before, 4 1 week before, 5 custom date |
reminder_date | string | No | Reminder date (custom reminder) |
reminder_time | string | No | Reminder time (custom reminder) |
Example Request
curl -X PUT "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/task/12" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Follow up with client (updated)",
"type": 1,
"assignee_id": 8,
"priority": 3,
"due_date": "2024-02-16",
"due_time": "10:00"
}'Example Response
{
"msg": "Task Updated Successfully",
"data": {
"id": 12,
"title": "Follow up with client (updated)",
"deal_id": 156,
"type": 1,
"due_date": "2024-02-16",
"due_time": "10:00:00",
"priority": 3,
"description": "Call client to discuss project requirements",
"is_completed": false,
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignees": [],
"reminder": {
"id": 3,
"type": 1,
"date": null,
"time": null
},
"repeat": null
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "task not found" } |
422 | Validation failed: { "error": { "<field>": ["message"] } } |
Delete a Task
Delete a task.
DELETE /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
task_id | integer | Yes | Task ID |
Example Request
curl -X DELETE "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/task/12" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "Task Deleted"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "task not found" } |
Task Bulk Actions
Delete several tasks of the deal in one request. Only tasks that belong to the deal in the URL are deleted; IDs of other deals’ tasks are ignored.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/bulk-actionsPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
ids | array | Yes | Task IDs to delete |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/task/bulk-actions" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"ids": [
12,
13
]
}'Example Response
{
"msg": "Tasks deleted successfully"
}Error Responses
| Status | Description |
|---|---|
400 | { "msg": "No task selected" } when none of the IDs is a task of this deal |
Change Task Order
Change the order value of a task.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id}/order-changePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
task_id | integer | Yes | Task ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
order | integer | Yes | New order value |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/task/12/order-change" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"order": 3
}'Example Response
{
"msg": "Task Updated Successfully",
"data": {
"id": 12,
"title": "Follow up with client",
"deal_id": 156,
"type": 1,
"due_date": "2024-02-15",
"due_time": "14:30:00",
"priority": 2,
"description": "Call client to discuss project requirements",
"is_completed": false,
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignees": [],
"reminder": {
"id": 3,
"type": 1,
"date": null,
"time": null
},
"repeat": null
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "task not found" } |
422 | { "error": { "msg": ["Order field is required"] } } |
Complete Task
Mark a task as completed or not completed.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/task/{task_id}/completePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
task_id | integer | Yes | Task ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
is_completed | integer | Yes | 1 to complete, 0 to reopen |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/task/12/complete" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"is_completed": 1
}'Example Response
{
"msg": "Task Updated Successfully",
"data": {
"id": 12,
"title": "Follow up with client",
"deal_id": 156,
"type": 1,
"due_date": "2024-02-15",
"due_time": "14:30:00",
"priority": 2,
"description": "Call client to discuss project requirements",
"is_completed": 1,
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignees": [],
"reminder": {
"id": 3,
"type": 1,
"date": null,
"time": null
},
"repeat": null
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "task not found" } |
422 | { "error": { "msg": ["is completed field is required"] } } |
File Management
Get All Files
Retrieve all files attached to a deal.
GET /api/public-v1/sales-pipeline/{uuid}/deal/{id}/filePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/file" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "Deal file added",
"data": [
{
"deal_id": 156,
"media": {
"id": 12,
"title": "proposal.pdf",
"ext": "pdf",
"size": 204800,
"url": "https://storage.taskip.net/tenant-123/files/proposal.pdf",
"media_type": "file",
"createdAt": "15-02-2024 10:30:15"
}
}
],
"status": 200
}The msg value of this response is Deal file added, as returned by the API.
Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
Upload a File
Attach an already uploaded media file to a deal.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/filePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
file_id | integer | Yes | ID of an uploaded media file |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/file" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"file_id": 12
}'Example Response
{
"msg": "Deal file added",
"data": {
"deal_id": 156,
"media": {
"id": 12,
"title": "proposal.pdf",
"ext": "pdf",
"size": 204800,
"url": "https://storage.taskip.net/tenant-123/files/proposal.pdf",
"media_type": "file",
"createdAt": "15-02-2024 10:30:15"
}
},
"status": 200
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
Delete a File
Delete a file from a deal. The file is also removed from storage.
DELETE /api/public-v1/sales-pipeline/{uuid}/deal/{id}/file/{file}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
file | integer | Yes | Required by the route but not used; any value works |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
file_id | integer | Yes | ID of the media file to delete (query string or body) |
Example Request
curl -X DELETE "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/file/12?file_id=12" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "Deal file deleted",
"status": 200
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "file not found" }, { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
Meeting Management
Get All Meetings
Retrieve all meetings of a deal, newest first. The result is not paginated.
GET /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meetingPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/meeting" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"data": [
{
"id": 7,
"title": "Project kickoff",
"deal": 156,
"type": 2,
"description": "Discuss scope and timeline",
"priority": 1,
"duration": 1,
"notify_client": true,
"meeting_day": "Thursday",
"date": "February 15, 2024",
"time_slot_start": "10:00",
"time_slot_end": "10:30",
"created_at": "1 day ago",
"assignee_id": 8,
"location": null,
"phone_number": null,
"meeting_url": "https://meet.google.com/abc-defg-hij",
"google_meet_integration_id": 3,
"assignee": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"reminder": null,
"is_completed": false,
"completed_at": null,
"participants": [],
"call_type": null,
"relation_to": null,
"repeat": false,
"repeat_frequency": null,
"repeat_until": null,
"repeat_until_date": null
}
]
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } |
Create a Meeting
Create a meeting for a deal.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meetingPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Meeting title (max 191 characters) |
type | integer | Yes | 0 In person, 1 Phone call, 2 Google Meet, 3 Zoom |
assignee_id | integer | Yes | Assignee user ID |
priority | integer | Yes | 0 Low, 1 Medium, 2 High, 3 Urgent |
duration | integer | Yes | 0 15 minutes, 1 30 minutes, 2 1 hour |
notify_client | boolean | Yes | Notify the client |
location | string | Conditional | Required when type = 0 |
phone_number | string | Conditional | Required when type = 1 |
google_meet_integration_id | integer | Conditional | Required when type = 2 |
description | string | No | Meeting description |
date | string | No | Meeting date |
time_slot_start | string | No | Start time |
time_slot_end | string | No | End time |
is_completed | boolean | No | Completion flag |
reminder | integer | No | 0 10 minutes before, 1 30 minutes before, 2 1 hour before, 3 1 day before |
reminder_date | string | No | Reminder date |
reminder_time | string | No | Reminder time |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/meeting" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Project kickoff",
"type": 2,
"assignee_id": 8,
"priority": 1,
"duration": 1,
"notify_client": true,
"google_meet_integration_id": 3,
"date": "2024-02-15",
"time_slot_start": "10:00",
"time_slot_end": "10:30"
}'Example Response
{
"msg": "Meeting Added successfully",
"data": {
"id": 7,
"title": "Project kickoff",
"deal": 156,
"type": 2,
"description": "Discuss scope and timeline",
"priority": 1,
"duration": 1,
"notify_client": true,
"meeting_day": "Thursday",
"date": "February 15, 2024",
"time_slot_start": "10:00",
"time_slot_end": "10:30",
"created_at": "1 day ago",
"assignee_id": 8,
"location": null,
"phone_number": null,
"meeting_url": "https://meet.google.com/abc-defg-hij",
"google_meet_integration_id": 3,
"assignee": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"reminder": null,
"is_completed": false,
"completed_at": null,
"participants": [],
"call_type": null,
"relation_to": null,
"repeat": false,
"repeat_frequency": null,
"repeat_until": null,
"repeat_until_date": null
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
422 | Validation failed: { "error": { "<field>": ["message"] } } |
Get a Specific Meeting
Retrieve a specific meeting. The response is the meeting object itself (no data wrapper).
GET /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/{meeting_id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
meeting_id | integer | Yes | Meeting ID |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/meeting/7" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"id": 7,
"title": "Project kickoff",
"deal": 156,
"type": 2,
"description": "Discuss scope and timeline",
"priority": 1,
"duration": 1,
"notify_client": true,
"meeting_day": "Thursday",
"date": "February 15, 2024",
"time_slot_start": "10:00",
"time_slot_end": "10:30",
"created_at": "1 day ago",
"assignee_id": 8,
"location": null,
"phone_number": null,
"meeting_url": "https://meet.google.com/abc-defg-hij",
"google_meet_integration_id": 3,
"assignee": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"reminder": null,
"is_completed": false,
"completed_at": null,
"participants": [],
"call_type": null,
"relation_to": null,
"repeat": false,
"repeat_frequency": null,
"repeat_until": null,
"repeat_until_date": null
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "task not found" } (meeting not found) |
Update a Meeting
Update a meeting. PUT and PATCH are handled identically: the body is validated like Create a Meeting, so all required fields must be sent.
PUT /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/{meeting_id}
PATCH /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/{meeting_id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
meeting_id | integer | Yes | Meeting ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Meeting title (max 191 characters) |
type | integer | Yes | 0 In person, 1 Phone call, 2 Google Meet, 3 Zoom |
assignee_id | integer | Yes | Assignee user ID |
priority | integer | Yes | 0 Low, 1 Medium, 2 High, 3 Urgent |
duration | integer | Yes | 0 15 minutes, 1 30 minutes, 2 1 hour |
notify_client | boolean | Yes | Notify the client |
location | string | Conditional | Required when type = 0 |
phone_number | string | Conditional | Required when type = 1 |
google_meet_integration_id | integer | Conditional | Required when type = 2 |
description | string | No | Meeting description |
date | string | No | Meeting date |
time_slot_start | string | No | Start time |
time_slot_end | string | No | End time |
is_completed | boolean | No | Completion flag |
reminder | integer | No | 0 10 minutes before, 1 30 minutes before, 2 1 hour before, 3 1 day before |
reminder_date | string | No | Reminder date |
reminder_time | string | No | Reminder time |
Example Request
curl -X PUT "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/meeting/7" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Project kickoff (rescheduled)",
"type": 2,
"assignee_id": 8,
"priority": 1,
"duration": 1,
"notify_client": true,
"google_meet_integration_id": 3,
"date": "2024-02-15",
"time_slot_start": "11:00",
"time_slot_end": "11:30"
}'Example Response
{
"msg": "Meeting Update successfully",
"data": {
"id": 7,
"title": "Project kickoff (rescheduled)",
"deal": 156,
"type": 2,
"description": "Discuss scope and timeline",
"priority": 1,
"duration": 1,
"notify_client": true,
"meeting_day": "Thursday",
"date": "February 15, 2024",
"time_slot_start": "10:00",
"time_slot_end": "10:30",
"created_at": "1 day ago",
"assignee_id": 8,
"location": null,
"phone_number": null,
"meeting_url": "https://meet.google.com/abc-defg-hij",
"google_meet_integration_id": 3,
"assignee": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"reminder": null,
"is_completed": false,
"completed_at": null,
"participants": [],
"call_type": null,
"relation_to": null,
"repeat": false,
"repeat_frequency": null,
"repeat_until": null,
"repeat_until_date": null
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "meeting not found" }, { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
422 | Validation failed: { "error": { "<field>": ["message"] } } |
Delete a Meeting
Delete a meeting.
DELETE /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/{meeting_id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
meeting_id | integer | Yes | Meeting ID |
Example Request
curl -X DELETE "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/meeting/7" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "Meeting Deleted"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Meeting not found" } or { "msg": "Sales Pipeline not found" } |
Meeting Bulk Actions
Delete several meetings in one request.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/bulk-actionsPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
ids | array | Yes | Meeting IDs to delete |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/meeting/bulk-actions" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"ids": [
7,
8
]
}'Example Response
{
"msg": "Meeting deleted successfully"
}Error Responses
| Status | Description |
|---|---|
400 | { "msg": "Data not found" } when ids is empty |
Complete Meeting
Mark a meeting as completed. Completing a meeting also removes its reminder.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/meeting/{meeting_id}/completePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
meeting_id | integer | Yes | Meeting ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
is_completed | integer | Yes | 1 to complete, 0 to mark as not completed |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/meeting/7/complete" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"is_completed": 1
}'Example Response
{
"msg": "Meeting Marked Completed",
"data": {
"id": 7,
"title": "Project kickoff",
"deal": 156,
"type": 2,
"description": "Discuss scope and timeline",
"priority": 1,
"duration": 1,
"notify_client": true,
"meeting_day": "Thursday",
"date": "February 15, 2024",
"time_slot_start": "10:00",
"time_slot_end": "10:30",
"created_at": "1 day ago",
"assignee_id": 8,
"location": null,
"phone_number": null,
"meeting_url": "https://meet.google.com/abc-defg-hij",
"google_meet_integration_id": 3,
"assignee": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"assignedBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"reminder": null,
"is_completed": true,
"completed_at": "2024-02-15T10:35:00.000000Z",
"participants": [],
"call_type": null,
"relation_to": null,
"repeat": false,
"repeat_frequency": null,
"repeat_until": null,
"repeat_until_date": null
}
}The data object is the meeting object (same shape as Create a Meeting). Send is_completed as 0 to mark the meeting as not completed again; the message is then Meeting Marked Incomplete and completed_at is null.
Error Responses
| Status | Description |
|---|---|
404 | { "msg": "meeting not found" } or { "msg": "Sales Pipeline not found" } |
422 | { "error": { "msg": ["is completed field is required"] } } |
Note Management
Get All Notes
Retrieve all notes of a deal, newest first. The result is not paginated. There is no endpoint to retrieve a single note.
GET /api/public-v1/sales-pipeline/{uuid}/deal/{id}/notePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/note" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"data": [
{
"id": 9,
"description": "Client prefers email contact",
"createdBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"createdAt": "Thu 02 2024 10:15AM"
}
]
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } |
Create a Note
Add a note to a deal.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/notePath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
description | string | Yes | Note text |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/note" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"description": "Client prefers email contact"
}'Example Response
{
"msg": "Notes Added Successfully",
"data": {
"id": 9,
"description": "Client prefers email contact",
"createdBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"createdAt": "Thu 02 2024 10:15AM"
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
422 | Validation failed: { "error": { "description": ["..."] } } |
Update a Note
Update a note. Only the user who created the note can update it. PUT and PATCH are handled identically.
PUT /api/public-v1/sales-pipeline/{uuid}/deal/{id}/note/{note_id}
PATCH /api/public-v1/sales-pipeline/{uuid}/deal/{id}/note/{note_id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
note_id | integer | Yes | Note ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
description | string | Yes | New note text |
Example Request
curl -X PUT "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/note/9" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"description": "Client prefers phone contact"
}'Example Response
{
"msg": "Notes Updated Successfully",
"data": {
"id": 9,
"description": "Client prefers phone contact",
"createdBy": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"createdAt": "Thu 02 2024 10:15AM"
}
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Note not found" }, { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
422 | { "msg": "You can only edit your own note" } |
Delete a Note
Delete a note. Only the user who created the note can delete it.
DELETE /api/public-v1/sales-pipeline/{uuid}/deal/{id}/note/{note_id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
note_id | integer | Yes | Note ID |
Example Request
curl -X DELETE "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/note/9" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "Notes Deleted Successfully"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Note not found" }, { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
422 | { "msg": "You can only edit your own note" } |
Note Bulk Actions
Delete several notes of a deal in one request.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/note/bulk-actionsPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
ids | array | Yes | Note IDs to delete |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/note/bulk-actions" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"ids": [
9,
10
]
}'Example Response
{
"msg": "Notes Deleted Successfully"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Notes not found" }, { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
Activity Management
Activities are the timeline entries of a deal. Entries you create through this API are editable; entries generated by the system (task, meeting, note and deal changes) are returned by the list but belong to the system user. There is no endpoint to retrieve a single activity.
Get All Activities
Retrieve all activities of a deal, newest first. The result is not paginated.
GET /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activityPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/activity" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"data": [
{
"type": 13,
"deal_id": 156,
"time": "14:30",
"date": "2024-02-15",
"description": "Sent proposal by email",
"created_by": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"created_at": "1 hour ago",
"id": 21,
"metadata": null,
"message": null,
"editable": true
}
]
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } |
Create an Activity
Log an activity on a deal.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activityPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
type | integer | Yes | Activity type. 0 task created, 1 task updated, 2 task completed, 3 meeting created, 4 meeting updated, 5 meeting completed, 6 note created, 7 note updated, 8 log SMS, 9 log LinkedIn message, 10 log WhatsApp message, 11 log call, 12 log meeting, 13 log email, 14 others, and the other values of the activity type enum (15-37) |
description | string | Yes | Activity description |
date | string | No | Activity date |
time | string | No | Activity time |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/activity" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"type": 13,
"date": "2024-02-15",
"time": "14:30",
"description": "Sent proposal by email"
}'Example Response
{
"data": {
"type": 13,
"deal_id": 156,
"time": "14:30",
"date": "2024-02-15",
"description": "Sent proposal by email",
"created_by": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"created_at": "1 hour ago",
"id": 21,
"metadata": null,
"message": null,
"editable": true
},
"msg": "Activity log Added Successfully"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
422 | Validation failed: { "error": { "<field>": ["message"] } } |
Update an Activity
Update an activity. Only the user who created the activity can update it (otherwise 404). PUT and PATCH are handled identically: type and description are required on every call.
PUT /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity/{activity_id}
PATCH /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity/{activity_id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
activity_id | integer | Yes | Activity ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
type | integer | Yes | Activity type. 0 task created, 1 task updated, 2 task completed, 3 meeting created, 4 meeting updated, 5 meeting completed, 6 note created, 7 note updated, 8 log SMS, 9 log LinkedIn message, 10 log WhatsApp message, 11 log call, 12 log meeting, 13 log email, 14 others, and the other values of the activity type enum (15-37) |
description | string | Yes | Activity description |
date | string | No | Activity date |
time | string | No | Activity time |
Example Request
curl -X PUT "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/activity/21" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"type": 13,
"description": "Sent revised proposal by email"
}'Example Response
{
"data": {
"type": 13,
"deal_id": 156,
"time": "14:30",
"date": "2024-02-15",
"description": "Sent revised proposal by email",
"created_by": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"created_at": "1 hour ago",
"id": 21,
"metadata": null,
"message": null,
"editable": true
},
"msg": "Activity log Updated Successfully"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Activity not found" }, { "msg": "You can not edit this activity log" }, { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
422 | Validation failed: { "error": { "<field>": ["message"] } } |
Delete an Activity
Delete an activity. Only the user who created the activity can delete it.
DELETE /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity/{activity_id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
activity_id | integer | Yes | Activity ID |
Example Request
curl -X DELETE "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/activity/21" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "Activity log Deleted Successfully"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Activity not found" }, { "msg": "You can not delete this activity log" }, { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
Activity Bulk Actions
Delete several activities of a deal. All listed activities must have been created by the calling user; the request stops at the first activity that was not.
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity/bulk-actionsPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
ids | array | Yes | Activity IDs to delete |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/activity/bulk-actions" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"ids": [
21,
22
]
}'Example Response
{
"msg": "Activity log Deleted Successfully"
}Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Activity not found" }, { "msg": "You can not delete this activity log. Id is <id>" }, { "msg": "Sales Pipeline not found" } or { "msg": "Sales Pipeline Deal not found" } |
Send Activity Mail
Send an email from the workspace’s connected mailbox to a contact and log it on the deal as a Mail sent activity (type 18).
POST /api/public-v1/sales-pipeline/{uuid}/deal/{id}/activity/send-mailPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | Sales pipeline UUID |
id | integer | Yes | Deal ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
subject | string | Yes | Email subject |
from_email | string | Yes (not validated) | Connected sender address |
to_email | string | Yes (not validated) | Recipient address |
message | string | No | Email body (HTML) |
cc | string | No | Comma-separated CC addresses |
bcc | string | No | Comma-separated BCC addresses |
attachment | array | No | Attachments |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/pipeline-abc123def456/deal/156/activity/send-mail" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"subject": "Proposal",
"from_email": "sales@company.com",
"to_email": "john@techsolutions.com",
"message": "<p>Please find our proposal.</p>",
"cc": "manager@company.com"
}'Example Response
{
"data": {
"uuid": "c3d4e5f6-0000-4000-8000-000000000001",
"subject": "Proposal",
"from_email": "sales@company.com",
"to_email": "john@techsolutions.com"
},
"msg": "Message Send Successful",
"activity": {
"type": 18,
"deal_id": 156,
"time": "14:30",
"date": "2024-02-15",
"description": "Sent proposal by email",
"created_by": {
"id": 8,
"name": "Sarah Johnson",
"email": "sarah@company.com",
"uuid": "a1b2c3d4-0000-4000-8000-000000000008",
"type": 1,
"image": null
},
"created_at": "1 hour ago",
"id": 21,
"metadata": "{\"subject\":\"Proposal\",\"cc\":[\"manager@company.com\"],\"bcc\":[],\"email_body\":\"<p>Please find our proposal.</p>\",\"send_form\":\"sales@company.com\"}",
"message": null,
"editable": false
}
}data is the created inbox conversation (abbreviated above).
Error Responses
| Status | Description |
|---|---|
404 | { "msg": "Workspace Connected Mail Not Found" } or { "msg": "Workspace Not Found" } |
422 | Validation failed (standard Laravel shape) |
Attribute Management
Sales pipeline attributes are tags/labels used on deals. type values: 0 stages, 1 labels, 2 category, 3 source.
Get All Attributes
Retrieve attributes of one type, newest first. There is no endpoint to retrieve a single attribute.
GET /api/public-v1/sales-pipeline/attributesQuery Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
type | integer | Yes (in practice) | Attribute type. When omitted, no rows match |
item | integer | No | Items per page (default: 10). 0 returns all |
page | integer | No | Page number |
search | string | No | Search in attribute title |
Example Request
curl -X GET "https://public-api.taskip.net/api/public-v1/sales-pipeline/attributes?type=3" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"data": [
{
"id": 4,
"title": "Referral",
"color": "blue",
"status": null,
"type": 3
}
],
"links": {
"first": "https://public-api.taskip.net/api/public-v1/sales-pipeline/attributes?page=1",
"last": "https://public-api.taskip.net/api/public-v1/sales-pipeline/attributes?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://public-api.taskip.net/api/public-v1/sales-pipeline/attributes",
"per_page": 10,
"to": 1,
"total": 1
}
}Create an Attribute
Create a new attribute.
POST /api/public-v1/sales-pipeline/attributesRequest Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Attribute title (max 191 characters) |
color | string | Yes | Color (max 191 characters) |
type | integer | Yes | Attribute type (0-3, see above) |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/attributes" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Referral",
"color": "blue",
"type": 3
}'Example Response
{
"msg": "New Entry Added",
"data": {
"id": 4,
"title": "Referral",
"color": "blue",
"status": null,
"type": 3
}
}Error Responses
| Status | Description |
|---|---|
422 | Validation failed (standard Laravel shape: { "message": "...", "errors": { ... } }) |
Update an Attribute
Update an attribute. PUT and PATCH are handled identically: title, color and type are required on every call.
PUT /api/public-v1/sales-pipeline/attributes/{id}
PATCH /api/public-v1/sales-pipeline/attributes/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Attribute ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Attribute title (max 191 characters) |
color | string | Yes | Color (max 191 characters) |
type | integer | Yes | Attribute type (0-3, see above) |
Example Request
curl -X PUT "https://public-api.taskip.net/api/public-v1/sales-pipeline/attributes/4" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"title": "Partner referral",
"color": "green",
"type": 3
}'Example Response
{
"msg": "Update Success"
}Error Responses
| Status | Description |
|---|---|
422 | { "error": { "msg": ["attribute not found"] } } or validation failure |
Delete an Attribute
Delete an attribute.
DELETE /api/public-v1/sales-pipeline/attributes/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Attribute ID |
Example Request
curl -X DELETE "https://public-api.taskip.net/api/public-v1/sales-pipeline/attributes/4" \
-H "X-Secret-Key: your-secret-key-here"Example Response
{
"msg": "Delete Success"
}Error Responses
| Status | Description |
|---|---|
422 | { "error": { "msg": ["attribute not found"] } } |
Attribute Bulk Actions
Delete several attributes in one request.
POST /api/public-v1/sales-pipeline/attributes/bulk-actionsRequest Body
| Field | Type | Required | Description |
|---|---|---|---|
ids | array | Yes | Attribute IDs to delete |
Example Request
curl -X POST "https://public-api.taskip.net/api/public-v1/sales-pipeline/attributes/bulk-actions" \
-H "X-Secret-Key: your-secret-key-here" \
-H "Content-Type: application/json" \
-d '{
"ids": [
4,
5
]
}'Example Response
{
"msg": "Delete Success"
}Error Responses
| Status | Description |
|---|---|
422 | { "error": { "msg": ["attribute not found"] } } when none of the IDs exist |
Response Patterns
- All endpoints require the
X-Secret-Keyheader. - Validation failures from form requests return
422with{ "error": { "<field>": ["message"] } }. A few endpoints without a custom form request (pipeline list, deals list, deals order change, attributes) return the standard Laravel shape{ "message": "...", "errors": { ... } }. - Business-rule and permission refusals use
422with{ "error": { "msg": ["..."] } }or{ "msg": "..." }. - Unknown resources return
404with{ "msg": "..." }. PUTandPATCHare both routed to the update handler of every resource that supports updates (pipeline, deal, stage, task, meeting, note, activity, attribute). They behave identically and the same required fields must be sent. The only partial update is the deal: its optional fields keep their stored values when omitted (see Update a Deal).GET /{id}routes do not exist for stages, notes, activities and attributes.