Landlords API
Manages landlord accounts.
Headers
As API is working with JSON every request must add the following headers:
Accept: application/jsonAnd for request with body:
Content-Type: application/jsonAccounts ¶
Accounts ¶
View all accounts by criteriaGET/landlords/accounts{?ids,email,accountName,contactPhone,page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/landlords/accounts?ids=3c2e15d7-ba6e-4995-aa19-a00267ca36dd&email=info@landlords.com&accountName=Landlords&contactPhone=+3499999999&page=1&itemsPerPage=10
URI Parameters
- ids
array[string](optional) Example: 3c2e15d7-ba6e-4995-aa19-a00267ca36ddCriteria by ids.
string(optional) Example: info@landlords.comCriteria by email.
- accountName
string(optional) Example: LandlordsCriteria by account name.
- contactPhone
string(optional) Example: +3499999999Criteria by contact phone.
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 10
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 2,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/accounts?page=1"
},
"first": {
"href": "/api/landlords/accounts?page=1"
},
"last": {
"href": "/api/landlords/accounts?page=2"
},
"next": {
"href": "/api/landlords/accounts?page=1"
},
"previous": {
"href": "/api/landlords/accounts?page=2"
}
},
"_embedded": {
"sah:accounts": [
{
"id": "3c2e15d7-ba6e-4995-aa19-a00267ca36dd",
"uuid": "80b3d33b-6632-4e60-9auy-4c32342a0b1b",
"userId": "3c2e15d7-ba6e-4995-aa19-a00267ca36dd",
"accountName": "Landlords S.L.",
"accountEmail": "info@landlords.com",
"locale": "es",
"website": "http://spotahome.com",
"commission": {
"type": "percentage",
"value": "0"
},
"type": "property_manager",
"notes": "Some note",
"fees": [
{
"feeType": "fixed",
"feeValue": "20000"
}
],
"contractType": "monthly",
"downPaymentType": "monthly",
"downPaymentValue": "null",
"tenantBookingContact": {
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
},
"financeContact": {
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
},
"policies": [
{
"locale": "en",
"policies": "This is the policy"
}
],
"bookingAcceptanceTimePreferences": {
"maxGapBetweenBookings": {
"days": "null"
},
"bookingAcceptanceDaysRange": {
"minDays": "null",
"maxDays": "null"
}
},
"cancellationPolicy": "standard",
"accountClassification": "opportunistic",
"assignedAccountManagerId": "unassigned",
"assignedAccountManager": "unassigned",
"isActive": false,
"contacts": [
{
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
}
],
"bookingContact": {
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
},
"isOwnedBySpotahome": true,
"accounting": {
"creationUser": "bc-listings@spotahome.com",
"firstBookingConfirmationRequestEmailDate": "2016-09-07T15:23:47+00:00",
"firstBookingConfirmationRequestSmsDate": "2016-09-07T15:25:16+00:00",
"firstListingPublicationDate": "2014-06-05T12:55:29+00:00",
"lastUpdateAvailabilitiesNotificationDate": "null",
"firstBookingAccepted": {
"acceptanceDate": "2014-06-16T08:29:04+00:00",
"bookingRequestId": "37313"
}
},
"contractProvision": "unknown",
"preferredCommunicationChannel": "no_preference",
"numberPublishedListings`": 5,
"totalRentableUnits": 15,
"totalProperties": 7,
"technology": "no_technology",
"transferTiming": "booking_confirmation",
"otherPlatformsUsage": "classified",
"officeHours": {
"weekdays": {
"start": "18:00"
},
"weekend": {
"start": "16:00"
}
},
"activationStage": "converted",
"consentForClassifieds": false,
"cityId": "madrid",
"leadSource": "callMeBack",
"accountPlan": "standard",
"planCommissions": [
{
"plan": "standard",
"commission": 1200
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"uuid": {
"type": "string"
},
"userId": {
"type": "string"
},
"accountName": {
"type": "string"
},
"accountEmail": {
"type": "string"
},
"locale": {
"type": "string"
},
"website": {
"type": [
"string",
"null"
]
},
"commission": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"type": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"fees": {
"type": "array"
},
"contractType": {
"type": "string"
},
"downPaymentType": {
"type": "string"
},
"downPaymentValue": {
"type": [
"string",
"null"
]
},
"tenantBookingContact": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"firstName",
"lastName",
"email",
"phone"
]
},
"financeContact": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"firstName",
"lastName",
"email",
"phone"
]
},
"policies": {
"type": [
"array",
"null"
]
},
"bookingAcceptanceTimePreferences": {
"type": "object",
"properties": {
"maxGapBetweenBookings": {
"type": "object",
"properties": {
"days": {
"type": "string"
}
}
},
"bookingAcceptanceDaysRange": {
"type": "object",
"properties": {
"minDays": {
"type": "string"
},
"maxDays": {
"type": "string"
}
}
}
}
},
"cancellationPolicy": {
"type": "string"
},
"accountClassification": {
"type": "string"
},
"assignedAccountManagerId": {
"type": "string"
},
"assignedAccountManager": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"contacts": {
"type": "array"
},
"bookingContact": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"firstName",
"lastName",
"email",
"phone"
]
},
"isOwnedBySpotahome": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {
"creationUser": {
"type": "string"
},
"firstBookingConfirmationRequestEmailDate": {
"type": "string"
},
"firstBookingConfirmationRequestSmsDate": {
"type": "string"
},
"firstListingPublicationDate": {
"type": "string"
},
"lastUpdateAvailabilitiesNotificationDate": {
"type": "string"
},
"firstBookingAccepted": {
"type": "object",
"properties": {
"acceptanceDate": {
"type": "string"
},
"bookingRequestId": {
"type": "string"
}
}
}
}
},
"contractProvision": {
"type": "string"
},
"preferredCommunicationChannel": {
"type": "string"
},
"numberPublishedListings`": {
"type": "number"
},
"totalRentableUnits": {
"type": "number"
},
"totalProperties": {
"type": "number"
},
"technology": {
"type": "string"
},
"transferTiming": {
"type": "string"
},
"otherPlatformsUsage": {
"type": "string"
},
"officeHours": {
"type": "object",
"properties": {
"weekdays": {
"type": [
"object",
"null"
],
"properties": {
"start": {
"type": [
"string",
"null"
]
}
}
},
"weekend": {
"type": [
"object",
"null"
],
"properties": {
"start": {
"type": [
"string",
"null"
]
}
}
}
},
"required": [
"weekdays",
"weekend"
]
},
"activationStage": {
"type": "string"
},
"consentForClassifieds": {
"type": "boolean"
},
"cityId": {
"type": "string"
},
"leadSource": {
"type": [
"string",
"null"
],
"enum": [
"callMeBack",
"display-programmatic",
"display-prospecting",
"display-retargeting",
"emailing",
"event",
"facebookAds",
"offlineMarketingCampaigns",
"organic",
"other",
"partner",
"premium",
"referral",
"select",
"self-service",
"sem",
"socialMediaGroups",
"webClassified",
null
]
},
"accountPlan": {
"type": "string"
},
"planCommissions": {
"type": "array"
}
},
"required": [
"id",
"uuid",
"userId",
"accountName",
"accountEmail",
"locale",
"website",
"commission",
"type",
"notes",
"fees",
"contractType",
"downPaymentType",
"downPaymentValue",
"tenantBookingContact",
"financeContact",
"policies",
"bookingAcceptanceTimePreferences",
"cancellationPolicy",
"accountClassification",
"assignedAccountManagerId",
"assignedAccountManager",
"isActive",
"contacts",
"bookingContact",
"isOwnedBySpotahome",
"accounting",
"contractProvision",
"preferredCommunicationChannel",
"numberPublishedListings`",
"totalRentableUnits",
"totalProperties",
"technology",
"transferTiming",
"otherPlatformsUsage",
"officeHours",
"activationStage",
"consentForClassifieds",
"cityId",
"leadSource",
"accountPlan"
]
}
}
}
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Create single accountPOST/landlords/accounts
Example URI
POST https://monolith.spotahome.com/api/landlords/accounts
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"accountName": "RealEstate SL",
"accountEmail": "info@john.com",
"accountType": "private",
"phone": "+34656889887",
"contactFirstName": "John",
"contactLastName": "Doe",
"cityId": "madrid",
"locale": "es",
"isNotifiable": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"accountName": {
"type": "string"
},
"accountEmail": {
"type": "string"
},
"accountType": {
"type": "string",
"enum": [
"private",
"real_estate_agency",
"property_manager",
"subletter"
]
},
"phone": {
"type": "string"
},
"contactFirstName": {
"type": "string"
},
"contactLastName": {
"type": "string"
},
"cityId": {
"type": "string"
},
"locale": {
"type": "string"
},
"isNotifiable": {
"type": "boolean",
"description": "send invitation email"
}
},
"required": [
"accountName",
"accountEmail",
"accountType",
"phone",
"contactFirstName",
"contactLastName",
"cityId",
"locale"
]
}Response
201Headers
Content-Type: application/json
Location: /api/landlords/accounts/aaaa-bbbb-cccc-ddddResponse
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account changelog ¶
Get account changelog by criteriaGET/landlords/accounts/changes{?page,itemsPerPage,accountId}
Example URI
GET https://monolith.spotahome.com/api/landlords/accounts/changes?page=1&itemsPerPage=1&accountId=aaaa-bbbb-cccc-dddd
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 1- accountId
string(optional) Example: aaaa-bbbb-cccc-dddd
Request
Headers
Authorization: aa.bb.cc
Requester: agent@spotahome.comResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/landlords/accounts/changes?page=1"
},
"first": {
"href": "/landlords/accounts/changes?page=1"
},
"last": {
"href": "/landlords/accounts/changes?page=2"
},
"next": {
"href": "/landlords/accounts/changes?page=1"
},
"previous": {
"href": "/landlords/accounts/changes?page=2"
}
},
"_embedded": {
"accountChanges": [
{
"id": "aaaa-bbbb-cccc-dddd",
"accountId": "aaaa-bbbb-cccc-dddd",
"changedBy": "agent@spotahome",
"userFullName": "User FullName",
"before": "\"{\\\"data\\\":\\\"before value\\\"}",
"after": "\"{\\\"data\\\":\\\"after value\\\"}",
"type": "Sah\\Domain\\EventWasOccurred",
"occurredOn": "2017-09-09T15:59:43+00:00"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"accountChanges": {
"type": "array"
}
}
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Single account ¶
Fetch single accountGET/landlords/accounts/{id}
Example URI
GET https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an account.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"id": "3c2e15d7-ba6e-4995-aa19-a00267ca36dd",
"uuid": "80b3d33b-6632-4e60-9auy-4c32342a0b1b",
"userId": "3c2e15d7-ba6e-4995-aa19-a00267ca36dd",
"accountName": "Landlords S.L.",
"accountEmail": "info@landlords.com",
"locale": "es",
"website": "http://spotahome.com",
"commission": {
"type": "percentage",
"value": "0"
},
"type": "property_manager",
"notes": "Some note",
"fees": [
{
"feeType": "fixed",
"feeValue": "20000"
}
],
"contractType": "monthly",
"downPaymentType": "monthly",
"downPaymentValue": "null",
"tenantBookingContact": {
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
},
"financeContact": {
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
},
"policies": [
{
"locale": "en",
"policies": "This is the policy"
}
],
"bookingAcceptanceTimePreferences": {
"maxGapBetweenBookings": {
"days": "null"
},
"bookingAcceptanceDaysRange": {
"minDays": "null",
"maxDays": "null"
}
},
"cancellationPolicy": "standard",
"accountClassification": "opportunistic",
"assignedAccountManagerId": "unassigned",
"assignedAccountManager": "unassigned",
"isActive": false,
"contacts": [
{
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
}
],
"bookingContact": {
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
},
"isOwnedBySpotahome": true,
"accounting": {
"creationUser": "bc-listings@spotahome.com",
"firstBookingConfirmationRequestEmailDate": "2016-09-07T15:23:47+00:00",
"firstBookingConfirmationRequestSmsDate": "2016-09-07T15:25:16+00:00",
"firstListingPublicationDate": "2014-06-05T12:55:29+00:00",
"lastUpdateAvailabilitiesNotificationDate": "null",
"firstBookingAccepted": {
"acceptanceDate": "2014-06-16T08:29:04+00:00",
"bookingRequestId": "37313"
}
},
"contractProvision": "unknown",
"preferredCommunicationChannel": "no_preference",
"numberPublishedListings`": 5,
"totalRentableUnits": 15,
"totalProperties": 7,
"technology": "no_technology",
"transferTiming": "booking_confirmation",
"otherPlatformsUsage": "classified",
"officeHours": {
"weekdays": {
"start": "18:00"
},
"weekend": {
"start": "16:00"
}
},
"activationStage": "converted",
"consentForClassifieds": false,
"cityId": "madrid",
"leadSource": "callMeBack",
"accountPlan": "standard",
"planCommissions": [
{
"plan": "standard",
"commission": 1200
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"uuid": {
"type": "string"
},
"userId": {
"type": "string"
},
"accountName": {
"type": "string"
},
"accountEmail": {
"type": "string"
},
"locale": {
"type": "string"
},
"website": {
"type": [
"string",
"null"
]
},
"commission": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"type": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"fees": {
"type": "array"
},
"contractType": {
"type": "string"
},
"downPaymentType": {
"type": "string"
},
"downPaymentValue": {
"type": [
"string",
"null"
]
},
"tenantBookingContact": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"firstName",
"lastName",
"email",
"phone"
]
},
"financeContact": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"firstName",
"lastName",
"email",
"phone"
]
},
"policies": {
"type": [
"array",
"null"
]
},
"bookingAcceptanceTimePreferences": {
"type": "object",
"properties": {
"maxGapBetweenBookings": {
"type": "object",
"properties": {
"days": {
"type": "string"
}
}
},
"bookingAcceptanceDaysRange": {
"type": "object",
"properties": {
"minDays": {
"type": "string"
},
"maxDays": {
"type": "string"
}
}
}
}
},
"cancellationPolicy": {
"type": "string"
},
"accountClassification": {
"type": "string"
},
"assignedAccountManagerId": {
"type": "string"
},
"assignedAccountManager": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"contacts": {
"type": "array"
},
"bookingContact": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"firstName",
"lastName",
"email",
"phone"
]
},
"isOwnedBySpotahome": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {
"creationUser": {
"type": "string"
},
"firstBookingConfirmationRequestEmailDate": {
"type": "string"
},
"firstBookingConfirmationRequestSmsDate": {
"type": "string"
},
"firstListingPublicationDate": {
"type": "string"
},
"lastUpdateAvailabilitiesNotificationDate": {
"type": "string"
},
"firstBookingAccepted": {
"type": "object",
"properties": {
"acceptanceDate": {
"type": "string"
},
"bookingRequestId": {
"type": "string"
}
}
}
}
},
"contractProvision": {
"type": "string"
},
"preferredCommunicationChannel": {
"type": "string"
},
"numberPublishedListings`": {
"type": "number"
},
"totalRentableUnits": {
"type": "number"
},
"totalProperties": {
"type": "number"
},
"technology": {
"type": "string"
},
"transferTiming": {
"type": "string"
},
"otherPlatformsUsage": {
"type": "string"
},
"officeHours": {
"type": "object",
"properties": {
"weekdays": {
"type": [
"object",
"null"
],
"properties": {
"start": {
"type": [
"string",
"null"
]
}
}
},
"weekend": {
"type": [
"object",
"null"
],
"properties": {
"start": {
"type": [
"string",
"null"
]
}
}
}
},
"required": [
"weekdays",
"weekend"
]
},
"activationStage": {
"type": "string"
},
"consentForClassifieds": {
"type": "boolean"
},
"cityId": {
"type": "string"
},
"leadSource": {
"type": [
"string",
"null"
],
"enum": [
"callMeBack",
"display-programmatic",
"display-prospecting",
"display-retargeting",
"emailing",
"event",
"facebookAds",
"offlineMarketingCampaigns",
"organic",
"other",
"partner",
"premium",
"referral",
"select",
"self-service",
"sem",
"socialMediaGroups",
"webClassified",
null
]
},
"accountPlan": {
"type": "string"
},
"planCommissions": {
"type": "array"
}
},
"required": [
"id",
"uuid",
"userId",
"accountName",
"accountEmail",
"locale",
"website",
"commission",
"type",
"notes",
"fees",
"contractType",
"downPaymentType",
"downPaymentValue",
"tenantBookingContact",
"financeContact",
"policies",
"bookingAcceptanceTimePreferences",
"cancellationPolicy",
"accountClassification",
"assignedAccountManagerId",
"assignedAccountManager",
"isActive",
"contacts",
"bookingContact",
"isOwnedBySpotahome",
"accounting",
"contractProvision",
"preferredCommunicationChannel",
"numberPublishedListings`",
"totalRentableUnits",
"totalProperties",
"technology",
"transferTiming",
"otherPlatformsUsage",
"officeHours",
"activationStage",
"consentForClassifieds",
"cityId",
"leadSource",
"accountPlan"
]
}Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/jsonBody
{
"detail": "Forbidden access",
"status": 403,
"title": "Forbidden",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Update single accommodation providerPUT/landlords/accounts/{id}
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an account.
Request
Headers
Content-Type: application/json
Requester: "requester@spotahome.com"Body
{
"accountName": "name",
"accountEmail": "info@landlords.com",
"website": "http://spotahome.com",
"policies": "This is the policy",
"commission": {
"type": "fixed",
"value": 2
},
"locale": "es",
"notes": "note",
"type": "private",
"feeValue": 7,
"feeType": "fixed",
"contractType": "daily",
"downPaymentType": "monthly",
"downPaymentValue": 5,
"cancellationPolicy": "standard",
"accountClassification": "key",
"assignedAccountManager": "unassigned",
"firstName": "first",
"lastName": "last",
"phone": "+34690377481",
"email": "email@email.es",
"address": "fake st.",
"zipCode": "12345",
"contractProvision": "yes",
"preferredCommunicationChannel": "phone",
"numberPublishedListings": 5,
"totalRentableUnits": 15,
"totalProperties": 25,
"technology": "no_technology",
"transferTiming": "post_check_in",
"otherPlatformsUsage": "not_applicable",
"officeHours": {
"weekdays": {
"start": "08:00",
"end": "18:00"
},
"weekend": {
"start": "09:00",
"end": "16:00"
}
},
"activationStage": "converted",
"consentForClassifieds": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"accountName": {
"type": "string"
},
"accountEmail": {
"type": "string"
},
"website": {
"type": [
"string",
"null"
]
},
"policies": {
"type": [
"string",
"null"
]
},
"commission": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"type",
"value"
]
},
"locale": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"enum": [
"private",
"property_manager",
"real_estate_agency",
"subletter"
]
},
"feeValue": {
"type": "number"
},
"feeType": {
"type": "string",
"enum": [
"fixed",
"percentual",
"empty"
]
},
"contractType": {
"type": "string",
"enum": [
"daily",
"monthly",
"fortnightly"
]
},
"downPaymentType": {
"type": "string",
"enum": [
"monthly",
"weekly"
]
},
"downPaymentValue": {
"type": "number"
},
"cancellationPolicy": {
"type": "string",
"enum": [
"standard",
"flexible",
"strict"
]
},
"accountClassification": {
"type": "string",
"enum": [
"key",
"key_development",
"maintenance",
"opportunistic"
]
},
"assignedAccountManager": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"address": {
"type": "string"
},
"zipCode": {
"type": "string"
},
"contractProvision": {
"type": "string",
"enum": [
"yes",
"no",
"unknown"
]
},
"preferredCommunicationChannel": {
"type": "string",
"enum": [
"phone",
"email",
"whatsapp",
"no_preference"
]
},
"numberPublishedListings": {
"type": "number"
},
"totalRentableUnits": {
"type": "number"
},
"totalProperties": {
"type": "number"
},
"technology": {
"type": "string",
"enum": [
"no_technology",
"json_feed",
"channel_manager",
"pms",
"calendar",
"spreadsheet"
]
},
"transferTiming": {
"type": "string",
"enum": [
"post_check_in",
"booking_confirmation"
]
},
"otherPlatformsUsage": {
"type": "string",
"enum": [
"not_applicable",
"transactional",
"classified"
]
},
"officeHours": {
"type": "object",
"properties": {
"weekdays": {
"type": [
"object",
"null"
],
"properties": {
"start": {
"type": "string"
},
"end": {
"type": "string"
}
},
"required": [
"start",
"end"
]
},
"weekend": {
"type": [
"object",
"null"
],
"properties": {
"start": {
"type": "string"
},
"end": {
"type": "string"
}
},
"required": [
"start",
"end"
]
}
}
},
"activationStage": {
"type": "string"
},
"consentForClassifieds": {
"type": "boolean"
}
},
"required": [
"accountName",
"accountEmail",
"commission",
"locale",
"notes",
"type",
"feeValue",
"feeType",
"contractType",
"downPaymentType",
"downPaymentValue",
"cancellationPolicy",
"accountClassification",
"assignedAccountManager",
"firstName",
"lastName",
"phone",
"email",
"address",
"zipCode",
"contractProvision",
"preferredCommunicationChannel",
"numberPublishedListings",
"totalRentableUnits",
"totalProperties",
"technology",
"transferTiming",
"otherPlatformsUsage",
"officeHours",
"activationStage",
"consentForClassifieds"
]
}Response
204Headers
Content-Type: application/jsonResponse
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account basic details ¶
Update single account basic detailsPUT/landlords/accounts/{id}/basic-details
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/aaaa-bbbb-cccc-dddd/basic-details
URI Parameters
- id
string(required) Example: aaaa-bbbb-cccc-dddd
Request
Headers
Authorization: aa.bb.ccBody
{
"accountName": "name",
"accountEmail": "info@landlords.com",
"locale": "es",
"notes": "note"
}Schema
{
"type": "object",
"properties": {
"accountName": {
"type": "string"
},
"accountEmail": {
"type": "string"
},
"locale": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"accountName",
"accountEmail",
"locale",
"notes"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Headers
Content-Type: application/jsonResponse
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Logged landlord account ¶
Fetch logged landlord accountGET/landlords/accounts/me
Example URI
GET https://monolith.spotahome.com/api/landlords/accounts/me
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"id": "3c2e15d7-ba6e-4995-aa19-a00267ca36dd",
"uuid": "80b3d33b-6632-4e60-9auy-4c32342a0b1b",
"userId": "3c2e15d7-ba6e-4995-aa19-a00267ca36dd",
"accountName": "Landlords S.L.",
"accountEmail": "info@landlords.com",
"locale": "es",
"website": "http://spotahome.com",
"commission": {
"type": "percentage",
"value": "0"
},
"type": "property_manager",
"notes": "Some note",
"fees": [
{
"feeType": "fixed",
"feeValue": "20000"
}
],
"contractType": "monthly",
"downPaymentType": "monthly",
"downPaymentValue": "null",
"tenantBookingContact": {
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
},
"financeContact": {
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
},
"policies": [
{
"locale": "en",
"policies": "This is the policy"
}
],
"bookingAcceptanceTimePreferences": {
"maxGapBetweenBookings": {
"days": "null"
},
"bookingAcceptanceDaysRange": {
"minDays": "null",
"maxDays": "null"
}
},
"cancellationPolicy": "standard",
"accountClassification": "opportunistic",
"assignedAccountManagerId": "unassigned",
"assignedAccountManager": "unassigned",
"isActive": false,
"contacts": [
{
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
}
],
"bookingContact": {
"id": 160,
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
},
"isOwnedBySpotahome": true,
"accounting": {
"creationUser": "bc-listings@spotahome.com",
"firstBookingConfirmationRequestEmailDate": "2016-09-07T15:23:47+00:00",
"firstBookingConfirmationRequestSmsDate": "2016-09-07T15:25:16+00:00",
"firstListingPublicationDate": "2014-06-05T12:55:29+00:00",
"lastUpdateAvailabilitiesNotificationDate": "null",
"firstBookingAccepted": {
"acceptanceDate": "2014-06-16T08:29:04+00:00",
"bookingRequestId": "37313"
}
},
"contractProvision": "unknown",
"preferredCommunicationChannel": "no_preference",
"numberPublishedListings`": 5,
"totalRentableUnits": 15,
"totalProperties": 7,
"technology": "no_technology",
"transferTiming": "booking_confirmation",
"otherPlatformsUsage": "classified",
"officeHours": {
"weekdays": {
"start": "18:00"
},
"weekend": {
"start": "16:00"
}
},
"activationStage": "converted",
"consentForClassifieds": false,
"cityId": "madrid",
"leadSource": "callMeBack",
"accountPlan": "standard",
"planCommissions": [
{
"plan": "standard",
"commission": 1200
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"uuid": {
"type": "string"
},
"userId": {
"type": "string"
},
"accountName": {
"type": "string"
},
"accountEmail": {
"type": "string"
},
"locale": {
"type": "string"
},
"website": {
"type": [
"string",
"null"
]
},
"commission": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"type": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"fees": {
"type": "array"
},
"contractType": {
"type": "string"
},
"downPaymentType": {
"type": "string"
},
"downPaymentValue": {
"type": [
"string",
"null"
]
},
"tenantBookingContact": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"firstName",
"lastName",
"email",
"phone"
]
},
"financeContact": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"firstName",
"lastName",
"email",
"phone"
]
},
"policies": {
"type": [
"array",
"null"
]
},
"bookingAcceptanceTimePreferences": {
"type": "object",
"properties": {
"maxGapBetweenBookings": {
"type": "object",
"properties": {
"days": {
"type": "string"
}
}
},
"bookingAcceptanceDaysRange": {
"type": "object",
"properties": {
"minDays": {
"type": "string"
},
"maxDays": {
"type": "string"
}
}
}
}
},
"cancellationPolicy": {
"type": "string"
},
"accountClassification": {
"type": "string"
},
"assignedAccountManagerId": {
"type": "string"
},
"assignedAccountManager": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"contacts": {
"type": "array"
},
"bookingContact": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"firstName",
"lastName",
"email",
"phone"
]
},
"isOwnedBySpotahome": {
"type": "boolean"
},
"accounting": {
"type": "object",
"properties": {
"creationUser": {
"type": "string"
},
"firstBookingConfirmationRequestEmailDate": {
"type": "string"
},
"firstBookingConfirmationRequestSmsDate": {
"type": "string"
},
"firstListingPublicationDate": {
"type": "string"
},
"lastUpdateAvailabilitiesNotificationDate": {
"type": "string"
},
"firstBookingAccepted": {
"type": "object",
"properties": {
"acceptanceDate": {
"type": "string"
},
"bookingRequestId": {
"type": "string"
}
}
}
}
},
"contractProvision": {
"type": "string"
},
"preferredCommunicationChannel": {
"type": "string"
},
"numberPublishedListings`": {
"type": "number"
},
"totalRentableUnits": {
"type": "number"
},
"totalProperties": {
"type": "number"
},
"technology": {
"type": "string"
},
"transferTiming": {
"type": "string"
},
"otherPlatformsUsage": {
"type": "string"
},
"officeHours": {
"type": "object",
"properties": {
"weekdays": {
"type": [
"object",
"null"
],
"properties": {
"start": {
"type": [
"string",
"null"
]
}
}
},
"weekend": {
"type": [
"object",
"null"
],
"properties": {
"start": {
"type": [
"string",
"null"
]
}
}
}
},
"required": [
"weekdays",
"weekend"
]
},
"activationStage": {
"type": "string"
},
"consentForClassifieds": {
"type": "boolean"
},
"cityId": {
"type": "string"
},
"leadSource": {
"type": [
"string",
"null"
],
"enum": [
"callMeBack",
"display-programmatic",
"display-prospecting",
"display-retargeting",
"emailing",
"event",
"facebookAds",
"offlineMarketingCampaigns",
"organic",
"other",
"partner",
"premium",
"referral",
"select",
"self-service",
"sem",
"socialMediaGroups",
"webClassified",
null
]
},
"accountPlan": {
"type": "string"
},
"planCommissions": {
"type": "array"
}
},
"required": [
"id",
"uuid",
"userId",
"accountName",
"accountEmail",
"locale",
"website",
"commission",
"type",
"notes",
"fees",
"contractType",
"downPaymentType",
"downPaymentValue",
"tenantBookingContact",
"financeContact",
"policies",
"bookingAcceptanceTimePreferences",
"cancellationPolicy",
"accountClassification",
"assignedAccountManagerId",
"assignedAccountManager",
"isActive",
"contacts",
"bookingContact",
"isOwnedBySpotahome",
"accounting",
"contractProvision",
"preferredCommunicationChannel",
"numberPublishedListings`",
"totalRentableUnits",
"totalProperties",
"technology",
"transferTiming",
"otherPlatformsUsage",
"officeHours",
"activationStage",
"consentForClassifieds",
"cityId",
"leadSource",
"accountPlan"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account type ¶
Update account typePUT/landlords/accounts/{id}/type
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/type
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12ID from an Account.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"type": "private"
}Response
204Headers
Content-Type: application/jsonResponse
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account plan ¶
Update account planPUT/landlords/accounts/{id}/plan
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/plan
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12ID from an Account.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"plan": "plus"
}Response
204Headers
Content-Type: application/jsonResponse
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Update account booking conditions by countryPOST/landlords/accounts/{id}/booking-conditions-by-country
Example URI
POST https://monolith.spotahome.com/api/landlords/accounts/aaaa-bbbb-cccc-dddd/booking-conditions-by-country
URI Parameters
- id
string(required) Example: aaaa-bbbb-cccc-dddd
Request
Headers
Authorization: aa.bb.ccBody
{
"{countryId}": {
"gapMinDays": 30,
"gapMaxDays": 60,
"contractType": "daily"
}
}Schema
{
"type": "object",
"properties": {
"{countryId}": {
"type": "object",
"properties": {
"gapMinDays": {
"type": [
"number",
"null"
]
},
"gapMaxDays": {
"type": [
"number",
"null"
]
},
"contractType": {
"type": [
"string",
"null"
]
}
}
}
},
"required": [
"{countryId}"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
201Headers
Content-Type: application/jsonResponse
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/jsonBody
{
"detail": "Forbidden access",
"status": 403,
"title": "Forbidden",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Accommodation provider booking acceptance time preferences ¶
Update accommodation provider booking acceptance time preferencesPUT/accommodation-providers/{id}/booking-acceptance-time-preferences
Example URI
PUT https://monolith.spotahome.com/api/accommodation-providers/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/booking-acceptance-time-preferences
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Accommodation Provider.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"days": "13",
"minDays": "1",
"maxDays": "16"
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Accommodation Provider integrations ¶
Accommodation provider iCalendar integration ¶
Enable the iCalendar integrationPUT/accommodation-providers/{id}/icalendar
Example URI
PUT https://monolith.spotahome.com/api/accommodation-providers/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/icalendar
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Accommodation Provider.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "Conflict",
"status": 409,
"detail": "Accommodation provider with ID aaaaaaaa-bbbb-4ccc-ddd-eeeeeeeeeeee is already integrated with icalendar."
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Accommodation Provider Types ¶
Accommodation provider types DEPRECATED ¶
Fetch all accommodation provider typesGET/accommodation-providers/types
Example URI
GET https://monolith.spotahome.com/api/accommodation-providers/types
Response
200Headers
Content-Type: application/jsonBody
[
"private",
"property_manager",
"real_estate_agency",
"subletter"
]Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account types ¶
Fetch all account typesGET/landlords/accounts/types
Example URI
GET https://monolith.spotahome.com/api/landlords/accounts/types
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/accounts/types?page=1"
},
"first": {
"href": "/api/landlords/accounts/types?page=1"
},
"last": {
"href": "/api/landlords/accounts/types?page=2"
},
"next": {
"href": "/api/landlords/accounts/types?page=1"
},
"previous": {
"href": "/api/landlords/accounts/types?page=2"
}
},
"_embedded": {
"sah:landlords:accounts:types": [
{
"type": "private"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:accounts:types": {
"type": "array"
}
}
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Contract Types ¶
Contract Types ¶
Fetch all contract typesGET/accommodation-providers/contract-types
Example URI
GET https://monolith.spotahome.com/api/accommodation-providers/contract-types
Response
200Headers
Content-Type: application/jsonBody
[
"daily",
"fortnightly",
"monthly"
]Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Cancellation Policies ¶
Cancellation Policies ¶
Fetch all cancellation policiesGET/accommodation-providers/cancellation-policies
Example URI
GET https://monolith.spotahome.com/api/accommodation-providers/cancellation-policies
Response
200Headers
Content-Type: application/jsonBody
[
"standard",
"flexible",
"strict"
]Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Contacts ¶
Contacts ¶
Create new contactPOST/landlords/accounts/{id}/contacts
Example URI
POST https://monolith.spotahome.com/api/landlords/accounts/id/contacts
URI Parameters
- id
string(required)Id from an Accommodation Provider.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc (string, required)
Location: aaaa-bbbb-cccc-ddddBody
{
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"firstName",
"lastName",
"email",
"phone"
]
}Response
201Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Single contact ¶
Update single contactPUT/landlords/accounts/{id}/contacts/{contactId}
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/contacts/5
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Account.
- contactId
number(required) Example: 5Id from an Account Contact.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc (string, required)Body
{
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"firstName",
"lastName",
"email",
"phone"
]
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Delete single contactDELETE/landlords/accounts/{id}/contacts/{contactId}
Example URI
DELETE https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/contacts/5
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Accommodation Provider.
- contactId
number(required) Example: 5Id from an Accommodation Provider Contact.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc (string, required)Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Reassign contact types ¶
Reassign contact typesPUT/landlords/accounts/{id}/contact-types
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/contact-types
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12An Account ID.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc (string, required)
Requester: requester@spotahome.com (string, optional)Body
{
"booking_manager": 123,
"tenant": 123,
"finance": 456
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_manager": {
"type": "number",
"description": "The ID of the booking manager contact"
},
"tenant": {
"type": "number",
"description": "The ID of the contact for tenants"
},
"finance": {
"type": "number",
"description": "The ID of the contacts for finance"
}
},
"required": [
"booking_manager",
"tenant",
"finance"
]
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Contacts DEPRECATED ¶
Contact ¶
Create accommodation provider contactPOST/accommodation-providers/{id}/contacts/
Example URI
POST https://monolith.spotahome.com/api/accommodation-providers/id/contacts/
URI Parameters
- id
string(required)Id from an Accommodation Provider.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc (string, required)
Requester: requester@spotahome.com (string, optional)Body
{
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"firstName",
"lastName",
"email",
"phone"
]
}Response
201Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Update accommodation provider contactPUT/accommodation-providers/{id}/contacts/{contactId}
Example URI
PUT https://monolith.spotahome.com/api/accommodation-providers/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/contacts/5
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Accommodation Provider.
- contactId
number(required) Example: 5Id from an Accommodation Provider Contact.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc (string, required)Body
{
"firstName": "John",
"lastName": "Doe",
"email": "info@john.com",
"phone": "+34656889887",
"address": "null",
"zipCode": "null",
"position": "null",
"notes": "null"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"string",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
}
},
"required": [
"firstName",
"lastName",
"email",
"phone"
]
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Delete accommodation provider contactDELETE/accommodation-providers/{id}/contacts/{contactId}
Example URI
DELETE https://monolith.spotahome.com/api/accommodation-providers/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/contacts/5
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Accommodation Provider.
- contactId
number(required) Example: 5Id from an Accommodation Provider Contact.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc (string, required)Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Accommodation provider contact types ¶
Reassign contact typesPUT/accommodation-providers/{id}/contact-types
Example URI
PUT https://monolith.spotahome.com/api/accommodation-providers/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/contact-types
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Accommodation Provider.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc (string, required)
Requester: requester@spotahome.com (string, optional)Body
{
"booking_manager": 123,
"tenant": 123,
"finance": 456
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"booking_manager": {
"type": "number",
"description": "The ID of the booking manager contact"
},
"tenant": {
"type": "number",
"description": "The ID of the contact for tenants"
},
"finance": {
"type": "number",
"description": "The ID of the contacts for finance"
}
},
"required": [
"booking_manager",
"tenant",
"finance"
]
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Agents ¶
Single agent ¶
Fetch single agentGET/landlords/agents/{id}
Example URI
GET https://monolith.spotahome.com/api/landlords/agents/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an agent.
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"id": "aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12",
"fullName": "Bender Bending Rodríguez",
"email": "bender@planetexpress.com",
"enabled": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"fullName": {
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"id",
"fullName",
"email",
"enabled"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Agents ¶
View all agentsGET/landlords/agents{?ids,email,enabled,page,itemsPerPage,sort}
Example URI
GET https://monolith.spotahome.com/api/landlords/agents?ids=3c2e15d7-ba6e-4995-aa19-a00267ca36dd&email=info@spotahome.com&enabled=true&page=1&itemsPerPage=100&sort=_id,fullName,email,enabled
URI Parameters
- ids
array[string](optional) Example: 3c2e15d7-ba6e-4995-aa19-a00267ca36ddCriteria by ids.
string(optional) Example: info@spotahome.com- enabled
boolean(optional) Example: true- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 100- sort
string(optional) Example: _id,fullName,email,enabledWithout symbol
fullName(ascending), with negative symbol-fullName(descending)
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/agents?page=1&itemsPerPage=20"
},
"first": {
"href": "/api/landlords/agents?page=1&itemsPerPage=20"
},
"last": {
"href": "`/api/landlords/agents?page=2&itemsPerPage=20"
},
"next": {
"href": "/api/landlords/agents?page=2&itemsPerPage=20"
},
"previous": {
"href": "/api/landlords/agents?page=1&itemsPerPage=20"
}
},
"_embedded": {
"sah:landlords:agents": [
{
"id": "aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12",
"fullName": "Bender Bending Rodríguez",
"email": "bender@planetexpress.com",
"enabled": true
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:agents": {
"type": "array"
}
},
"required": [
"sah:landlords:agents"
]
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Agents DEPRECATED ¶
Single agent ¶
Fetch single agentGET/agents/{id}
Example URI
GET https://monolith.spotahome.com/api/agents/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an agent.
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"id": "aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12",
"fullName": "Bender Bending Rodríguez",
"email": "bender@planetexpress.com",
"enabled": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"fullName": {
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"id",
"fullName",
"email",
"enabled"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Agents ¶
View all agentsGET/agents{?ids,email,enabled,page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/agents?ids=3c2e15d7-ba6e-4995-aa19-a00267ca36dd&email=info@spotahome.com&enabled=true&page=1&itemsPerPage=100
URI Parameters
- ids
array[string](optional) Example: 3c2e15d7-ba6e-4995-aa19-a00267ca36ddCriteria by ids.
string(optional) Example: info@spotahome.com- enabled
boolean(optional) Example: true- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 100
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/agents?page=1&itemsPerPage=20"
},
"first": {
"href": "/api/agents?page=1&itemsPerPage=20"
},
"last": {
"href": "`/api/agents?page=2`&itemsPerPage=20"
},
"next": {
"href": "/api/agents?page=2&itemsPerPage=20"
},
"previous": {
"href": "/api/agents?page=1&itemsPerPage=20"
}
},
"_embedded": {
"sah:agents": [
{
"id": "aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12",
"fullName": "Bender Bending Rodríguez",
"email": "bender@planetexpress.com",
"enabled": true
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:agents": {
"type": "array"
}
},
"required": [
"sah:agents"
]
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Contact Types ¶
Contact Types ¶
Fetch all contact typesGET/landlords/accounts/contacts/types
Example URI
GET https://monolith.spotahome.com/api/landlords/accounts/contacts/types
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Legacy Contact Types ¶
Fetch all contact typesGET/accommodation-providers/contact-types
Example URI
GET https://monolith.spotahome.com/api/accommodation-providers/contact-types
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
[
"booking_manager",
"tenant",
"finance"
]Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Policies ¶
Policies ¶
Update accommodation provider policiesPUT/accommodation-providers/{id}/policies
Example URI
PUT https://monolith.spotahome.com/api/accommodation-providers/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/policies
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Accommodation Provider.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"policies": "* Speaks English: yes\\n* Lives on property: no\\n* Deposit: 1 month’s rent\\n* Minimum age for tenants: 18\\n* Maximum age for tenants: 35\\n* Payment method: cash; bank transaction; credit card \\n* Smoking: not permitted \\n* Pets: not permitted \\n \\n* Couples: rooms which permit couples will have a rent increase of between €60 and €90 per month when occupied by a couple\\n \\n* **Utilities limit** (Barcelona only): €90 per month \\n \\n* **15-day booking policy:**\\n* Your move-in date must be within 15 days of the availability date\\n* Example: If the previous tenant leaves on July 1, you must move in by July 15\\n\\n* **Fortnightly payment policy:** \\n * Move-in date is 1–15th: you pay the whole month's rent\\n * Move-in date is 16–31st: you pay half a month's rent\\n * Move-out date is 1–15th: you pay half a month's rent\\n * Move-out date is 16–31st: you pay the whole month's rent\\n\\n* **Documents required:**\\n * Copy of passport: yes\\n * Copy of study or work documents: yes\\n \\n* **Check-in policies:** (Madrid only) \\n * Monday–Friday, 15:00–19:00: free \\n * Monday–Friday, 19:00–22:00: €60 \\n * Weekends and Bank Holidays, 15:00–19:00: €90 \\n * Any other time: check-in not available\\n\\n* **Check-in policies:** (Barcelona only) \\n * Monday–Friday, 10:30–18:00: free \\n * Monday–Friday, 19:00–21:00: €70 \\n * Weekends and Bank Holidays, 15:00–19:00: €90 \\n * Any other time: check-in not available\\n\\n* **Additional fees:**\\n * Contract fee: half of one month's rent to be paid upon arrival\\n\\n* **More specific landlord policies:**\\n * Please check a sample of this Landlord's contract by ![staticPage 157 (clicking here)]"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"policies": {
"type": [
"string",
"null"
]
}
}
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account Additional Data ¶
Account Additional Data ¶
Create account additional dataPOST/landlords/accounts/additional-data
Example URI
POST https://monolith.spotahome.com/api/landlords/accounts/additional-data
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Requester: user@spotahome.comBody
{
"id": "'aaaaaaa8",
"data": {
"additionalLanguagesSpoken": "Spanish, French",
"deposit": "'halfMonth'",
"rentPaymentMethod": "'Credit'",
"typeOfTenantContractRegistration": "fixedAmount",
"valueOfTenantContractRegistration": 25,
"isDomiciliationPermitted": true,
"isAnmeldungPermitted": true,
"documentationRequired": "'DNI'",
"doesTheLandlordLiveOnTheProperty": false,
"landlordGender": "'Male'",
"landlordAge": 31,
"aboutLandlord": "'The landlord is always quick to help with any issue her tenants might have with the property'",
"hasCheckoutCleaningFee": true,
"checkoutCleaningFeeAmount": 50,
"hasCheckinCheckoutPolicies": true,
"checkinCheckoutLocation": "'Calle de Vizcaya, 12, 28045 Madrid'",
"earliestCheckinCheckoutTime": "'13:00/17:00'",
"latestCheckinCheckoutTime": "'13:00/17:00'",
"isWeekendHolidayOutOfHoursCheckinCheckoutPermitted": false,
"weekendHolidayCheckinCheckoutFeeAmount": 25
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "bbb4-ccc4-ddd4-eeeeeeeeee12' (string, required)"
},
"data": {
"type": "object",
"properties": {
"additionalLanguagesSpoken": {
"type": "string"
},
"deposit": {
"type": "string"
},
"rentPaymentMethod": {
"type": "string"
},
"typeOfTenantContractRegistration": {
"type": "string"
},
"valueOfTenantContractRegistration": {
"type": "number"
},
"isDomiciliationPermitted": {
"type": "boolean"
},
"isAnmeldungPermitted": {
"type": "boolean"
},
"documentationRequired": {
"type": "string"
},
"doesTheLandlordLiveOnTheProperty": {
"type": "boolean"
},
"landlordGender": {
"type": "string"
},
"landlordAge": {
"type": "number"
},
"aboutLandlord": {
"type": "string"
},
"hasCheckoutCleaningFee": {
"type": "boolean"
},
"checkoutCleaningFeeAmount": {
"type": "number"
},
"hasCheckinCheckoutPolicies": {
"type": "boolean"
},
"checkinCheckoutLocation": {
"type": "string"
},
"earliestCheckinCheckoutTime": {
"type": "string"
},
"latestCheckinCheckoutTime": {
"type": "string"
},
"isWeekendHolidayOutOfHoursCheckinCheckoutPermitted": {
"type": "boolean"
},
"weekendHolidayCheckinCheckoutFeeAmount": {
"type": "number"
}
}
}
},
"required": [
"data"
]
}Response
201Headers
Content-Type: application/jsonResponse
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}View additional dataGET/landlords/accounts/{id}/additional-data
Example URI
GET https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/additional-data
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Account.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Requester: user@spotahome.comResponse
200Headers
Content-Type: application/jsonBody
{
"id": "'aaaaaaa8",
"data": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "bbb4-ccc4-ddd4-eeeeeeeeee12' (string, required) - Id from an Account."
},
"data": {
"type": "object",
"properties": {}
}
},
"required": [
"data"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Update account additional dataPUT/landlords/accounts/{id}/additional-data
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/additional-data
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Account.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Requester: user@spotahome.comBody
{
"data": {
"additionalLanguagesSpoken": "Spanish, French",
"deposit": 400,
"rentPaymentMethod": "'Credit'",
"costOfTenantContractRegistration": 25,
"isDomiciliationPermitted": true,
"isAnmeldungPermitted": true,
"documentationRequired": "'DNI'",
"doesTheLandlordLiveOnTheProperty": false,
"landlordGender": "'Male'",
"landlordAge": 31,
"aboutLandlord": "'The landlord is always quick to help with any issue her tenants might have with the property'",
"hasCheckoutCleaningFee": true,
"checkoutCleaningFeeAmount": 50,
"hasCheckinCheckoutPolicies": true,
"checkinCheckoutLocation": "'Calle de Vizcaya, 12, 28045 Madrid'",
"earliestCheckinCheckoutTime": "'13:00/17:00'",
"latestCheckinCheckoutTime": "'13:00/17:00'",
"isWeekendHolidayOutOfHoursCheckinCheckoutPermitted": false,
"weekendHolidayCheckinCheckoutFeeAmount": 25
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"additionalLanguagesSpoken": {
"type": "string"
},
"deposit": {
"type": "number"
},
"rentPaymentMethod": {
"type": "string"
},
"costOfTenantContractRegistration": {
"type": "number"
},
"isDomiciliationPermitted": {
"type": "boolean"
},
"isAnmeldungPermitted": {
"type": "boolean"
},
"documentationRequired": {
"type": "string"
},
"doesTheLandlordLiveOnTheProperty": {
"type": "boolean"
},
"landlordGender": {
"type": "string"
},
"landlordAge": {
"type": "number"
},
"aboutLandlord": {
"type": "string"
},
"hasCheckoutCleaningFee": {
"type": "boolean"
},
"checkoutCleaningFeeAmount": {
"type": "number"
},
"hasCheckinCheckoutPolicies": {
"type": "boolean"
},
"checkinCheckoutLocation": {
"type": "string"
},
"earliestCheckinCheckoutTime": {
"type": "string"
},
"latestCheckinCheckoutTime": {
"type": "string"
},
"isWeekendHolidayOutOfHoursCheckinCheckoutPermitted": {
"type": "boolean"
},
"weekendHolidayCheckinCheckoutFeeAmount": {
"type": "number"
}
}
}
},
"required": [
"data"
]
}Response
204Headers
Content-Type: application/jsonResponse
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Languages ¶
Language ¶
View all supported languagesGET/landlords/languages{?page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/landlords/languages?page=1&itemsPerPage=100
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 100
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/languages?page=1"
},
"first": {
"href": "/api/landlords/languages?page=1"
},
"last": {
"href": "/api/landlords/languages?page=2"
},
"next": {
"href": "/api/landlords/languages?page=2"
},
"previous": {
"href": "/api/landlords/languages?page=1"
}
},
"_embedded": {
"sah:landlords:languages": [
{
"language": "english",
"locale": "en"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:languages": {
"type": "array"
}
},
"required": [
"sah:landlords:languages"
]
}
},
"required": [
"count",
"total",
"_links"
]
}Transfer Timings ¶
Transfer timings ¶
View all transfer timingsGET/landlords/transfer-timings
-
Parameters
- page: 1 (number, optional) - itemsPerPage: 100 (number, optional)
Example URI
GET https://monolith.spotahome.com/api/landlords/transfer-timings
Response
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/transfer-timings?page=1"
},
"first": {
"href": "/api/landlords/transfer-timings?page=1"
},
"last": {
"href": "/api/landlords/transfer-timings?page=2"
},
"next": {
"href": "/api/landlords/transfer-timings?page=2"
},
"previous": {
"href": "/api/landlords/transfer-timings?page=1"
}
},
"_embedded": {
"sah:landlords:transfer-timings": [
{
"type": "post_check_in"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:transfer-timings": {
"type": "array"
}
},
"required": [
"sah:landlords:transfer-timings"
]
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Other Platforms Usages ¶
Other platforms usages ¶
View all other platforms usagesGET/landlords/other-platforms-usages{?page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/landlords/other-platforms-usages?page=1&itemsPerPage=100
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 100
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/other-platforms-usages?page=1"
},
"first": {
"href": "/api/landlords/other-platforms-usages?page=1"
},
"last": {
"href": "/api/landlords/other-platforms-usages?page=2"
},
"next": {
"href": "/api/landlords/other-platforms-usages?page=2"
},
"previous": {
"href": "/api/landlords/other-platforms-usages?page=1"
}
},
"_embedded": {
"sah:landlords:other-platforms-usages": [
{
"platform": "transactional"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:other-platforms-usages": {
"type": "array"
}
},
"required": [
"sah:landlords:other-platforms-usages"
]
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Commission Types ¶
Commission types ¶
View all commission typesGET/landlords/commission-types{?page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/landlords/commission-types?page=1&itemsPerPage=100
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 100
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/commission-types?page=1"
},
"first": {
"href": "/api/landlords/commission-types?page=1"
},
"last": {
"href": "/api/landlords/commission-types?page=2"
},
"next": {
"href": "/api/landlords/commission-types?page=2"
},
"previous": {
"href": "/api/landlords/commission-types?page=1"
}
},
"_embedded": {
"sah:landlords:commission-types": [
{
"type": "fixed"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:commission-types": {
"type": "array"
}
},
"required": [
"sah:landlords:commission-types"
]
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Consents For Classifieds ¶
Consents for classifieds ¶
View all consents for classifiedsGET/landlords/consents-for-classifieds/{?page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/landlords/consents-for-classifieds/?page=1&itemsPerPage=100
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 100
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/consents-for-classifieds?page=1"
},
"first": {
"href": "/api/landlords/consents-for-classifieds?page=1"
},
"last": {
"href": "/api/landlords/consents-for-classifieds?page=2"
},
"next": {
"href": "/api/landlords/consent-for-classifieds?page=2"
},
"previous": {
"href": "/api/landlords/consents-for-classifieds?page=1"
}
},
"_embedded": {
"sah:landlords:consents-for-classifieds": [
{
"consent": true
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:consents-for-classifieds": {
"type": "array"
}
},
"required": [
"sah:landlords:consents-for-classifieds"
]
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Technologies ¶
Technologies ¶
View all technologiesGET/landlords/management-info/technologies{?page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/landlords/management-info/technologies?page=1&itemsPerPage=100
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 100
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/management-info/technologies?page=1"
},
"first": {
"href": "/api/landlords/management-info/technologies?page=1"
},
"last": {
"href": "/api/landlords/management-info/technologies?page=2"
},
"next": {
"href": "/api/landlords/management-info/technologies?page=2"
},
"previous": {
"href": "/api/landlords/management-info/technologies?page=1"
}
},
"_embedded": {
"sah:landlords:technologies": [
{
"type": "no_technology"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:technologies": {
"type": "array"
}
},
"required": [
"sah:landlords:technologies"
]
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Admin Fee ¶
Admin Fee Types ¶
View all admin fee typesGET/landlords/admin-fee-types{?page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/landlords/admin-fee-types?page=1&itemsPerPage=100
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 100
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/admin-fee-types?page=1"
},
"first": {
"href": "/api/landlords/admin-fee-types?page=1"
},
"last": {
"href": "/api/landlords/admin-fee-types?page=2"
},
"next": {
"href": "/api/landlords/admin-fee-types?page=2"
},
"previous": {
"href": "/api/landlords/admin-fee-types?page=1"
}
},
"_embedded": {
"sah:landlords:admin-fee-types": [
{
"type": "fixed"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:admin-fee-types": {
"type": "array"
}
},
"required": [
"sah:landlords:admin-fee-types"
]
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account Classifications ¶
Account Classifications ¶
Fetch all account classificationsGET/accommodation-providers/account-classifications
Example URI
GET https://monolith.spotahome.com/api/accommodation-providers/account-classifications
Response
200Headers
Content-Type: application/jsonBody
[
"key",
"key_development",
"maintenance",
"opportunistic"
]Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account classifications ¶
View all account classificationsGET/landlords/account-classifications{?page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/landlords/account-classifications?page=1&itemsPerPage=100
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 100
Request
Headers
Authorization: aa.bb.cc
Accept: application/jsonResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/landlords/account-classifications?page=1"
},
"first": {
"href": "/api/landlords/account-classifications?page=1"
},
"last": {
"href": "/api/landlords/account-classifications?page=2"
},
"next": {
"href": "/api/landlords/account-classifications?page=2"
},
"previous": {
"href": "/api/landlords/account-classifications?page=1"
}
},
"_embedded": {
"sah:landlords:account-classifications": [
{
"type": "key"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:account-classifications": {
"type": "array"
}
},
"required": [
"sah:landlords:account-classifications"
]
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account Activation Stages ¶
Account Activation Stages ¶
View all Account Activation StagesGET/landlords/account-activation-stages{?page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/landlords/account-activation-stages?page=1&itemsPerPage=1
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 1
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 4,
"_links": {
"self": {
"href": "/api/landlords/account-activation-stages?page=1"
},
"first": {
"href": "/api/landlords/account-activation-stages?page=1"
},
"last": {
"href": "/api/landlords/account-activation-stages?page=4"
},
"next": {
"href": "/api/landlords/account-activation-stages?page=2"
},
"previous": {
"href": "/api/landlords/account-activation-stages?page=1"
}
},
"_embedded": {
"sah:landlords:account-activation-stages": [
{
"stage": "converted"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:account-activation-stages": {
"type": "array"
}
},
"required": [
"sah:landlords:account-activation-stages"
]
}
},
"required": [
"count",
"total",
"_links",
"_embedded"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account Cancellation Policies ¶
Account Cancellation Policies ¶
View all Account Cancellation PoliciesGET/landlords/account-cancellation-policies{?page,itemsPerPage}
Example URI
GET https://monolith.spotahome.com/api/landlords/account-cancellation-policies?page=1&itemsPerPage=1
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 1
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 4,
"_links": {
"self": {
"href": "/api/landlords/account-cancellation-policies?page=1&itemsPerPage=1"
},
"first": {
"href": "/api/landlords/account-cancellation-policies?page=1&itemsPerPage=1"
},
"last": {
"href": "/api/landlords/account-cancellation-policies?page=4&itemsPerPage=1"
},
"next": {
"href": "/api/landlords/account-cancellation-policies?page=2&itemsPerPage=1"
},
"previous": {
"href": "/api/landlords/account-cancellation-policies?page=1&itemsPerPage=1"
}
},
"_embedded": {
"sah:landlords:account-cancellation-policies": [
{
"policy": "standard"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:landlords:account-cancellation-policies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"policy": {
"type": "string",
"enum": [
"standard",
"flexible",
"strict"
]
}
},
"required": [
"policy"
],
"additionalProperties": false
}
}
},
"required": [
"sah:landlords:account-cancellation-policies"
]
}
},
"required": [
"count",
"total",
"_links",
"_embedded"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Booking Conditions ¶
Booking Conditions ¶
Update account booking conditionsPUT/landlords/accounts/{id}/booking-conditions
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/booking-conditions
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Account.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"commissionType": "fixed",
"commissionValue": 1000,
"adminFeeType": "fixed",
"adminFeeValue": 10000,
"contractType": "daily",
"cancellationPolicy": "standard",
"bookingMaxDays": 40,
"bookingMinDays": 30
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"commissionType": {
"type": "string",
"enum": [
"fixed",
"percentage"
]
},
"commissionValue": {
"type": "number",
"description": "Value * 100. For example if we have 100 this value must be 10000"
},
"adminFeeType": {
"type": "string",
"enum": [
"fixed",
"percentual",
"empty"
]
},
"adminFeeValue": {
"type": "number",
"description": "Value * 100. For example if we have 100 this value must be 10000"
},
"contractType": {
"type": "string",
"enum": [
"daily",
"monthly",
"fortnightly"
]
},
"cancellationPolicy": {
"type": "string",
"enum": [
"standard",
"flexible",
"strict"
]
},
"bookingMaxDays": {
"type": [
"number",
"null"
]
},
"bookingMinDays": {
"type": [
"number",
"null"
]
}
},
"required": [
"commissionType",
"commissionValue",
"adminFeeType",
"adminFeeValue",
"contractType",
"cancellationPolicy"
]
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Management Info ¶
Management Info ¶
Update management infoPUT/landlords/accounts/{id}/management-info
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/management-info
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Account.
Request
Headers
Authorization: aa.bb.ccBody
{
"classification": "key",
"totalProperties": 10,
"totalRentableUnits": 10,
"technology": "no_technology",
"consentForClassifieds": true,
"otherPlatformsUsage": "transactional",
"transferTiming": "post_check_in",
"accountManagerId": "aaaa.bbbb.cccc.1111",
"activationStage": "converted"
}Schema
{
"type": "object",
"properties": {
"classification": {
"enum": [
"key",
"key_development",
"maintenance",
"opportunistic"
]
},
"totalProperties": {
"type": "number"
},
"totalRentableUnits": {
"type": "number"
},
"technology": {
"enum": [
"no_technology",
"json_feed",
"channel_manager",
"pms",
"calendar",
"spreadsheet"
]
},
"consentForClassifieds": {
"type": "boolean"
},
"otherPlatformsUsage": {
"enum": [
"transactional",
"classifieds",
"not_applicable"
]
},
"transferTiming": {
"enum": [
"post_check_in",
"booking_confirmation"
]
},
"accountManagerId": {
"type": "string"
},
"activationStage": {
"enum": [
"converted",
"published",
"onboarded",
"not_applicable"
]
}
},
"required": [
"classification",
"totalProperties",
"totalRentableUnits",
"technology",
"consentForClassifieds",
"otherPlatformsUsage",
"transferTiming",
"accountManagerId",
"activationStage"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Landlord Policies ¶
Landlord policies ¶
Update landlord canonical policiesPUT/landlords/accounts/{id}/canonical-policies
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12/canonical-policies
URI Parameters
- id
string(required) Example: aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12Id from an Account.
Request
Headers
Authorization: aa.bb.cc
Content-Type: application/jsonBody
{
"policies": "Landlord policies text"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"policies": {
"type": "string"
}
},
"required": [
"policies"
]
}Response
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/jsonBody
{
"detail": "Forbidden access",
"status": 403,
"title": "Forbidden",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Cities ¶
City ¶
View cityGET/cities/{cityId}
Example URI
GET https://monolith.spotahome.com/api/cities/madrid
URI Parameters
- cityId
string(required) Example: madridCity id.
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"id": "madrid",
"longName": "Madrid",
"countryId": "spain",
"defaultAccountCommissionType": "percentage",
"defaultAccountCommissionValue": 600
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"longName": {
"type": "string"
},
"countryId": {
"type": "string"
},
"defaultAccountCommissionType": {
"type": "string"
},
"defaultAccountCommissionValue": {
"type": "number"
}
},
"required": [
"id",
"longName",
"countryId",
"defaultAccountCommissionType",
"defaultAccountCommissionValue"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Countries ¶
City ¶
View countryGET/countries/{countryId}
Example URI
GET https://monolith.spotahome.com/api/countries/spain
URI Parameters
- countryId
string(required) Example: spainCountry id.
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"id": "uk",
"shortName": "UK",
"longName": "United Kingdom",
"longNameNative": "United Kingdom",
"iso3166": "United Kingdom of Great Britain and Northern Ireland",
"slug": "uk",
"vat": 0.21,
"zipcodeRegex": "^([Gg][Ii][Rr]$",
"iso": "GB",
"currencyId": 1,
"classifiedsEmail": {
"name": "Spotahome Classifieds UK",
"email": "classifieds.uk@spotahome.com"
},
"bookingsEmail": {
"name": "Spotahome Bookings United Kingdom",
"email": "bookings.uk@spotahome.com"
},
"locale": "en",
"visible": true,
"bookingsPhone": "+44 20 3808 6522"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"shortName": {
"type": "string"
},
"longName": {
"type": "string"
},
"longNameNative": {
"type": "string"
},
"iso3166": {
"type": "string"
},
"slug": {
"type": "string"
},
"vat": {
"type": "number"
},
"zipcodeRegex": {
"type": "string"
},
"iso": {
"type": "string"
},
"currencyId": {
"type": "number"
},
"classifiedsEmail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"name",
"email"
]
},
"bookingsEmail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"name",
"email"
]
},
"locale": {
"type": "string"
},
"visible": {
"type": "boolean"
},
"bookingsPhone": {
"type": "string"
}
},
"required": [
"id",
"shortName",
"longName",
"longNameNative",
"iso3166",
"slug",
"vat",
"zipcodeRegex",
"iso",
"currencyId",
"locale",
"visible",
"bookingsPhone"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Account Manager ¶
Account Manager ¶
Assign account managerPUT/landlords/accounts/{id}/account-managers
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/e1fdee4a/account-managers
URI Parameters
- id
string(required) Example: e1fdee4a8e4c-4e93-8b99-6fe3e7eb20be (string, required)
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"accountManagerId": "f0925c22"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"accountManagerId": {
"type": "string",
"description": "519f-4bda-bffb-767136aa5aa2 (string, nullable, required)"
}
}
}Response
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/jsonBody
{
"detail": "Forbidden access",
"status": 403,
"title": "Forbidden",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Lead Source ¶
Change lead sourcePUT/landlords/accounts/lead-source
Example URI
PUT https://monolith.spotahome.com/api/landlords/accounts/lead-source
Request
Headers
Content-Type: application/jsonBody
{
"leadSource": "offlineMarketingCampaigns"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"leadSource": {
"type": "string"
}
},
"required": [
"leadSource"
]
}Response
204Headers
Content-Type: application/jsonResponse
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Domain Events ¶
DefaultPoliciesWereChanged
{
"accountId": "845cd158-ea91-45f9-a30d-f4a1b7deb3aa",
"occurredOn": "2017-06-30T14:08:48+0000",
"content": {
"locale": "es",
"translationType": "automatic",
"translationProvider": "google",
"policies": "* Idiomas hablados: Ingl\\u00e9s, espa\\u00f1ol, franc\\u00e9s, alem\\u00e1n e italiano\\n* Vive en la propiedad: no\\n* Posibilidad de domiciliaci\\u00f3n: s\\u00ed\\n* M\\u00e9todo del pago: transacci\\u00f3n bancaria (orden permanente)\\n* Se permite fumar: no\\n* Se admiten animales dom\\u00e9sticos: no\\n* ** El inquilino debe proporcionar los siguientes documentos: **\\n\\u00a0* Fotocopia de pasaporte\\n\\u00a0* Contrato de trabajo\\n\\u00a0Schufa\\n\\u00a0* Copia de la orden permanente para el pago del alquiler\\n* No se permiten hu\\u00e9spedes a largo plazo\\n* Los inquilinos no pueden subarrendar"
}
}-
accountId (string, required)
-
occurredOn (string, required)
-
content (object, required)
- locale (string, required)
- translationType (enum[string], required)
- automatic
- manual
- translationProvider (string, nullable, required)
- policies (string, required)
AccountClassificationWasUpdated
{
"accountId": "6b953172-6777-4205-9a07-7808448adbb1",
"accountClassification": "key",
"occurredOn": "2017-04-28T09:46:02+0000"
}-
accountId (string, required)
-
accountClassification (string, required)
-
occurredOn (string, required)
AccountManagerWasAssigned
{
"accountId": "6b953172-6777-4205-9a07-7808448adbb1",
"accountManager: "lovelace@spotahome.com",
"occurredOn": {
"date": "2017-07-20 14:09:40.000000",
"timezone_type": 3,
"timezone": "UTC"
}
}-
accountId (string, required)
-
accountManager (string, required)
-
occurredOn (object, required)
- date (string, required)
- timezone_type (int, required)
- timezone (string, required)
AccountManagerWasUnassigned
{
"accountId": "6b953172-6777-4205-9a07-7808448adbb1",
"accountManager": "lovelace@spotahome.com",
"occurredOn": {
"date": "2017-07-20 14:09:40.000000",
"timezone_type": 3,
"timezone": "UTC"
}
}-
id (string, required)
-
accountManager (string, required)
-
occurredOn (object, required)
- date (string, required)
- timezone_type (int, required)
- timezone (string, required)
CancellationPolicyWasUpdated
{
"accountId": "6b953172-6777-4205-9a07-7808448adbb1",
"cancellationPolicy": "strict",
"occurredOn": "2017-07-20T09:36:48+0000"
}-
accountId (string, required)
-
cancellationPolicy (string, required)
-
occurredOn (string, required)
CommissionWasUpdated
{
"id": "6b953172-6777-4205-9a07-7808448adbb1",
"occurredOn": "2017-07-20T16:04:34+0000",
"type": "percentage",
"value": 0,
}-
id (string, required)
-
occurredOn (string, required)
-
type (enum[string], required)
- fixed
- percentage
-
value (number, required)
DownPaymentPreferenceWasUpdated
{
"accountId": "6b953172-6777-4205-9a07-7808448adbb1",
"occurredOn": "2017-07-20T15:59:09+0000",
"downPaymentPreference": {
"type": {
"type": "monthly"
}
}
}-
accountId (string, required)
-
occurredOn (string, required)
-
downPaymentPreference (object, required)
- type (object, required)
- type (enum[string], required)
- monthly
- weekly
- numberOfWeeks (number, optional)
- type (enum[string], required)
- type (object, required)
FirstListingWasPublished
{
"accountId": "6b953172-6777-4205-9a07-7808448adbb1",
"occurredOn": "2017-07-21T00:42:56+0000"
}-
accountId (string, required)
-
occurredOn (string, required)
ContractTypeWasChanged
{
"accountId": "6b953172-6777-4205-9a07-7808448adbb1",
"contractType": "daily",
"occurredOn": "2017-07-20T15:59:09+0000"
}-
accountId (string, required)
-
contractType (enum[string], required)
- daily
- fortnightly
- monthly
-
occurredOn (string, required)
UpdateAvailabilitiesNotificationWasSent
{
"accountId": "6b953172-6777-4205-9a07-7808448adbb1",
"occurredOn": "2017-07-20T19:30:10+0000"
}-
accountId (string, required)
-
occurredOn (string, required)
ContactTypesWereReassigned
{
"accountId": "6b953172-6777-4205-9a07-7808448adbb1",
"occurredOn": "2017-07-20T15:59:09+0000",
"assignation": {
"booking_manager": 200,
"tenant": 300,
"finance": 125
}
}-
accountId (string, required)
-
occurredOn (string, required)
-
assignation (object, required)
- booking_manager (number, required)
- tenant (number, required)
- finance (number, required)
AccountWasCreated
{
"accountId": "abcdef-123456",
"accountName": "Landlords S.L.",
"accountEmail": "landlords@bestflatsever.com",
"locale": "en",
"contractType": "daily",
"commission": {
"value": 1000,
"type": "fixed"
}
"type": "private",
"fees": {
"booking": {
"type": "fixed",
"value": 2500
}
},
"downPaymentPreference": {
"type": "monthly",
"numberOfWeeks": null
}
"totalRentableUnits": 5,
"totalProperties": 1,
"contactCollection": {
"contacts": [
{
"id": 15533,
"firstName": "pp",
"lastName": "pp",
"email": "pruebapru@gmail.com",
"phone": "+34690377481",
"address": "",
"zipCode": "",
"position": null,
"notes": "",
"accounting": {
"creationUser": "albertolopez@spotahome.com",
"updateUser": "albertolopez@spotahome.com",
"creationDate": "2017-07-27T09:18:08+0000",
"updateDate": "2017-07-27T09:18:08+0000"
},
"isDeleted": false
}
],
"contactTypesAssignation": {
"booking_manager": 15533,
"tenant": 15533,
"finance": 15533
}
},
"activationStage": "converted",
"occurredOn": "2017-07-21T12:48:44+0000",
"user": {
"email": "user@spotahome.com",
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"source": "outbound",
"isNotifiable": true,
"accountPlan": "standard"
}-
accountId (string, required)
-
accountName (string, required)
-
accountEmail (string, required)
-
locale (string, required)
-
commission (object, required)
- type (string, required)
- value (int, required)
-
type (string, required)
-
fees (object, required)
- booking (object, required)
- type (string, required)
- value (int, required)
- booking (object, required)
-
contractType (string, required)
-
downPaymentPreference (object, required)
- type (string, required)
- numberOfWeeks (number, nullable)
-
totalRentableUnits (number, required)
-
totalProperties (number, required)
-
contactCollection (object, required)
- contacts (array, required)
- (object)
- id (string, required)
- firstName (string, required)
- lastName (string, required)
- email (string, required)
- phone (string, required)
- address (string)
- zipCode (string)
- position (string)
- notes (string)
- accounting (object)
- creationUser (string, required)
- updateUser (string, required)
- creationDate (string, required)
- updateDate (string, required) -isDeleted (boolean, required)
- (object)
- contactTypesAssignation (object)
- booking_manager (number)
- tenant (number)
- finance (number)
- contacts (array, required)
-
occurredOn (string, required)
-
user (string, object)
- email (string, required, nullable)
- identity (string, required)
-
source (enum[string], required)
- inbound
- outbound
AccountWasObfuscated
{
"accountId": "abcdef-123456",
"user": {
"email": "user@spotahome.com",
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-07-21T12:48:44+0000"
}-
accountId (string, required)
-
user (string, object)
- identity (string, required)
-
occurredOn (string, required)
AccountContentWasUpdated
{
"accommodationProvider": {
"id": "67c0f631-6922-4a20-943b-ad634869b3b7",
"uuid": "1c06ad85-7841-421e-abf9-b04061f6c68b",
"accountName": "Mr Foo",
"accountEmail": {
"email": "mrfoo@spotahome.net"
},
"commission": {
"percentage": 4
},
"type": {
"type": "private"
},
"locale": "it",
"fees": {
"booking": {
"value": 0
}
},
"contractType": {
"type": "daily"
},
"downPaymentPreference": {
"type": {
"type": "monthly"
}
},
"accounting": {
"creationUser": "creator@spotahome.com",
"updateUser": "updater@spotahome.com",
"creationDate": "2017-04-21T16:56:14+0000",
"updateDate": "2017-08-17T07:22:48+0000",
"firstListingPublicationDate": "2017-04-23T02:11:36+0000"
},
"notes": "Fake St 123",
"isDeleted": false,
"translatableContentCollection": {
"canonicalLocale": "en",
"translatableContents": [
{
"locale": "en",
"translationType": "manual",
"policies": "Cachopo policies"
},
{
"locale": "es",
"translationType": "automatic",
"translationProvider": "fake",
"policies": "(es) Cachopo policies"
}
]
},
"isExternallyIntegrated": false,
"cancellationPolicy": {
"policy": "standard"
},
"bookingAcceptanceTimePreferences": {
"maxGapBetweenBookings": {},
"bookingAcceptanceDaysRange": {}
},
"accountClassification": {
"type": "opportunistic"
},
"assignedAccountManager": {
"username": "unassigned"
},
"numberPublishedListings": 1,
"contractProvision": {
"provision": "unknown"
},
"preferredCommunicationChannel": {
"channel": "no_preference"
},
"totalRentableUnits": 0,
"totalProperties": 0,
"contactCollection": {
"contacts": [
{
"id": 15534,
"firstName": "Bruce",
"lastName": "Lee",
"email": {
"email": "dragon@spotahome.com"
},
"phone": "+34698171297",
"address": "",
"zipCode": "",
"position": "",
"notes": "Punch!",
"accounting": {
"creationUser": "creator@spotahome.com",
"updateUser": "updater@spotahome.com",
"creationDate": "2017-08-01T13:36:41+0000",
"updateDate": "2017-08-01T13:36:41+0000"
},
"isDeleted": false
}
],
"contactTypesAssignation": {
"assignations": {
"tenant": 14423,
"booking_manager": 14423,
"finance": 14423
}
}
}
},
"contentBefore": {
"locale": "en",
"translationType": "manual",
"policies": "ouch"
},
"contentAfter": {
"locale": "en",
"translationType": "manual",
"policies": "WDFA!"
}
}- accommodationProvider (object, required)
- id (string, required)
- uuid (string, required)
- accountName (string, required)
- accountEmail (object, required)
- email (string, required)
- commission (object, required)
- percentage (number, optional)
- fixed (number, optional)
- type (object, required)
- type (string, required)
- locale (string, required)
- fees (object, required)
- contractType (object, required)
- type (string, required)
- downPaymentPreference
- type (object, required)
- type (string, required)
- type (object, required)
- accounting (object, required)
- creationUser (string, required)
- updateUser (string, required)
- creationDate (string, required)
- updateDate (string, required)
- firstListingPublicationDate (string, required)
- notes (string, required)
- isDeleted (bool, required)
- translatableContentCollection (object, required)
- canonicalLocale (string, required)
- translatableContents (array, required)
- (object)
- locale (string, required)
- translationType (string, required)
- policies (string, required)
- (object)
- isExternallyIntegrated (bool, required)
- cancellationPolicy (object, required)
- policy (string, required)
- bookingAcceptanceTimePreferences (object, required)
- maxGapBetweenBookings (object, required)
- days (number, optional)
- bookingAcceptanceDaysRange (object, required)
- minDays (number, optional)
- maxDays (number, optional)
- maxGapBetweenBookings (object, required)
- accountClassification (object, required)
- type (string, required)
- assignedAccountManager (object, required)
- username (string, required)
- numberPublishedListings (number, required)
- contractProvision (object, required)
- provision (string, required)
- preferredCommunicationChannel (object, required)
- channel (string, required)
- totalRentableUnits (number, required)
- totalProperties (number, required)
- contactCollection (object, required)
- contacts (array, required)
- (object)
- id (number, required)
- firstName (string, required)
- lastName (string, required)
- email (object, required)
- email (string, required)
- phone (string, required)
- address (string, required)
- zipCode (string, required)
- position (string, required)
- notes (string, required)
- accounting (object, required)
- creationUser (string, required)
- updateUser (string, required)
- creationDate (string, required)
- updateDate (string, required)
- (object)
- contacts (array, required)
- contactTypesAssignation (object, required)
- assignations (object, required)
- contentBefore (object, required) - locale (string, required) - translationType (string, required) - policies (string, optional)
- contentAfter (object, required) - locale (string, required) - translationType (string, required) - policies (string, optional)
AccountPlanWasChanged
{
"accountId": "abcdef-123456",
"accountPlan": "plus",
"user": {
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-07-21T12:48:44+0000"
}-
accountId (string, required)
-
accountPlan (string, required)
-
user (string, object)
- identity (string, required)
-
occurredOn (string, required)
MarketPenetrationInfoWasChanged
{
"accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"totalProperties": 2,
"totalRentableUnits": 2,
"user": {
"email": "user@spotahome.com",
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-06-30T14:08:48+0000",
}-
accountId (string, required)
-
totalProperties (number, required)
-
totalRentableUnits (number, required)
-
occurredOn (string, required)
-
user (object, required)
- email (string, required, nullable)
- identity (string, required)
AccountTechnologyWasChanged
{
"accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"technology": "no_technology",
"user": {
"email": "user@spotahome.com",
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-08-18T13:37:36+0000",
}-
accountId (string, required)
-
technology (string, required)
-
user (object, required)
- email (string, required, nullable)
- identity (string, required)
-
occurredOn (string, required)
AccountAdditionalDataWasCreated
{
"id": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"data": {
"additionalLanguagesSpoken": "Spanish, French",
"deposit": 400,
"rentPaymentMethod": "Credit",
"costOfTenantContractRegistration": 25,
"isDomiciliationPermitted": true,
"isAnmeldungPermitted": true,
"documentationRequired": "DNI",
"doesTheLandlordLiveOnTheProperty": false,
"landlordGender": "Male",
"landlordAge": 31,
"aboutLandlord": "The landlord is always quick to help with any issue her tenants might have with the property",
"hasCheckoutCleaningFee": true,
"checkoutCleaningFeeAmount": 50,
"hasCheckinCheckoutPolicies": true,
"checkinCheckoutLocation": "Calle de Vizcaya, 12, 28045 Madrid",
"earliestCheckinCheckoutTime": "13:00/17:00",
"latestCheckinCheckoutTime": "13:00/17:00",
"isWeekendHolidayOutOfHoursCheckinCheckoutPermitted": false,
"weekendHolidayCheckinCheckoutFeeAmount": 25,
},
"user": {
"email": "user@spotahome.com",
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-08-18T13:37:36+0000",
}-
accountId (string, required)
-
data (object, required)
- additionalLanguagesSpoken (string, optional)
- deposit (number, optional)
- rentPaymentMethod (string, optional)
- costOfTenantContractRegistration (number, optional)
- isDomiciliationPermitted (boolean, optional)
- isAnmeldungPermitted (boolean, optional)
- documentationRequired (string, optional)
- doesTheLandlordLiveOnTheProperty (boolean, optional)
- landlordGender (string, optional)
- landlordAge (number, optional)
- aboutLandlord (string, optional)
- hasCheckoutCleaningFee (boolean, optional)
- checkoutCleaningFeeAmount (number, optional)
- hasCheckinCheckoutPolicies (boolean, optional)
- checkinCheckoutLocation (string, optional)
- earliestCheckinCheckoutTime (string, optional)
- latestCheckinCheckoutTime (string, optional)
- isWeekendHolidayOutOfHoursCheckinCheckoutPermitted (boolean, optional)
- weekendHolidayCheckinCheckoutFeeAmount (number, optional)
-
user (object, required)
- email (string, required, nullable)
- identity (string, required)
-
occurredOn (string, required)
AccountAdditionalDataWasUpdated
{
"id": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"data": {
"additionalLanguagesSpoken": "Spanish, French",
"deposit": 400,
"rentPaymentMethod": "Credit",
"costOfTenantContractRegistration": 25,
"isDomiciliationPermitted": true,
"isAnmeldungPermitted": true,
"documentationRequired": "DNI",
"doesTheLandlordLiveOnTheProperty": false,
"landlordGender": "Male",
"landlordAge": 31,
"aboutLandlord": "The landlord is always quick to help with any issue her tenants might have with the property",
"hasCheckoutCleaningFee": true,
"checkoutCleaningFeeAmount": 50,
"hasCheckinCheckoutPolicies": true,
"checkinCheckoutLocation": "Calle de Vizcaya, 12, 28045 Madrid",
"earliestCheckinCheckoutTime": "13:00/17:00",
"latestCheckinCheckoutTime": "13:00/17:00",
"isWeekendHolidayOutOfHoursCheckinCheckoutPermitted": false,
"weekendHolidayCheckinCheckoutFeeAmount": 25,
},
"user": {
"email": "user@spotahome.com",
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-08-18T13:37:36+0000",
}-
accountId (string, required)
-
data (object, required)
- additionalLanguagesSpoken (string, optional)
- deposit (number, optional)
- rentPaymentMethod (string, optional)
- costOfTenantContractRegistration (number, optional)
- isDomiciliationPermitted (boolean, optional)
- isAnmeldungPermitted (boolean, optional)
- documentationRequired (string, optional)
- doesTheLandlordLiveOnTheProperty (boolean, optional)
- landlordGender (string, optional)
- landlordAge (number, optional)
- aboutLandlord (string, optional)
- hasCheckoutCleaningFee (boolean, optional)
- checkoutCleaningFeeAmount (number, optional)
- hasCheckinCheckoutPolicies (boolean, optional)
- checkinCheckoutLocation (string, optional)
- earliestCheckinCheckoutTime (string, optional)
- latestCheckinCheckoutTime (string, optional)
- isWeekendHolidayOutOfHoursCheckinCheckoutPermitted (boolean, optional)
- weekendHolidayCheckinCheckoutFeeAmount (number, optional)
-
user (object, required)
- email (string, required, nullable)
- identity (string, required)
-
occurredOn (string, required)
AccountNameWasChanged
{
"id": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"name": "name",
"occurredOn": "2017-08-18T13:37:36+00:00",
}-
id (string, required)
-
name (string, required)
-
occurredOn (string, required)
AccountTypeWasChanged
{
"id": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"type": "property_manager",
"occurredOn": "2017-08-18T13:37:36+00:00",
}-
id (string, required)
-
type (string, required)
-
occurredOn (string, required)
AccountAdminFeeWasUpdated
{
"accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"feeType": "fixed",
"feeValue": 10000,
"user": {
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-08-18T13:37:36+00:00",
}-
accountId (string, required)
-
feeType (enum[string], required)
- fixed
- percentage
-
feeValue (number, required)
-
user (object, required)
- identity (string, required)
-
occurredOn (string, required)
ContactWasCreated
{
"accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"contactId": 5,
"firstName": "First",
"lastName": "Name",
"email": "firstname@email.com",
"phone": "61459156",
"position": "CEO",
"address": "Palm Tree St 123",
"zipCode": "5544",
"user": {
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-08-18T13:37:36+00:00",
}-
accountId (string, required)
-
contactId (number, required)
-
firstName (string, required)
-
lastName (string, required)
-
email (string, required)
-
phone (string, required)
-
position (string, required)
-
address (string, required)
-
zipCode (string, required)
-
user (object, required)
- identity (string, required)
-
occurredOn (string, required)
ContactWasDeleted
{
"accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"contactId": 5,
"user": {
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-08-18T13:37:36+00:00",
}-
accountId (string, required)
-
contactId (number, required)
-
user (object, required)
- identity (string, required)
-
occurredOn (string, required)
ContactWasObfuscated
{
"accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"contactId": 5,
"user": {
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-08-18T13:37:36+00:00",
}-
accountId (string, required)
-
contactId (number, required)
-
user (object, required)
- identity (string, required)
-
occurredOn (string, required)
ContactWasUpdated
{
"accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
"contact": {
"contactId": 5 ,
"firstName": "First",
"lastName": "Name",
"email": "firstname@email.com",
"phone": "61459156",
"address": "Palm Tree St 123",
"zipCode": "5544",
"position": "CEO",
"notes": "contact notes" ,
"deleted": false ,
}
"user": {
"identity": "asdf-12-adafafdas-343-adasdfasd"
},
"occurredOn": "2017-08-18T13:37:36+00:00",
}-
accountId (string, required)
-
contact (object, required)
- contactId (number, required)
- firstName (string, required)
- lastName (string, required)
- email (string, required)
- phone (string, required)
- address (string, required)
- zipCode (string, required)
- position (string, required)
- notes (string, required)
- deleted (string, bool)
-
user (object, required)
- identity (string, required)
-
occurredOn (string, required)