Get My Address Book
Happy path: the other active people on every chain the user is in, with their role on each transaction. Details a person doesn't share with this user are null.
Pagination: limit (1-100, default 25) and cursor (an opaque
nextCursor from a previous response; null when there are no more pages).
Results are newest-updated first. Responses are { "data": [...], "nextCursor": "..." | null }.
Required variables:
- baseUrl
- apiKey (needs
contacts: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
Query Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/me/address-book"{ "data": [ { "id": "3f1a9c6e5b0d4f0f8a2c7e91b6d34a58c1e2f7a09b4d5c6e8f1a2b3c4d5e6f70", "relationship": "direct", "name": "Mrs B. Brown", "email": "bella@example.com", "phone": null, "company": null, "companyWebsite": null, "transactions": [ { "chainId": "1b18a121-73df-4412-88b8-b71545b6c9fe", "transactionId": "9a5424e0-2413-4890-a5ca-6e90f4604ae9", "role": "Buyer", "representing": "Buyer", "address": "5 HOLLY CRESCENT" } ] }, { "id": "a7b1c9d2e3f4051627384950a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4", "relationship": "chain", "name": "Anon", "email": null, "phone": null, "company": null, "companyWebsite": null, "transactions": [ { "chainId": "1b18a121-73df-4412-88b8-b71545b6c9fe", "transactionId": "9a5424e0-2413-4890-a5ca-6e90f4604ae9", "role": "Buyer", "representing": "Buyer", "address": "5 HOLLY CRESCENT" } ] } ], "nextCursor": null}Post Transaction Access Request
Asks to join a transaction (here a neighbour in the user's chain). Asking again while a request is pending returns the same request with 200 and existing: true. If the user is already a party the response is 409 conflict.
Post Chain Leave
The user leaves the chain. Send { "transactionIds": [...] } to leave only some transactions; with no body they leave all of them. Destructive: see the folder notes.