Get Me
The user's own name, contact and company settings, each with how widely it is shared.
Required variables:
- baseUrl
- apiKey (needs
profile:read) - userToken
Authorization
bearerAuth userTokenAuth Partner API key (lyh_...): identifies the calling partner, its scopes and rate limit.
In: header
The user's OAuth 2.1 access token, issued by Land Your Home's OAuth server to this partner's OAuth client. Requests run as this user.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/me"{ "data": { "name": { "salutation": "Dr", "firstName": "Alex", "lastName": "Morgan", "visibility": "full" }, "contact": { "email": "alex@example.com", "emailVisibility": "Direct", "phone": "+447700900123", "phoneVisibility": "Private" }, "company": { "name": "Morgan Conveyancing", "website": "https://morgan.example.com", "visibility": "Public" } }}Post Licence Redeem
Claims the seeded unclaimed licence into the user's oldest team. A licence can only be redeemed once, so a repeat run against the same database returns 409 (run bun run reset in packages/landyourhome-db to repeat); this request accepts either.
Patch Me
Only the fields sent change. null clears contact.phone, company.name and company.website. Unknown fields are rejected.