Deals auflisten
get
/api/v1/deals
Sicherheit
Parameter
| Name | In | Typ | Details | |
|---|---|---|---|---|
page |
query |
integer
|
Optional |
Default:
1 |
per_page |
query |
integer
|
Optional |
Einträge pro Seite (1–100, Standard 15) Default:
15 |
search |
query |
string
|
Optional | Suche über Entity-Felder und verschachtelte CRM-E-Mails/Telefone/Adressen |
pipelines_id |
query |
integer
|
Optional | Filter by pipeline id |
is_active |
query |
boolean
|
Optional | Filter by active flag |
Antworten
200
Pagrierte Deals
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": "Deal",
"type": "object",
"required": [
"id",
"is_active"
],
"properties": {
"id": {
"type": "integer"
},
"deals_unique_id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"is_active": {
"type": "boolean"
},
"deal_status": {
"type": "string",
"nullable": true
},
"pipelines_id": {
"type": "integer",
"nullable": true
},
"pipeline_name": {
"type": "string",
"nullable": true
},
"partners_id": {
"type": "integer",
"nullable": true
},
"partner_name": {
"type": "string",
"nullable": true
},
"contacts_id": {
"type": "integer",
"nullable": true
},
"contact_display_name": {
"type": "string",
"nullable": true
},
"phase_id": {
"type": "integer",
"nullable": true
},
"phase_name": {
"type": "string",
"nullable": true
},
"tags_id": {
"type": "integer",
"nullable": true
},
"solar_sites_id": {
"type": "integer",
"nullable": true
},
"started_on": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
},
"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)"
}
}
}