GET
Get my preferences

Overview

Returns the caller’s user_preferences document — the “desired home” filter persisted at onboarding step 4 and editable thereafter via PUT /preferences/me. Returns 404 NOT_FOUND if the user has not yet completed onboarding step 4 (i.e. the document was never created). Once created the document always exists; there is no soft-delete for preferences. This is a pure read — no preferences write, no match.recompute enqueue.

Authentication

Bearer <accessToken> required. Scope: user.

Path parameters

None.

Query parameters

None.

Request body

None.

Response — 200 OK

Preferences object

PreferredLocation object

The server stores locations as GeoJSON Points internally and returns them in the same shape on the wire.

Example response

Error responses

Example error — 404

Side effects

None — this is a pure read.

See also

curl