API docs by Redocly

request API (develop:84871a)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the request stack.

ApplicationService

Create an application

Creates a new rental application from either individuals (with optional guarantors) or a company. Individuals and company must not both be provided.

Request Body schema: application/json
required
required
object (requestapplicationv2Company)
required
Array of objects (requestapplicationv2Individual)
required
Array of objects (Either individuals or company must be provided. Both are NOT allowed!)

Responses

Request samples

Content type
application/json
{
  • "company": {
    },
  • "guarantors": [
    ],
  • "individuals": [
    ]
}

Response samples

Content type
application/json
{
  • "application": {
    }
}

Delete applications

Deletes the applications with the given IDs. When hard is true, performs a hard delete.

path Parameters
ids
required
Array of strings non-empty
query Parameters
hard
boolean

Responses

Response samples

Content type
application/json
{ }

Get application by ID

Returns the application identified by the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "application": {
    }
}

Get latest application by creator email

Returns the most recent application created by the given creator email.

path Parameters
creatorEmail
required
string

Responses

Response samples

Content type
application/json
{
  • "application": {
    }
}

Send an application

Sends the application for the given object. Optional requestId matches an existing request; otherwise email matching is used. Supports viewingAppointmentDone, desiredStartOfContract, and language.

Request Body schema: application/json
required
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

id
required
string
language
required
string
objectId
required
string
requestId
string

Optional. If not provided the email will be used to match.

viewingAppointmentDone
required
boolean

Responses

Request samples

Content type
application/json
{
  • "desiredStartOfContract": {
    },
  • "id": "string",
  • "language": "string",
  • "objectId": "string",
  • "requestId": "string",
  • "viewingAppointmentDone": true
}

Response samples

Content type
application/json
{ }

Get application settings for an account

Returns application settings for the given account ID.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "settings": {
    }
}

Set application settings for an account

Updates application settings for the given account, including contract creation cost, automatic reference check, dossier requirements, affordability ranges, and reference email template bodies. Returns the saved settings.

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
object (v2AffordabilitySettings)
object (v2ApplicationDossierSettings)
automaticReferenceCheck
string (marketbaseAutomaticReferenceCheckMode)
Default: "AUTOMATIC_REFERENCE_CHECK_MODE_UNDEFINED"
Enum: "AUTOMATIC_REFERENCE_CHECK_MODE_UNDEFINED" "AUTOMATIC_REFERENCE_CHECK_MODE_DO_NOT_CHECK" "AUTOMATIC_REFERENCE_CHECK_MODE_IF_AFFORDABILITY_APPROPRIATE" "AUTOMATIC_REFERENCE_CHECK_MODE_IF_COMPLETE_DOSSIER_AND_AFFORDABILITY"
contractCreationCost
number <float>
employerReferenceEmailTemplate
string

Single HTML body for employer reference request emails. May contain one or more language versions in the same mail (Swiss practice). Must include the #link_referenz# placeholder.

landlordReferenceEmailTemplate
string

Single HTML body for landlord reference request emails. May contain one or more language versions in the same mail (Swiss practice). Must include the #link_referenz# placeholder.

referenceSenderMailboxId
string
showContractCreationCostAgreement
boolean

Responses

Request samples

Content type
application/json
{
  • "affordability": {
    },
  • "applicationDossier": {
    },
  • "automaticReferenceCheck": "AUTOMATIC_REFERENCE_CHECK_MODE_UNDEFINED",
  • "contractCreationCost": 0.1,
  • "employerReferenceEmailTemplate": "string",
  • "landlordReferenceEmailTemplate": "string",
  • "referenceSenderMailboxId": "string",
  • "showContractCreationCostAgreement": true
}

Response samples

Content type
application/json
{
  • "settings": {
    }
}

RequestService

Create a request

Creates a new rental request for the given owner and object. Accepts source, marketplace name, initial message, requesters, guarantors, checklist, and flags such as favorite, rejected, and sendDefaultAnswer.

Request Body schema: application/json
required
required
object (v2Checklist)
createdByReceiver
required
boolean (If receiver or requester read the last message)
favorite
required
boolean
required
Array of objects (v2Guarantor)
initialMessage
required
string
marketplaceName
required
string
objectId
required
string
ownerId
required
string <int64>
rejected
required
boolean
required
Array of objects (v2Requester)
sendDefaultAnswer
required
boolean
source
required
string (- PERSONAL_REQUEST_SOURCE: E.g. if requester came into office)
Default: "UNDEFINED_REQUEST_SOURCE"
Enum: "UNDEFINED_REQUEST_SOURCE" "PHONE_REQUEST_SOURCE" "MAIL_REQUEST_SOURCE" "WEBSITE_REQUEST_SOURCE" "MARKETPLACE_REQUEST_SOURCE" "PERSONAL_REQUEST_SOURCE"
tenancyId
required
string

DO NOT USE! Deprecated. Use tenancyIds

tenancyIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "checklist": {
    },
  • "createdByReceiver": true,
  • "favorite": true,
  • "guarantors": [
    ],
  • "initialMessage": "string",
  • "marketplaceName": "string",
  • "objectId": "string",
  • "ownerId": "string",
  • "rejected": true,
  • "requesters": [
    ],
  • "sendDefaultAnswer": true,
  • "source": "UNDEFINED_REQUEST_SOURCE",
  • "tenancyId": "string",
  • "tenancyIds": [
    ]
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

Get marketing request statistics

Returns overall and employee-scoped new and unread request counts for the given account under marketing share scope. Optional contactIdAssigneeMarketing scopes the employee figures.

path Parameters
accountId
required
string <int64>

The ID of the account whose marketing statistics are to be calculated (requests to objects he got with share-scope=MARKETING)

query Parameters
contactIdAssigneeMarketing
string

The contactId which should be used for employee based statistics

Responses

Response samples

Content type
application/json
{
  • "employeeNewRequests": 0,
  • "employeeUnreadRequests": 0,
  • "overallNewRequests": 0,
  • "overallUnreadRequests": 0
}

Get request statistics by object IDs

Returns per-object request statistics including overall, unread, appointments done, and applications received counts.

path Parameters
objectIds
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "statistics": [
    ]
}

List requests by IDs

Returns the requests matching the given request IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

List requests by requester contact ID

Returns all requests that include the given requester contact ID.

path Parameters
contactId
required
string

Responses

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

List received requests by object IDs

Returns received requests for the given object IDs. Supports optional filters for new/unread state, checklist flags, and marketplace names. Response includes overall, new, and unread counts plus whether an object is reserved.

path Parameters
objectIds
required
Array of strings non-empty
query Parameters
new
boolean

Optional: If new request wasn't read by the receiver at least once

readByReceiver
boolean

Optional: If receiver read the last message

checklist.viewingAppointmentContactShared
boolean
checklist.viewingAppointmentArranged
boolean
checklist.viewingAppointmentDone
boolean
checklist.applicationFormRequested
boolean
checklist.applicationFormReceived
boolean
checklist.referencesObtained
boolean
checklist.creditCheckDone
boolean
checklist.contractSent
boolean
checklist.contractReceived
boolean
marketplaceName
Array of strings

Optional

Responses

Response samples

Content type
application/json
{
  • "new": 0,
  • "overall": 0,
  • "requests": [
    ],
  • "reserved": true,
  • "unread": 0
}

List sent requests for an account

Returns requests sent by the given account ID.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

Mark requests as read

Marks the given requests as read. When readByReceiver is true the receiver side is updated; otherwise the requester side is updated.

Request Body schema: application/json
required
ids
required
Array of strings
readByReceiver
required
boolean (True=receiver read, false=requester read)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "readByReceiver": true
}

Response samples

Content type
application/json
{ }

Mark requests as rejected

Marks the given requests as rejected.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Mark requests as unread

Marks the given requests as unread. When unreadByReceiver is true the receiver side is updated; otherwise the requester side is updated.

Request Body schema: application/json
required
ids
required
Array of strings
unreadByReceiver
required
boolean (True=receiver unread, false=requester unread)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "unreadByReceiver": true
}

Response samples

Content type
application/json
{ }

Partially update request checklist

Updates only the provided checklist fields on the given requests. Returns the updated requests.

Request Body schema: application/json
required
applicationFormReceived
required
boolean
applicationFormRequested
required
boolean
contractReceived
required
boolean
contractSent
required
boolean
creditCheckDone
required
boolean
ids
required
Array of strings
referencesObtained
required
boolean
viewingAppointmentArranged
required
boolean
viewingAppointmentContactShared
required
boolean
viewingAppointmentDone
required
boolean

Responses

Request samples

Content type
application/json
{
  • "applicationFormReceived": true,
  • "applicationFormRequested": true,
  • "contractReceived": true,
  • "contractSent": true,
  • "creditCheckDone": true,
  • "ids": [
    ],
  • "referencesObtained": true,
  • "viewingAppointmentArranged": true,
  • "viewingAppointmentContactShared": true,
  • "viewingAppointmentDone": true
}

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

Reactivate rejected requests

Reactivates the given requests by clearing their rejected state.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Get digital reference form

Returns the digital reference form for the given public ID, including validity, type, language, applicant and administration details, and prefill data.

path Parameters
publicId
required
string

Responses

Response samples

Content type
application/json
{
  • "administration": {
    },
  • "applicant": {
    },
  • "employerPrefill": {
    },
  • "landlordPrefill": {
    },
  • "language": "PREFERRED_LANGUAGE_UNDEFINED",
  • "type": "REFERENCE_TYPE_UNDEFINED",
  • "valid": true
}

Submit digital reference form

Submits employer or landlord reference answers for the form identified by public ID, including optional contact person for queries and notes.

path Parameters
publicId
required
string
Request Body schema: application/json
required
contactPersonForQueries
string
object (v2SubmitEmployerReferenceAnswers)
object (v2SubmitLandlordReferenceAnswers)
notes
string

Responses

Request samples

Content type
application/json
{
  • "contactPersonForQueries": "string",
  • "employerAnswers": {
    },
  • "landlordAnswers": {
    },
  • "notes": "string"
}

Response samples

Content type
application/json
{ }

Set request checklist

Replaces the full checklist on the given requests with the provided checklist values.

Request Body schema: application/json
required
required
object (v2Checklist)
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "checklist": {
    },
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Mark requests as favorite

Marks the given requests as favorite.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Clear favorite on requests

Clears the favorite flag on the given requests.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Delete requests

Deletes the requests with the given IDs.

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

Add guarantors to a request

Adds the given guarantors to the request identified by ID and returns the updated request.

path Parameters
id
required
string
Request Body schema: application/json
required
Array of objects (v2Guarantor)

Responses

Request samples

Content type
application/json
{
  • "guarantors": [
    ]
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

Add requesters to a request

Adds the given requesters to the request identified by ID and returns the updated request.

path Parameters
id
required
string
Request Body schema: application/json
required
Array of objects (v2Requester)

Responses

Request samples

Content type
application/json
{
  • "requesters": [
    ]
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

Move a request to another object

Moves the request to the given target object ID and returns the updated request.

path Parameters
id
required
string
Request Body schema: application/json
required
objectId
string

Responses

Request samples

Content type
application/json
{
  • "objectId": "string"
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

Remove requesters from a request

Removes requesters identified by contact IDs from the request and returns the updated request.

path Parameters
id
required
string
Request Body schema: application/json
required
contactIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ]
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

Request employer reference by email

Sends a digital employer reference request email for the given contact on the request. Optional language selects the email/form template. Returns the updated employer reference.

path Parameters
id
required
string
Request Body schema: application/json
required
contactId
string
language
string

Optional. Language for the email template / form. Falls back to account/marketing language.

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "employerReference": {
    }
}

Request landlord reference by email

Sends a digital landlord reference request email for the given contact on the request. Optional language selects the email/form template. Returns the updated landlord reference.

path Parameters
id
required
string
Request Body schema: application/json
required
contactId
string
language
string

Optional. Language for the email template / form. Falls back to account/marketing language.

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "landlordReference": {
    }
}

Reserve a request for tenancies

Reserves the request for the given tenancy IDs.

path Parameters
id
required
string
Request Body schema: application/json
required
tenancyId
string

DO NOT USE! Deprecated. Use tenancyIds

tenancyIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tenancyId": "string",
  • "tenancyIds": [
    ]
}

Response samples

Content type
application/json
{ }

Set employer reference on a request

Sets the employer reference for the given requester or guarantor contact on the request. Optionally generates a PDF in the specified language.

path Parameters
id
required
string
Request Body schema: application/json
required
contactId
string
object (v2EmployerReference)
generatePdf
boolean
language
string

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "employerReference": {
    },
  • "generatePdf": true,
  • "language": "string"
}

Response samples

Content type
application/json
{ }

Finalize employer reference

Sets or clears the finalized flag on the employer reference for the given requester or guarantor contact.

path Parameters
id
required
string
Request Body schema: application/json
required
contactId
string

Requester or guarantor contact ID whose employer reference is finalized.

finalized
boolean

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "finalized": true
}

Response samples

Content type
application/json
{ }

Set landlord reference on a request

Sets the landlord reference for the given requester or guarantor contact on the request. Optionally generates a PDF in the specified language.

path Parameters
id
required
string
Request Body schema: application/json
required
contactId
string
generatePdf
boolean
object (v2LandlordReference)
language
string

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "generatePdf": true,
  • "landlordReference": {
    },
  • "language": "string"
}

Response samples

Content type
application/json
{ }

Finalize landlord reference

Sets or clears the finalized flag on the landlord reference for the given requester or guarantor contact.

path Parameters
id
required
string
Request Body schema: application/json
required
contactId
string

Requester or guarantor contact ID whose landlord reference is finalized.

finalized
boolean

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "finalized": true
}

Response samples

Content type
application/json
{ }