Get my current home
curl --request GET \
--url https://api.example.com/api/v1/current-home/meimport requests
url = "https://api.example.com/api/v1/current-home/me"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/current-home/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/current-home/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/current-home/me"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/current-home/me")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/current-home/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyCurrent Home
Get my current home
Return the authenticated user’s current-home listing.
GET
/
api
/
v1
/
current-home
/
me
Get my current home
curl --request GET \
--url https://api.example.com/api/v1/current-home/meimport requests
url = "https://api.example.com/api/v1/current-home/me"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/current-home/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/current-home/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/current-home/me"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/current-home/me")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/current-home/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyOverview
Returns the authenticated user’scurrent_homes document — the listing they created during onboarding step 2 (and which step 3 attached photos and a description to). Returns 404 NOT_FOUND if the user has not yet reached step 2, or if the listing has been soft-deleted (deletedAt != null).
There is no public GET /current-home/{id} endpoint by design — listings are only visible through match context, which prevents scraping. This endpoint returns the caller’s own listing only.
Authentication
Bearer <accessToken> required. Scope: user.
Path parameters
None.Query parameters
None.Request body
None.Response — 200 OK
| Field | Type | Notes | Example |
|---|---|---|---|
home | object | See Home object. |
Home object
| Field | Type | Allowed values / Notes | Example |
|---|---|---|---|
id | string | 24-char ObjectId of the listing. | 66400a8f1c2b4d5e6f7a8c00 |
userId | string | 24-char ObjectId of the owner (the caller). | 66400a8f1c2b4d5e6f7a8b00 |
propertyType | enum | DETACHED, SEMI_DETACHED, TERRACED, FLAT, MAISONETTE, BUNGALOW, STUDIO | FLAT |
bedrooms | integer | 0..10 | 2 |
bathrooms | integer | 0..10 | 1 |
address | string | 1..500 chars. | Flat 4, 27 Camden High Street |
postcode | string | UK postcode, uppercased. | NW1 7JE |
location | object | GeoJSON-derived { lng, lat }. | { "lng": -0.1426, "lat": 51.5390 } |
rent | object | { amountMinor: integer, frequency: "WEEKLY" | "MONTHLY" } | { "amountMinor": 120000, "frequency": "MONTHLY" } |
rentMonthlyMinor | integer | Server-derived monthly pence (weekly → amountMinor * 52 / 12 rounded). Used by the matcher. | 120000 |
features | string[] | Subset of: GARDEN, PARKING, BALCONY, LIFT, GROUND_FLOOR, PETS_ALLOWED, WHEELCHAIR_ACCESS, NEW_BUILD. | ["GARDEN", "LIFT"] |
photos | object[] | Embedded subdocuments. See Photo object. | |
description | string | 0..150 chars. Empty string before onboarding step-3-description has been submitted. | Bright 2-bed flat in Camden... |
status | enum | DRAFT, LIVE, HIDDEN, DELETED | DRAFT |
ownerOnboardingComplete | boolean | Denormalised from the user document. Updated by job (Phase 3+). | false |
ownerTenancyApproved | boolean | Denormalised from the user document. Updated by job (Phase 3+). | false |
ownerStatus | enum | ACTIVE, PAUSED, BANNED | ACTIVE |
deletedAt | string | null | ISO 8601 UTC or null. | null |
createdAt | string | ISO 8601 UTC with ms precision. | 2026-05-22T14:32:08.412Z |
updatedAt | string | ISO 8601 UTC with ms precision. | 2026-05-22T14:32:08.412Z |
Photo object
| Field | Type | Notes | Example |
|---|---|---|---|
id | string | 24-char ObjectId of the embedded photo. Use as photoId in the cover/delete endpoints. | 66400a8f1c2b4d5e6f7a8d01 |
url | string | Full-resolution CDN URL. | https://cdn.swappr.co.uk/listings/.../photo1.jpg |
thumbnailUrl | string | Thumbnail URL (Phase 7 will diverge from url once the worker runs; Phase 2 mirrors url). | https://cdn.swappr.co.uk/listings/.../photo1.jpg |
orderIndex | integer | 0..9. Lower = earlier. | 0 |
isCover | boolean | Exactly one photo has isCover: true while photos.length > 0. | true |
fileSizeBytes | integer | Bytes on disk. | 2500000 |
width | integer | Cropped width in px. Set from the client’s photoMeta at attach time; 0 for photos uploaded without it. | 1600 |
height | integer | Cropped height in px. Set from the client’s photoMeta at attach time; 0 for photos uploaded without it. | 1200 |
blurhash | string | BlurHash placeholder string the client computed after cropping; the app paints it before the full image loads. Empty for photos uploaded without photoMeta. | "L6PZfSi_.AyE_3t7t7R**0o#DgR4" |
createdAt | string | ISO 8601 UTC. | 2026-05-22T14:32:08.412Z |
Example response
{
"home": {
"id": "66400a8f1c2b4d5e6f7a8c00",
"userId": "66400a8f1c2b4d5e6f7a8b00",
"propertyType": "FLAT", // enum: "DETACHED" | "SEMI_DETACHED" | "TERRACED" | "FLAT" | "MAISONETTE" | "BUNGALOW" | "STUDIO"
"bedrooms": 2,
"bathrooms": 1,
"address": "Flat 4, 27 Camden High Street",
"postcode": "NW1 7JE",
"location": { "lng": -0.1426, "lat": 51.5390 },
"rent": {
"amountMinor": 120000, // integer pence
"frequency": "MONTHLY" // enum: "WEEKLY" | "MONTHLY"
},
"rentMonthlyMinor": 120000,
"features": ["GARDEN", "LIFT"], // enum (multi): see above
"photos": [
{
"id": "66400a8f1c2b4d5e6f7a8d01",
"url": "https://cdn.swappr.co.uk/listings/66400a8f1c2b4d5e6f7a8b00/01HZQ7K3M4N5P6Q7R8S9T0V1W2.jpg",
"thumbnailUrl": "https://cdn.swappr.co.uk/listings/66400a8f1c2b4d5e6f7a8b00/01HZQ7K3M4N5P6Q7R8S9T0V1W2.jpg",
"orderIndex": 0,
"isCover": true,
"fileSizeBytes": 2500000,
"width": 0,
"height": 0,
"blurhash": "",
"createdAt": "2026-05-22T14:32:08.412Z"
}
],
"description": "Bright 2-bed flat in Camden, two minutes from the tube, recently refurbished kitchen, south-facing balcony with a view of the canal.",
"status": "DRAFT", // enum: "DRAFT" | "LIVE" | "HIDDEN" | "DELETED"
"ownerOnboardingComplete": false,
"ownerTenancyApproved": false,
"ownerStatus": "ACTIVE", // enum: "ACTIVE" | "PAUSED" | "BANNED"
"deletedAt": null,
"createdAt": "2026-05-22T14:30:00.123Z",
"updatedAt": "2026-05-22T14:32:08.412Z"
}
}
Error responses
| Status | Code | Meaning |
|---|---|---|
| 401 | UNAUTHENTICATED | Missing, malformed, or expired access token. |
| 404 | NOT_FOUND | The user has no current_homes document yet (onboarding step 2 has not been completed), or the listing is soft-deleted. |
Example error — 404
{
"type": "https://api.swappr.co.uk/errors/not-found",
"title": "Not found",
"status": 404,
"code": "NOT_FOUND",
"detail": "No current-home listing for user",
"instance": "/api/v1/current-home/me",
"requestId": "01HZQ7K3M4N5P6Q7R8S9T0V1W2"
}
Side effects
None — this is a pure read.See also
- Update my current home
- Add listing photos
- Publish listing
- Step 2 — current home — creates the listing.
curl
curl -X GET https://api.swappr.co.uk/api/v1/current-home/me \
-H "Authorization: Bearer $ACCESS_TOKEN"