Propstack

https://docs.propstack.de/
Admin
Propstack is a real estate and property management CRM platform with API endpoints for managing...
Tokens:74,994
Snippets:442
Trust Score:8.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Dynamic Documentation Query Example

Source: https://docs.propstack.de/reference/kontakte

This example shows how to query the documentation dynamically by appending an 'ask' parameter with a natural language question to the documentation URL.

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

--------------------------------

### Example Notes Response

Source: https://docs.propstack.de/reference/notizen

This is an example of a successful response when retrieving notes.

```json
{
    "notes": [
        {
            "id": 3273,
            "note_type_id": 56,
            "get_title": "Schöne Notiz",
            "broker_id": 1,
            "body": "",
            "client": null,
            "property": {
                "id": 1564,
                "name": "WE 127"
            },
            "comment_size": 0,
            "group_ids": [12],
            "title": "Schöne Notiz"
        }
    ]
}
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.propstack.de/reference/notizen

To get additional information not present on the page, perform an HTTP GET request with the 'ask' query parameter.

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

--------------------------------

### Query Documentation Dynamically

Source: https://docs.propstack.de/reference/custom-felder

Perform an HTTP GET request on the documentation URL with the 'ask' query parameter to get dynamic information. The question should be specific and self-contained.

```http
GET https://docs.propstack.de/reference/custom-felder.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.propstack.de/reference/kontakte/favoriten

To get more information not present on this page, make a GET request to the page URL with an 'ask' query parameter containing your question.

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

--------------------------------

### Document Response Example

Source: https://docs.propstack.de/reference/dokumente

Example JSON response when retrieving documents, showing document details and metadata.

```json
{
    "documents": [
        {
            "id": 11,
            "token": "1hw4mBZRnFrnitGUbj5jL4Rt",
            "title": "grundriss.pdf",
            "name": "grundriss.pdf",
            "url": "...",
            "position": 1,
            "broker_id": 1,
            "is_private": true,
            "on_landing_page": true,
            "is_exposee": false,
            "second_document": null,
            "is_floorplan": true,
            "tags": [],
            "created_at": "2019-11-12T14:56:25.140+01:00",
            "updated_at": "2019-11-12T15:16:28.348+01:00"
        }
    ],
    "meta": {
        "total_count": 1
    }
}
```

--------------------------------

### Example Snom Integration URL

Source: https://docs.propstack.de/reference/snom-integration

This example URL demonstrates how to call the Snom integration API with necessary query parameters. Replace 'mein-api-key' with your actual Propstack API key, ensuring it has Snom integration permissions.

```HTTP
https://crm.propstack.de/api/snom-phonebook?api_key=mein-api-key&number=$remote
```

--------------------------------

### Querying Documentation

Source: https://docs.propstack.de/reference/abteilungen

To get information not explicitly present, use the `ask` query parameter with a GET request to the documentation URL. The response includes answers and relevant excerpts.

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

--------------------------------

### Example Object Data

Source: https://docs.propstack.de/reference/objekte

This is an example of the JSON data structure returned for an object, including basic properties.

```json
{
    "data": [
        {
            "id": 5,
            "name": "001",
            "title": "Traumhafte Familienwohnung im klassischen Altbau in ruhiger Lage!",
            "unit_id": "001",
            "exposee_id": "",
            "project_id": 2,

```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.propstack.de/reference/bezirke

To get information not explicitly present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained.

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

--------------------------------

### Activity Response Example

Source: https://docs.propstack.de/reference/aktivitaeten-1

Example JSON response when retrieving an activity. The 'activatable' object will contain details specific to the activity type (e.g., Task, Email).

```JSON
{
    "id": 41711,
    "activatable_type": "Task",
    "activatable": {
        // je nachdem was activatable_type ist, 
        // .. kommt hier das Objekt zur E-Mail oder zum Task
    }
}
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.propstack.de/reference/snom-integration

To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```HTTP
GET https://docs.propstack.de/reference/snom-integration.md?ask=<question>
```

--------------------------------

### Example Event Response

Source: https://docs.propstack.de/reference/termine

This is an example of a successful response when retrieving events. It includes details for a single event, such as its ID, title, dates, state, and associated property.

```javascript
{
    "events": [
        {
            "id": 3273,
            "note_type_id": 56,
            "get_title": "Schöner Termin",
            "broker_id": 1,
            "body": "",
            "location": "",
            "starts_at": "2016-09-29T15:00:46.605+02:00",
            "ends_at": "2016-09-29T15:30:46.605+02:00",
            "state": "neutral",
            "recurring": null,
            "rrule": null,
            "all_day": false,
            "private": false,
            "client": null,
            "property": {
                "id": 1564,
                "name": "WE 127"
            },
            "comment_size": 0,
            "group_ids": [12],
            "title": "Schöner Termin"
        }
    ]
}
```

--------------------------------

### Openimmo XML File Example

Source: https://docs.propstack.de/webseite/anfragen

This is a sample Openimmo XML file used for contact inquiries.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<openimmo>
  <anbieter>
    <anbieter_id>12345</anbieter_id>
    <email>info@example.com</email>
  </anbieter>
  <kontakt>
    <nachname>Müller</nachname>
    <vorname>Max</vorname>
    <email>max.mueller@example.com</email>
    <telefon>0123456789</telefon>
    <adresse>
      <strasse>Musterstraße 1</strasse>
      <plz>12345</plz>
      <ort>Musterstadt</ort>
    </adresse>
  </kontakt>
  <freitext>Ich interessiere mich für diese Immobilie.</freitext>
</openimmo>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.propstack.de/reference/objekte/links

To get additional information not directly present on the page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained.

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

--------------------------------

### Query Documentation Dynamically

Source: https://docs.propstack.de/reference/brokers

To get additional information not explicitly present on a page, make an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language.

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

--------------------------------

### Dynamically Query Documentation

Source: https://docs.propstack.de/reference/termine

To get answers to questions not explicitly covered on a page, make an HTTP GET request to the page URL with an 'ask' query parameter. The question should be specific and in natural language.

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

--------------------------------

### Openimmo XML with UTM Parameters

Source: https://docs.propstack.de/webseite/anfragen

An example of an Openimmo XML file that includes UTM parameters for tracking marketing campaign sources.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<openimmo>
  <anbieter>
    <anbieter_id>12345</anbieter_id>
    <email>info@example.com</email>
  </anbieter>
  <kontakt>
    <nachname>Müller</nachname>
    <vorname>Max</vorname>
    <email>max.mueller@example.com</email>
    <telefon>0123456789</telefon>
    <adresse>
      <strasse>Musterstraße 1</strasse>
      <plz>12345</plz>
      <ort>Musterstadt</ort>
    </adresse>
  </kontakt>
  <freitext>Ich interessiere mich für diese Immobilie.</freitext>
  <kampagnen_daten>
    <utm_source>newsletter</utm_source>
    <utm_medium>email</utm_medium>
    <utm_campaign>sommeraktion</utm_campaign>
  </kampagnen_daten>
</openimmo>
```

--------------------------------

### Authentication via Header

Source: https://docs.propstack.de/

Authenticate API requests by including the X-API-KEY in the request header. This example uses curl.

```bash
$ curl https://api.propstack.de/v1/brokers -H "X-API-KEY: mein_api_key"
```

--------------------------------

### Get All Projects

Source: https://docs.propstack.de/reference/projects

Retrieves a list of all projects for the company. An optional 'expand' parameter can be used to include extended data.

```APIDOC
## GET /v1/projects

### Description
Retrieves a list of all projects for the company. An optional 'expand' parameter can be used to include extended data.

### Method
GET

### Endpoint
https://api.propstack.de/v1/projects

#### Query Parameters
- **expand** (string) - Optional - If set, extended data will be returned, similar to fetching a single project.

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the project.
- **title** (string) - The title of the project.
- **status** (object) - The current status of the project.
  - **label** (string) - The status label (e.g., "Vertrieb").
  - **color** (string) - The color associated with the status.
- **broker_id** (integer) - The ID of the broker responsible for the project.
- **title_image** (object) - Information about the project's title image.
  - **url** (string) - The URL of the title image.
  - **square_url** (string) - The URL of the square version of the title image.
- **project_id** (string) - A unique identifier for the project.
- **sub_headline** (string) - A sub-headline for the project (can be null).
- **tagline** (string) - A tagline for the project (can be null).
- **logo_url** (string) - The URL of the project's logo.
- **street** (string) - The street name of the project's location.
- **house_number** (string) - The house number of the project's location.
- **sublocality_level_1** (string) - The first level of sub-locality (e.g., "Kreuzberg").
- **zip_code** (string) - The postal code of the project's location.
- **city** (string) - The city of the project's location.
- **address** (string) - The full address of the project.
- **lat** (float) - The latitude coordinate of the project.
- **lng** (float) - The longitude coordinate of the project.
- **hide_address** (boolean) - Indicates if the address should be hidden.
- **custom_fields** (object) - An object for custom fields.

### Response Example
```json
[
  {
    "id": 23,
    "title": "Living Home",
    "status": {
      "label": "Vertrieb",
      "color": "#123123"
    },
    "broker_id": 66,
    "title_image": {
      "url": "https://...jpg",
      "square_url": "https://...jpg"
    },
    "project_id": "LH",
    "sub_headline": null,
    "tagline": null,
    "logo_url": "https://...jpg",
    "street": "Hauptstraße",
    "house_number": "12",
    "sublocality_level_1": "Kreuzberg",
    "zip_code": "12345",
    "city": "Berlin",
    "address": "Hauptstraße 12, 12345 Berlin, Deutschland",
    "lat": 13.4483934,
    "lng": 49.3483043,
    "hide_address": false,
    "custom_fields": {}
  }
]
```
```

--------------------------------

### Deal API Response Example

Source: https://docs.propstack.de/reference/deals

This snippet shows a successful response from the Deals API, including deal details like ID, price, dates, and associated IDs.

```javascript
{
    "data": [
        {
            "id": 8145,
            "sold_price": null,
            "note": "",
            "created_at": "2019-02-04T10:37:46.060+01:00",
            "start_date": "2019-02-04T10:37:36.360+01:00",
            "broker_id": 1,
            "client_id": 29934,
            "property_id": 9884,

```

--------------------------------

### Create Document Request Body

Source: https://docs.propstack.de/reference/dokumente

Example JSON body for creating a new document, linking it to a property and providing a title and base64 encoded file content.

```json
{
	"document": {
		"property_id": 123,
		"title": "orange-pixel.png",
		"doc": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8v5vhPwAHNgK7sbW2nQAAAABJRU5ErkJggg=="
	}
}
```

--------------------------------

### GET Appointments Datadump

Source: https://docs.propstack.de/reference/datendump

Retrieves a list of appointments from the datadump. Each appointment includes details like start and end times, title, and associated client and property IDs.

```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,
    ...
  }
]
```

--------------------------------

### Agent Instructions: Querying Documentation

Source: https://docs.propstack.de/paginierung

Anleitung zur dynamischen Abfrage der Dokumentation mittels eines GET-Requests mit dem 'ask'-Query-Parameter. Dies ist nützlich, wenn zusätzliche Informationen benötigt werden, die nicht direkt auf der Seite vorhanden sind.

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

--------------------------------

### Get Caller Information API Endpoint

Source: https://docs.propstack.de/reference/snom-integration

Use this GET endpoint to retrieve contact information for an incoming call. The response will be empty if no contact is found.

```HTTP
GET https://crm.propstack.de/api/snom-phonebook
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.propstack.de/custom-templates

Perform an HTTP GET request to query the documentation dynamically. Use this when the answer is not explicitly present, you need clarification, or want to retrieve related sections.

```http
GET https://docs.propstack.de/custom-templates.md?ask=<question>
```

--------------------------------

### Query Documentation

Source: https://docs.propstack.de/reference/dokumente

Allows dynamic querying of documentation content by appending an 'ask' parameter with a natural language question to the documentation URL. The response includes the answer and relevant sources.

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

--------------------------------

### Create a Project

Source: https://docs.propstack.de/reference/projects

Submit a POST request with a project object in the request body to create a new project. A successful creation returns a 201 Created status with an ID.

```javascript
{"ok": true,"id": 24}
```

--------------------------------

### Get Project by ID

Source: https://docs.propstack.de/reference/projects

Retrieves the details of a specific project using its ID.

```APIDOC
## GET /v1/projects/:id

### Description
Retrieves the details of a specific project using its ID.

### Method
GET

### Endpoint
https://api.propstack.de/v1/projects/:id

#### Path Parameters
- **id** (number) - Required - The ID of the project.

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the project.
- **title** (string) - The title of the project.
- **status** (object) - The current status of the project.
  - **label** (string) - The status label (e.g., "Vertrieb").
  - **color** (string) - The color associated with the status.
- **broker_id** (integer) - The ID of the broker responsible for the project.
- **title_image** (object) - Information about the project's title image.
  - **url** (string) - The URL of the title image.
  - **square_url** (string) - The URL of the square version of the title image.
- **project_id** (string) - A unique identifier for the project.
- **sub_headline** (string) - A sub-headline for the project (can be null).
- **tagline** (string) - A tagline for the project (can be null).
- **logo_url** (string) - The URL of the project's logo.
- **street** (string) - The street name of the project's location.
- **house_number** (string) - The house number of the project's location.
- **sublocality_level_1** (string) - The first level of sub-locality (e.g., "Kreuzberg").
- **zip_code** (string) - The postal code of the project's location.
- **city** (string) - The city of the project's location.
- **address** (string) - The full address of the project.
- **lat** (float) - The latitude coordinate of the project.
- **lng** (float) - The longitude coordinate of the project.
- **hide_address** (boolean) - Indicates if the address should be hidden.
- **custom_fields** (object) - An object for custom fields.
- **description_note** (string) - Additional notes about the project description.
- **location_note** (string) - Additional notes about the project location.
- **images** (array) - A list of images associated with the project.
  - **id** (integer) - The ID of the image.
  - **is_floorplan** (boolean) - Indicates if the image is a floor plan.
  - **is_private** (boolean) - Indicates if the image is private.
  - **title** (string) - The title of the image.
  - **url** (string) - The URL of the image.
  - **square_url** (string) - The URL of the square version of the image.
- **floorplans** (array) - A list of floor plans for the project.
  - **id** (integer) - The ID of the floor plan.
  - **title** (string) - The title of the floor plan.
  - **url** (string) - The URL of the floor plan.
- **documents** (array) - A list of documents related to the project.
  - **id** (integer) - The ID of the document.
  - **title** (string) - The title of the document.
  - **is_private** (boolean) - Indicates if the document is private.
  - **url** (string) - The URL of the document.
- **links** (array) - A list of links associated with the project.
  - **id** (integer) - The ID of the link.
  - **title** (string) - The title of the link.
  - **url** (string) - The URL of the link.

### Response Example
```json
{
  "id": 23,
  "title": "Living Home",
  "status": {
    "label": "Vertrieb",
    "color": "#123123"
  },
  "broker_id": 66,
  "title_image": {
    "url": "https://...jpg",
    "square_url": "https://...jpg"
  },
  "project_id": "LH",
  "sub_headline": null,
  "tagline": null,
  "logo_url": "https://...jpg",
  "street": "Hauptstraße",
  "house_number": "12",
  "sublocality_level_1": "Kreuzberg",
  "zip_code": "12345",
  "city": "Berlin",
  "address": "Hauptstraße 12, 12345 Berlin, Deutschland",
  "lat": 13.4483934,
  "lng": 49.3483043,
  "hide_address": false,
  "custom_fields": {},
  "description_note": "...",
  "location_note": "...",
  "images": [
    {
      "id": 123,
      "is_floorplan": false,
      "is_private": true,
      "title": "Schlafzimmer",
      "url": "https://...",
      "square_url": "https://..."
    }
  ],
  "floorplans": [
    {
      "id": 123,
      "title": "Grundriss",
      "url": "https://..."
    }
  ],
  "documents": [
    {
      "id": 123,
      "title": "Dokument A",
      "is_private": true,
      "url": "https://..."
    }
  ],
  "links": [
    {
      "id": 123,
      "title": "Homepage",
      "url": "https://..."
    }
  ]
}
```
```

--------------------------------

### Contact Not Found Response

Source: https://docs.propstack.de/reference/kontakte/favoriten

Example of an error response when the specified contact or property cannot be found.

```JSON
{
    "message": "Ain't no cake like that."
}
```

--------------------------------

### Successful Favorite Operation Response

Source: https://docs.propstack.de/reference/kontakte/favoriten

Example of a successful response when a contact is favorited or unfavorited.

```JSON
{
    "name": "Cake's name",
    "recipe": "Cake's recipe name",
    "cake": "Binary cake"
}
```

--------------------------------

### Sample Data Structure for Shop Window Screens

Source: https://docs.propstack.de/custom-templates/schaufenster-screens

This JSON structure represents the data available within a Liquid template for shop window screens. It includes shop details and a list of properties with their attributes.

```json
{
  "shop": {
    "name": "Musterimmobilien GmbH",
    "color": "#0c6bc4"
  },
  "properties": [
    {
      "title": "Reihenendhaus in Berlin Treptow",
      "unit_id": "ETW-2001",
      "exposee_id": "",
      "marketing_type": "BUY",
      "object_type": "LIVING",
      "rs_type": "HOUSE",
      "construction_year": 2015,
      "free_from": "01.02.2020",
      "rented": true,
      "floor_label": null,
      "street": "Lesvou",
      "house_number": "21",
      "zip_code": "12345",
      "city": "Berlin",
      "country": "DEU",
      "price": 280000.0,
      "sold_price": null,
      "base_rent": null,
      "total_rent": null,
      "service_charge": null,
      "parking_space_price": 30000.0,
      "number_of_rooms": 5.0,
      "plot_area": 800.0,
      "living_space": 185.0,
      "usable_floor_space": 185.0,
      "property_space_value": 185.0,
      "price_per_sqm": 1513.51,
      "has_courtage": true,
      "courtage": "3,57% inkl. Mwst.",
      "courtage_note": "",
      "deposit": null,
      "thermal_characteristic": null,
      "gfz": null,
      "grz": null,
      "bmz": null,
      "monument": false,
      "built_in_kitchen": true,
      "lift": false,
      "cellar": false,
      "description_note": "Wohnen auf 3 Ebenen mit einem kleinen Gartenbereich...",
      "location_note": "Berg- und Meer-Blick aus einer Immobilie, das können Sie hier genießen...",
      "furnishing_note": "",
      "other_note": "",
      "long_description_note": "",
      "long_location_note": "",
      "long_furnishing_note": "",
      "long_other_note": "",
      "energy_certificate_availability": "wird nicht benötigt",
      "building_energy_rating_type": null,
      "energy_efficiency_class": null,
      "firing_types": null,
      "heating_type": null,
      "formatted": {
        "id": 56,
        "name": "1055",
        "unit_id": "1055",
        "exposee_id": null,
        "marketing_type": "Miete",
        "rs_type": "Wohnung",
        "rs_category": "Souterrain",
        "construction_year": 1902,
        "equipment_technology_construction_year": null,
        "free_from": null,
        "price": null,
        "base_rent": "342 €",
        "total_rent": "522 €",
        "rental_income": null,
        "rent_subsidy": null,
        "parking_space_price": null,
        "number_of_parking_spaces": null,
        "parking_space_number": null,
        "rented": "nein",
        "yield_actual": null,
        "yield_target": null,
        "rental_income_actual": null,
        "rental_income_target": null,
        "distance_to_pt": null,
        "distance_to_fm": null,
        "distance_to_mrs": null,
        "distance_to_airport": null,
        "construction_phase": null,
        "tenancy": null,
        "price_on_inquiry": "nein",
        "short_term_constructible": "nein",
        "site_development_type": null,
        "site_constructible_type": null,
        "recommended_use_types": null,
        "min_divisible": null,
        "grz": null,
        "gfz": null,
        "net_floor_space": null,
        "number_of_apartments": null,
        "number_of_commercials": null,
        "special_purpose_type": null,
        "price_per_sqm": "8,55",
        "price_multiplier": null,
        "industrial_area": null,
        "additional_area": null,
        "price_type": null,
        "rent_duration": null,
        "heating_costs": "60 €",
        "heating_costs_in_service_charge": "nein",
        "service_charge": "120 €",
        "other_costs": null,
        "property_space_value": "40",
        "living_space": "40",
        "plot_area": null,
        "total_floor_space": null,
        "number_of_rooms": "1",
        "number_of_bed_rooms": null,
        "number_of_bath_rooms": null,
        "balcony_space": null,
        "last_refurbishment": null,
        "condition": "Neuwertig",
        "interior_quality": "Gehoben",
        "floor_label": "5. OG",
        "number_of_floors": 6,
        "parking_space_type": null,
        "number_of_balconies": null,
        "number_of_terraces": null,
        "energy_certificate_availability": "liegt vor",
        "building_energy_rating_type": "Bedarfsausweis",
        "energy_efficiency_class": "E",
        "thermal_characteristic": 160
      }
    }
  ]
}
```

--------------------------------

### Retrieve Notes

Source: https://docs.propstack.de/reference/notizen

Use this endpoint to get notes. It supports various query parameters for filtering.

```HTTP
GET https://api.propstack.de/v1/notes
```

--------------------------------

### Create Project

Source: https://docs.propstack.de/reference/projects

Creates a new project. The request body should contain the project details according to the project schema.

```APIDOC
## POST /v1/projects

### Description
Creates a new project. The request body should contain the project details according to the project schema.

### Method
POST

### Endpoint
https://api.propstack.de/v1/projects

#### Request Body
- **project** (object) - Required - See project schema for details.

### Response
#### Success Response (201 Created)
- **ok** (boolean) - Indicates if the creation was successful.
- **id** (integer) - The ID of the newly created project.

### Response Example
```json
{
  "ok": true,
  "id": 24
}
```
```

--------------------------------

### Create Deal

Source: https://docs.propstack.de/reference/deals

Use this endpoint to create a new deal. Requires client_id, property_id, and deal_stage_id.

```json
{
   "client_property": {
       "property_id": 123,
       "client_id": 456,
       "note" : "some note"
   }
}
```

--------------------------------

### GET /v1/client_properties

Source: https://docs.propstack.de/reference/deals

Retrieves a list of deals. This endpoint allows fetching deal information based on various attributes.

```APIDOC
## GET /v1/client_properties

### Description
Retrieves a list of deals. This endpoint allows fetching deal information based on various attributes.

### Method
GET

### Endpoint
https://api.propstack.de/v1/client_properties

### Parameters
#### Query Parameters
- **broker_id** (integer) - Optional - Besitzer des Deals
- **client_id** (integer) - Optional - ID zum Interessenten (Kontakt)
- **property_id** (integer) - Optional - ID zum Objekt
- **project_id** (integer) - Optional - ID zum Projekt (muss nicht selber gesetzt werden, wird über das Objekt automatisch gesetzt)
- **deal_stage_id** (integer) - Optional - ID zur Deal-Phase
- **deal_pipeline_id** (integer) - Optional - ID zur Deal-Pipeline (muss nicht selber gesetzt werden, wird über die Deal-Phase automatisch gesetzt)
- **date** (date) - Optional - Datum des Deals
- **price** (float) - Optional - (voraussichtlicher) realisierter Preis des Deals
- **note** (string) - Optional - Interne Notiz zum Deal
```

--------------------------------

### Retrieve All Projects

Source: https://docs.propstack.de/reference/projects

Use this endpoint to fetch a list of all projects associated with the company. The `expand` parameter can be used to include extended project data.

```javascript
[{"id": 23,"title": "Living Home","status": {"label": "Vertrieb","color": "#123123"},"broker_id": 66,"title_image": {"url": "https://...jpg","square_url": "https://...jpg"},"project_id": "LH","sub_headline": null,"tagline": null,"logo_url": "https://...jpg","street": "Hauptstraße","house_number": "12","sublocality_level_1": "Kreuzberg","zip_code": "12345","city": "Berlin","address": "Hauptstraße 12, 12345 Berlin, Deutschland","lat": 13.4483934,"lng": 49.3483043,"hide_address": false,"custom_fields": {}}]
```

--------------------------------

### Get Object in English Locale

Source: https://docs.propstack.de/reference/objekte

Retrieve object details in English by appending the `locale=en` parameter. The default locale is German.

```url
?locale=en
```

--------------------------------

### Confirm Customer Account with Token

Source: https://docs.propstack.de/webseite/kunden-registrierung

After a customer clicks the confirmation link, use this endpoint with the provided token to confirm their account in Propstack.

```bash
POST /v1/contacts/confirm

{
  "confirmation_token": "abc"
}
```

--------------------------------

### GET /v1/datadump/cancelations

Source: https://docs.propstack.de/reference/datendump

Retrieves a data dump of all cancelations. This endpoint returns an array of cancelation objects, each detailing a canceled event.

```APIDOC
## GET /v1/datadump/cancelations

### Description
Retrieves a data dump of all cancelations. This endpoint returns an array of cancelation objects, each detailing a canceled event.

### Method
GET

### Endpoint
https://api.propstack.de/v1/datadump/cancelations

### Response
#### Success Response (200)
- **id** (integer) - 365
- **created_at** (string) - "2021-07-20T11:08:20.841356"
- **note_type_id** (integer) - 11
- **starts_at** (string) - "2021-07-19T11:40:00"
- **ends_at** (string) - "2021-07-19T16:10:00"
- **broker_id** (integer) - 4
- **state** (integer) - 0
- **client_ids** (array) - [28]
- **property_ids** (array) - [3]
- **project_ids** (array) - [1]
- **reservation_reason_id** (string) - "1m"

### Request Example
```json
{
  "example": "request body"
}
```

### Response Example
```json
[
  {
    "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",
    ...
  }
]
```
```

--------------------------------

### Create Task Activity

Source: https://docs.propstack.de/reference/aktivitaeten-1

This snippet shows the structure for creating a 'Task' activity. It includes common attributes like title, note type, and associations with clients, properties, or projects.

```JSON
{
    "title": "string",
    "note_type_id": "integer",
    "body": "string",
    "client_ids": "integer[]",
    "property_ids": "integer[]",
    "project_ids": "integer[]",
    "broker_id": "integer",
    "task_creator_id": "integer",
    "task_updater_id": "integer"
}
```

--------------------------------

### GET /v1/datadump/appointments

Source: https://docs.propstack.de/reference/datendump

Retrieves a data dump of all appointments. This endpoint returns an array of appointment objects, each containing details about a scheduled appointment.

```APIDOC
## GET /v1/datadump/appointments

### Description
Retrieves a data dump of all appointments. This endpoint returns an array of appointment objects, each containing details about a scheduled appointment.

### Method
GET

### Endpoint
https://api.propstack.de/v1/datadump/appointments

### Response
#### Success Response (200)
- **id** (integer) - 368
- **created_at** (string) - "2021-07-20T11:12:45.178614"
- **note_type_id** (integer) - 6
- **starts_at** (string) - "2021-07-20T11:40:00"
- **ends_at** (string) - "2021-07-20T12:10:00"
- **title** (string) - "Test"
- **body** (string) - "<p>Test</p>"
- **broker_id** (integer) - 3
- **state** (integer) - 0
- **clients_ids** (array) - [1]
- **properties_ids** (array) - [18]
- **projects_ids** (array) - [2]
- **rrule** (string) - null
- **is_campaign** (boolean) - false
- **clients_status** (array) - []
- **send_reminders** (boolean) - false

### Request Example
```json
{
  "example": "request body"
}
```

### Response Example
```json
[
  {
    "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,
    ...
  }
]
```
```
Tokens:
Raw