Pass
One Ofstatusstringrequired
Allowed values:PASS
Example:PASS
components
One Ofarrayrequired
>= 1 items
pingComponentobject
Health
Health of the service.
Healthcheck endpoint
Get the operational status of the API
get
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
get/health
Authentication
application/json; charset=utf-8
Retrieves all projects for a customer.
Retrieve all projects for a customer.
get
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Successful retrieval of projects.
externalProjectIdsarray[string]
The external project IDs returned in this page of results.
get/projects
Authentication
application/json; charset=utf-8
Create a new project
Create a new project. A project is a collection of listings that are related to each other. For instance, a project can be a building that contains several apartments for sale. This endpoint allows you to create a new project
post
Body
application/json; charset=utf-8
Body
application/json; charset=utf-8
projectRequest
Request wrapper for Data
* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired
metadata associated with the project in Immowelt system.
* Additional properties are NOT allowed.
Show Child Parameters
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Created
projectResponse
Response wrapper for Data
* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
metadataobject
metadata associated with the project in Immowelt system.
* Additional properties are NOT allowed.
Show Child Parameters
contactobject
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]
Array of media items attached to the listing.
Show Child Parameters
post/projects
Authentication
Body
{
"data": {},
"metadata": {
"source": {
"offererMarketingKey": "HH-AH61a-WE15a-1",
"offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981"
}
}
}
application/json; charset=utf-8
Retrieve an existing project
Retrieve a project
get
Path Parameters
externalProjectIdstringrequired
The Unique Identifier of the project.
Example:project123
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Accepted
projectResponse
Response wrapper for Data
* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
metadataobject
metadata associated with the project in Immowelt system.
* Additional properties are NOT allowed.
Show Child Parameters
contactobject
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]
Array of media items attached to the listing.
Show Child Parameters
get/projects/{externalProjectId}
Authentication
Path Parameters
application/json; charset=utf-8