Projekte
Projekt abrufen
Requires scope: project:read. Pass include=properties to get the project’s units in the same response — that additionally requires scope: property:read.
GET
/
projects
/
{id}
Get project
curl --request GET \
--url https://app.deal-pipe.de/api/v1/projects/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.deal-pipe.de/api/v1/projects/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.deal-pipe.de/api/v1/projects/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.deal-pipe.de/api/v1/projects/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.deal-pipe.de/api/v1/projects/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.deal-pipe.de/api/v1/projects/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.deal-pipe.de/api/v1/projects/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"project": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"street": "<string>",
"houseNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
},
"properties": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalSourceId": "<string>",
"unitIdentifier": "<string>",
"unitNumber": "<string>",
"street": "<string>",
"houseNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"latitude": "<string>",
"longitude": "<string>",
"etage": 123,
"zimmer": "<string>",
"wohnflaecheQm": "<string>",
"nutzflaecheQm": "<string>",
"baujahr": 123,
"status": "frei",
"visibility": "online",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"kaufpreis": "<string>",
"kaufpreisStellplatz": "<string>",
"kaltmieteWohnung": "<string>",
"kaltmieteStellplatz": "<string>",
"hausgeldGesamt": "<string>",
"hausgeldNichtUmlagefaehig": "<string>",
"kaufpreisPerQm": "<string>",
"kaltmietePerQm": "<string>",
"bruttorendite": "<string>",
"bauzustand": "<string>",
"anlageklasse": "<string>",
"mietstatus": "<string>",
"vermietetSeit": "<string>",
"energieeffizienzklasse": "<string>",
"energieausweistyp": "<string>",
"energieverbrauch": "<string>",
"heizungsart": "<string>",
"isDenkmal": true,
"isErbbaupacht": true,
"videoUrl": "<string>",
"virtualTourUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"images": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "<string>",
"fileName": "<string>",
"sortOrder": 123,
"url": "<string>",
"thumbnailUrl": "<string>"
}
]
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123,
"hasMore": true
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}Autorisierungen
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Pfadparameter
Abfrageparameter
Comma-separated. properties (aliases: units, einheiten) embeds the units; images additionally attaches signed image URLs and only works together with properties.
Verfügbare Optionen:
properties, images Page size. Max 200, or 50 when include=images is set. The effective value is echoed in pagination.limit.
Erforderlicher Bereich:
1 <= x <= 200Repeatable or comma-separated.
Verfügbare Optionen:
frei, auf_anfrage, reserviert, notarvorbereitung, notartermin, verkauft Repeatable or comma-separated.
Verfügbare Optionen:
online, offline, pending_review ISO 8601 timestamp. Returns units changed at or after it — use this to sync incrementally.
Archived (sold/closed) units are excluded by default.
⌘I
Get project
curl --request GET \
--url https://app.deal-pipe.de/api/v1/projects/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.deal-pipe.de/api/v1/projects/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.deal-pipe.de/api/v1/projects/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.deal-pipe.de/api/v1/projects/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.deal-pipe.de/api/v1/projects/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.deal-pipe.de/api/v1/projects/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.deal-pipe.de/api/v1/projects/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"project": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"street": "<string>",
"houseNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
},
"properties": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalSourceId": "<string>",
"unitIdentifier": "<string>",
"unitNumber": "<string>",
"street": "<string>",
"houseNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"latitude": "<string>",
"longitude": "<string>",
"etage": 123,
"zimmer": "<string>",
"wohnflaecheQm": "<string>",
"nutzflaecheQm": "<string>",
"baujahr": 123,
"status": "frei",
"visibility": "online",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"kaufpreis": "<string>",
"kaufpreisStellplatz": "<string>",
"kaltmieteWohnung": "<string>",
"kaltmieteStellplatz": "<string>",
"hausgeldGesamt": "<string>",
"hausgeldNichtUmlagefaehig": "<string>",
"kaufpreisPerQm": "<string>",
"kaltmietePerQm": "<string>",
"bruttorendite": "<string>",
"bauzustand": "<string>",
"anlageklasse": "<string>",
"mietstatus": "<string>",
"vermietetSeit": "<string>",
"energieeffizienzklasse": "<string>",
"energieausweistyp": "<string>",
"energieverbrauch": "<string>",
"heizungsart": "<string>",
"isDenkmal": true,
"isErbbaupacht": true,
"videoUrl": "<string>",
"virtualTourUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"images": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "<string>",
"fileName": "<string>",
"sortOrder": 123,
"url": "<string>",
"thumbnailUrl": "<string>"
}
]
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123,
"hasMore": true
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}