Skip to main content
GET
Get project

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Query Parameters

include
enum<string>[]

Comma-separated. properties (aliases: units, einheiten) embeds the units; images additionally attaches signed image URLs and only works together with properties.

Available options:
properties,
images
limit
integer
default:50

Page size. Max 200, or 50 when include=images is set. The effective value is echoed in pagination.limit.

Required range: 1 <= x <= 200
offset
integer
default:0
status
enum<string>[]

Repeatable or comma-separated.

Available options:
frei,
auf_anfrage,
reserviert,
notarvorbereitung,
notartermin,
verkauft
visibility
enum<string>[]

Repeatable or comma-separated.

Available options:
online,
offline,
pending_review
updatedSince
string<date-time>

ISO 8601 timestamp. Returns units changed at or after it — use this to sync incrementally.

includeArchived
boolean
default:false

Archived (sold/closed) units are excluded by default.

Response

OK

project
object
properties
object[]

Only present when include=properties was requested.

pagination
object