Light mode version of Land Your Home
V1Me

Get My Notifications

GET
/v1/me/notifications

The user's notifications, newest first. unread=true hides ones already read. Pagination: limit (1-100, default 25) and cursor (a nextCursor from a previous response).

Required variables:

  • baseUrl
  • apiKey (needs notifications:read)
  • userToken

Authorization

bearerAuth userTokenAuth
AuthorizationBearer <token>

Partner API key (lyh_...): identifies the calling partner, its scopes and rate limit.

In: header

X-User-Token<token>

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

Query Parameters

limit?string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/me/notifications"
{  "data": [    {      "id": "5eed0000-0000-4000-8000-000000000001",      "createdAt": "2026-10-03T09:00:00.000000+00:00",      "title": "You have a new invite",      "description": "Someone invited you to a transaction.",      "actionUrl": "http://localhost:3000/user/invites",      "source": "system",      "read": false    }  ],  "nextCursor": null}