List deal fields
Fields placed on the deal pipeline, with the current value. Select fields include `options` (allowed names) and `multiple`. dropdown and checkbox take an array of option names; dropdown_single and radio take one name. date is Y-m-d. signature is stored as {url, created_at}. uploader files are saved on the deal and returned as file records. Both must be base64 or a data URL. `table` and `fixed_table` fields are not included. Required query `deal_id`.
get
/api/v1/deals/fields
Security
Parameters
| Name | In | Type | Details | |
|---|---|---|---|---|
deal_id |
query |
integer
|
required | Deal id |
Responses
200
Deal fields
application/json
{
"success": true,
"message": null,
"data": {
"deal_id": 12,
"fields": [
{
"field_id": 47,
"name": "Finanzierung",
"type": "dropdown",
"is_required": false,
"multiple": true,
"options": [
"Barzahler",
"Finanzierung"
],
"value": [
"Barzahler"
]
},
{
"field_id": 8,
"name": "Start date",
"type": "date",
"is_required": false,
"value": "2026-10-12"
}
]
},
"errors": null,
"meta": null
}
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)"
}
}
}
404
Resource not found
application/json
{
"title": "API envelope",
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
},
"errors": {
"nullable": true
},
"meta": {
"type": "object",
"nullable": true,
"additionalProperties": true
}
}
}
422
Validation failed
application/json
{
"title": "API envelope",
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
},
"errors": {
"nullable": true
},
"meta": {
"type": "object",
"nullable": true,
"additionalProperties": true
}
}
}