Custom Felder

Custom Felder lesen

GET https://api.propstack.de/v1/custom_field_groups

Custom Felder gehören immer einer Gruppe und zu einer Entität an.

Query Parameters

Name	Type	Description
entity	string	Siehe unten für mögliche Werte

200

{
    "data": [
        {
            "id": 1,
            "name": "Marketing",
            "entity": "for_clients",
            "custom_fields": [
                {
                    "id": 2,
                    "name": "marketing_project",
                    "pretty_name": "Marketing-Projekt",
                    "field_type": "String",
                    "position": 1,
                    "custom_options": []
                },
                {
                    "id": 1,
                    "name": "marketing_channel",
                    "pretty_name": "Marketing-Kanal",
                    "field_type": "Dropdown",
                    "position": 2,
                    "custom_options": [
                        {
                            "id": 1,
                            "name": "Lead"
                        },
                        {
                            "id": 2,
                            "name": "Subscriber"
                        }
                    ]
                },
            ]
        }
    ]
}

Mögliche Entitäten (entity):

1. for_clients

2. for_properties

3. for_projects

4. for_brokers

5. for_tasks

6. for_deals

Filtern von Objekten und Kontakten nach Custom Feld

Um nach Custom Feldern in Ihren Requests zu filtern, verwenden Sie den Schlüssel des jeweiligen Custom Felds, indem Sie ihn mit "cf_" voranstellen. Zum Beispiel: Wenn Sie ein Custom Feld mit dem Schlüssel "marketing_channel" haben, nutzen Sie "cf_marketing_channel=Lead", um Ergebnisse basierend auf dem Wert "Lead" für dieses Feld zu filtern.