Solarware API-Dokumentation
YAML herunterladen

Deal-Felder auflisten

Felder der Deal-Pipeline inklusive aktuellem Wert. Auswahlfelder enthalten `options` (erlaubte Namen) und `multiple`. dropdown und checkbox erwarten ein Array von Optionsnamen; dropdown_single und radio einen Namen. date ist Y-m-d. signature wird als {url, created_at} gespeichert. uploader-Dateien werden am Deal gespeichert und als Dateidatensätze zurückgegeben. Beides muss base64 oder eine Data-URL sein. `table` und `fixed_table` sind nicht enthalten. Pflicht-Query `deal_id`.

get /api/v1/deals/fields

Sicherheit

ApiKeyAuth

Parameter

Name In Typ Details
deal_id query integer Pflicht Deal id

Antworten

200 Deal-Felder

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
        }
    }
}