List pipelines
List pipelines with nested phases (use phase id as phase_id on deal create).
get
/api/v1/pipelines
Security
Parameters
| Name | In | Type | Details | |
|---|---|---|---|---|
per_page |
query |
integer
|
optional |
Items per page (1–100, default 15) Default:
15 |
search |
query |
string
|
optional | Search across entity fields and nested CRM emails/phones/addresses |
status |
query |
string
|
optional | Optional status filter |
Responses
200
Paginated pipelines
application/json
{
"allOf": [
{
"title": "API envelope",
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
},
"errors": {
"nullable": true
},
"meta": {
"type": "object",
"nullable": true,
"additionalProperties": true
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"title": "Pipeline",
"type": "object",
"required": [
"id",
"phases"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"transition_type": {
"type": "string",
"nullable": true
},
"display_order": {
"type": "integer",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"phases": {
"type": "array",
"items": {
"title": "Pipeline phase",
"type": "object",
"required": [
"id",
"is_required",
"need_approvals"
],
"properties": {
"id": {
"type": "integer"
},
"pipelines_id": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"display_order": {
"type": "integer",
"nullable": true
},
"condition": {
"type": "string",
"nullable": true
},
"is_required": {
"type": "boolean"
},
"need_approvals": {
"type": "boolean"
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"title": "Pagination",
"type": "object",
"properties": {
"current_page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total": {
"type": "integer"
},
"last_page": {
"type": "integer"
},
"from": {
"type": "integer",
"nullable": true
},
"to": {
"type": "integer",
"nullable": true
}
}
}
}
}
}
}
]
}
401
Missing or invalid API key
application/json
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Missing API key (X-Api-Key)"
}
}
}