# Datendump

Propstack bietet die Möglichkeit komplette Datensätze im JSON-Format zu exportieren (Datendump). Mögliche Verwendungszwecke umfassen die Erstellung von detaillierten Auswertungen in Drittanbietersoftware, z.B. PowerBi oder Google Data Studio, oder auch die  Onsite-Datensicherung. Der Datendump wird täglich durchgeführt.

*Es handelt sich hierbei um ein Premium-Feature. Sollten Interesse bestehen, wenden Sie sich bitte an den Vertrieb.*

Der Datendump besteht aus mehreren JSON-Dateien, zu der man über eine Abfrage auf die API weitergeleitet wird. Es stehen folgende Dateien (oder "Tabellen") bereit:

* Termine (appointments)
* Nutzer (brokers)
* Absagen (cancelations)
* Provisionssplits (commission\_splits)
* Kontakte (contacts)
* Deal-Pipelines inkl. Deal-Phasen (deal\_pipelines)
* Deals (deals)
* Teams (departments)
* Dokumente (documents)
* Bilder (images)
* Emails (messages)
* Notizen (notes)
* Nachweise (policies)
* Projekte (projects)
* Objekte (properties)
* Objekt-Texte inkl. Übersetungen (property\_details)
* Beziehungen (relationships)
* Suchprofile (saved\_queries)
* Mandaten (teams)
* Aufgaben (todos)

Weiterhin gibt es einige Key-Value-Objekte mit den Feldern id und name:

* Merkmale (groups)
* Kontakt-Quellen (contact\_sources)
* Speichergründe (contact\_reasons)
* Kontakt-Status (contact\_statuses)
* Absagegründe (reservation\_reasons)
* Objekt-Status (property\_statuses)

Die Daten variieren bzgl. der angelegten Custom Felder.

```aspnet
https://api.propstack.de/v1/datadump/*
```

## Kontakte

<mark style="color:blue;">`GET`</mark> `https://api.propstack.de/v1/datadump/contacts`

{% tabs %}
{% tab title="200 " %}

```javascript
[
  {
    "academic_title": null,
    "active_reservations": [],
    "archived": false,
    "birth_name": null,
    "broker_id": 2,
    "broker_ids": [],
    "cancelation_reason_ids": [],
    "canceled_reservations": [],
    "children_count": 0,
    "client_reason_id": null,
    "client_source_id": 5,
    "client_status_id": 3,
    "commercial": false,
    "company": "Musterfirma",
    "confirmed_at": null,
    "contact_sync_broker_ids": null,
    "cp_delete_request_date": null,
    "cp_profile_updated_at": null,
    "created_at": "2021-07-04T22:00:00",
    "create_notification": false,
    "creator_id": null,
    "customer_protection_partner": false,
    "deleted_at": null,
    "department_ids": [],
    "description": null,
    "dob": "2002-11-10",
    "email": null,
    "emails": [
      "test@example.com"
    ],
    "equity": null,
    "first_name": "Max",
    "gdpr_status": 0,
    "has_protection": false,
    "home_address": null,
    "home_cell": "+49-1231-12312321",
    "home_city": "Berlin",
    "home_country": "Deutschland",
    "home_fax": null,
    "home_house_number": "76",
    "home_phone": null,
    "home_street": "Musterstrasse",
    "home_url": "example.com",
    "home_zip_code": "42573",
    "id": 109,
    "identity_number": null,
    "issuing_authority": null,
    "item_id": 109,
    "keep_data_till": null,
    "last_contact_at": "2021-06-25T22:00:00",
    "last_logged_in_at": null,
    "last_name": "Mustermann",
    "locale": null,
    "nationality": null,
    "newsletter": null,
    "office_address": null,
    "office_cell": null,
    "office_city": null,
    "office_country": null,
    "office_fax": null,
    "office_house_number": null,
    "office_phone": null,
    "office_street": null,
    "office_url": null,
    "office_zip_code": null,
    "old_crm_id": null,
    "online": false,
    "parent_id": null,
    "photo": null,
    "policy_accepted_at": null,
    "position": "Manager",
    "preferred_contact_channel": "account_email",
    "preferred_contact_time": null,
    "property_mailing_wanted": false,
    "rating": 0,
    "relationship": null,
    "salutation": "mr",
    "score": 0,
    "second_broker_id": null,
    "tags": [],
    "third_broker_id": null,
    "time_zone": null,
    "updated_at": "2021-07-12T10:43:32.805814",
    "updater_id": null,
    "mvsigned": false,
    "hvsigned": false,
    "newsletter_unsubscribed": false,
    "from_website": false,
    "locked": false,
    "home_address_validated": false,
    "status": "Kunde",
    "source": "Facebook Ads",
    ...
  }
]
```

{% endtab %}
{% endtabs %}

## Objekte

<mark style="color:blue;">`GET`</mark> `https://api.propstack.de/v1/datadump/properties`

{% tabs %}
{% tab title="200 " %}

```javascript
[
  {
    "address": null,
    "administrative_area_level_1": null,
    "archived": false,
    "base_rent": null,
    "broker_id": 3,
    "brokers": [
      1
    ],
    "city": "Berlin",
    "copying": false,
    "country": "DEU",
    "courtage": null,
    "created_at": "2021-07-12T10:43:40.238882",
    "creator_id": null,
    "deleted_at": null,
    "department_ids": [],
    "exposee_id": null,
    "featured": false,
    "for_bidding": false,
    "gastronomy_type": null,
    "has_courtage": false,
    "hide_address": true,
    "house_number": "90",
    "id": 1,
    "industry_type": null,
    "investment_type": null,
    "is24_id": null,
    "lat": 52.59733,
    "living_space": 127,
    "lng": 13.36681,
    "locale": null,
    "location_id": 3,
    "marketing_type": "BUY",
    "net_floor_space": null,
    "number_of_rooms": 5,
    "object_type": "LIVING",
    "office_type": null,
    "old_crm_id": null,
    "plot_area": null,
    "price": 425000,
    "price_interval_type": null,
    "project_id": 1,
    "property_status_id": 6,
    "rs_type": "APARTMENT",
    "short_term_accomodation_type": null,
    "special_purpose_type": null,
    "start_rental_date": null,
    "statistics": "{}",
    "street": "Musterstrasse",
    "sublocality_level_1": null,
    "total_floor_space": null,
    "unit_id": "1000",
    "updated_at": "2021-07-12T10:43:40.238882",
    "zip_code": "80896",
    "lift": false,
    "ramp": false,
    "floor": 3,
    "sauna": false,
    "cellar": false,
    "garden": false,
    "loggia": false,
    "rented": true,
    "balcony": false,
    "chimney": false,
    "terrace": false,
    "monument": false,
    "auto_lift": false,
    "condition": "DERELICT",
    "storeroom": false,
    "demolition": false,
    "goods_lift": false,
    "non_smoker": false,
    "total_rent": 1784.3500000000001,
    "has_canteen": false,
    "lodger_flat": false,
    "other_costs": 317.5,
    "alarm_system": false,
    "barrier_free": false,
    "crane_runway": false,
    "firing_types": "GAS",
    "guest_toilet": false,
    "heating_type": "NIGHT_STORAGE_HEATER",
    "high_voltage": false,
    "rent_subsidy": 1016,
    "flooring_type": [
      "TERRACOTTA"
    ],
    "has_furniture": false,
    "heating_costs": 190.5,
    "rental_income": 13030.2,
    "swimming_pool": false,
    "wellness_area": false,
    "winter_garden": false,
    "apartment_type": "ATTIKA",
    "rotation_fixed": false,
    "service_charge": 508,
    "air_conditioning": false,
    "built_in_kitchen": false,
    "interior_quality": "SIMPLE",
    "kitchen_complete": false,
    "number_of_floors": 5,
    "price_on_inquiry": false,
    "construction_year": 1926,
    "conservation_areas": false,
    "building_permission": false,
    "flat_share_suitable": false,
    "maintenance_reserve": 381,
    "preliminary_enquiry": false,
    "landing_page_blocked": false,
    "short_term_constructible": false,
    "construction_year_unknown": false,
    "summer_residence_practical": false,
    "energy_certificate_availability": "NOT_REQUIRED",
    "heating_costs_in_service_charge": false,
    "certificate_of_eligibility_needed": false,
    "energy_consumption_contains_warm_water": false,
    "status": "Inaktiv",
    ...
  }
]
```

{% endtab %}
{% endtabs %}

## Termine

<mark style="color:blue;">`GET`</mark> `https://api.propstack.de/v1/datadump/appointments`

{% tabs %}
{% tab title="200 " %}

```javascript
[
  {
    "id": 368,
    "created_at": "2021-07-20T11:12:45.178614",
    "note_type_id": 6,
    "starts_at": "2021-07-20T11:40:00",
    "ends_at": "2021-07-20T12:10:00",
    "title": "Test",
    "body": "<p>Test</p>",
    "broker_id": 3,
    "state": 0,
    "clients_ids": [
      1
    ],
    "properties_ids": [
      18
    ],
    "projects_ids": [
      2
    ],
    "rrule": null,
    "is_campaign": false,
    "clients_status": [],
    "send_reminders": false,
    ...
  }
]
```

{% endtab %}
{% endtabs %}

## Absagen

<mark style="color:blue;">`GET`</mark> `https://api.propstack.de/v1/datadump/cancelations`

{% tabs %}
{% tab title="200 " %}

```javascript
[
  {
    "id": 365,
    "created_at": "2021-07-20T11:08:20.841356",
    "note_type_id": 11,
    "starts_at": "2021-07-19T11:40:00",
    "ends_at": "2021-07-19T16:10:00",
    "broker_id": 4,
    "state": 0,
    "client_ids": [
      28
    ],
    "property_ids": [
      3
    ],
    "project_ids": [
      1
    ],
    "reservation_reason_id": 1m
    ...
  }
]
```

{% endtab %}
{% endtabs %}

## Deals

<mark style="color:blue;">`GET`</mark> `https://api.propstack.de/v1/datadump/deals`

{% tabs %}
{% tab title="200 " %}

```javascript
[
  {
    "id": 1,
    "created_at": "2021-07-12T10:43:57.738701",
    "updated_at": "2021-07-12T10:43:57.738701",
    "deal_stage_id": 1,
    "deal_pipeline_id": 1,
    "deal_stage_chance": 1,
    "reservation_reason_id": 1,
    "client_source_id": 1,
    "broker_id": 1,
    "client_id": 63,
    "property_id": 30,
    "project_id": 1,
    "start_date": "2021-07-19",
    "price": 500000.00,
    ...
  }
]
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.propstack.de/reference/datendump.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.