{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "http:\/\/localhost" } ], "info": { "name": "inmodata API Documentation", "_postman_id": "570be778-cf62-42fe-be99-c3d33d55f53f", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Authentication", "description": "", "item": [ { "name": "Token Authentication", "description": "", "item": [ { "name": "Register", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/register", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Jane Doe\",\"email\":\"jane@example.com\",\"password\":\"password123\",\"device_name\":\"ios-app\"}" }, "description": "Create a new account and issue a Sanctum bearer token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"\",\"type\":\"users\",\"attributes\":{\"name\":\"Alexandra Salvador\",\"email\":\"miguel.sevilla@example.com\",\"email_verified_at\":\"2026-03-19T08:50:09+00:00\",\"created_at\":null,\"updated_at\":null}},\"meta\":{\"token\":\"1|example-token\",\"token_type\":\"Bearer\",\"expires_at\":null}}", "name": "Registration succeeded." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"The email has already been taken.\"]}}", "name": "Validation failed." } ] }, { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/login", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"jane@example.com\",\"password\":\"password123\",\"device_name\":\"ios-app\"}" }, "description": "Authenticate a user and issue a Sanctum bearer token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"users\",\"attributes\":{\"name\":\"Alexandra Salvador\",\"email\":\"gallego.adrian@example.com\",\"email_verified_at\":\"2026-03-19T08:50:09+00:00\",\"created_at\":null,\"updated_at\":null}},\"meta\":{\"token\":\"1|example-token\",\"token_type\":\"Bearer\",\"expires_at\":null}}", "name": "Login succeeded." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"The provided credentials are incorrect.\"]}}", "name": "Credentials were invalid." } ] }, { "name": "Get Current User", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/me", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return the authenticated user for the current bearer token." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"users\",\"attributes\":{\"name\":\"Omar Dom\\u00ednguez\",\"email\":\"arredondo.juana@example.com\",\"email_verified_at\":\"2026-03-19T08:50:09+00:00\",\"created_at\":null,\"updated_at\":null}}}", "name": "Authenticated user profile." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke the current Sanctum token." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Token revoked." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." } ] }, { "name": "List Tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/tokens", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/tokens" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List personal access tokens for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"1\",\"type\":\"personal-access-tokens\",\"attributes\":{\"name\":\"ios-app\",\"abilities\":[\"auth:me\",\"auth:logout\"],\"last_used_at\":null,\"expires_at\":\"2026-02-24T12:00:00+00:00\",\"created_at\":\"2026-02-23T12:00:00+00:00\",\"updated_at\":\"2026-02-23T12:00:00+00:00\",\"is_current\":true}}]}", "name": "Token list payload." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing required ability." } ] }, { "name": "Revoke All Tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/tokens", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/tokens" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke all personal access tokens for the authenticated user." }, "response": [ { "header": [], "code": 204, "body": null, "name": "All tokens revoked." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing required ability." } ] }, { "name": "Revoke Token", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/tokens\/:token_id", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/tokens\/:token_id", "variable": [ { "id": "token_id", "key": "token_id", "value": "42", "description": "Personal access token id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token_id\":16}" }, "description": "Revoke one personal access token owned by the authenticated user." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Token revoked." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Token not found.\"}", "name": "Token does not belong to current user or no longer exists." } ] } ] }, { "name": "Password Reset", "description": "", "item": [ { "name": "Request Password Reset", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/password\/forgot", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/password\/forgot" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"jane@example.com\"}" }, "description": "Send a password reset link to the provided email if an account exists.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"If the account exists, a password reset link has been sent.\"}", "name": "Password reset request accepted." } ] }, { "name": "Reset Password", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/password\/reset", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/password\/reset" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"reset-token-value\",\"email\":\"jane@example.com\",\"password\":\"new-password123\",\"password_confirmation\":\"new-password123\"}" }, "description": "Reset the user password using a valid reset token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Your password has been reset.\"}", "name": "Password reset succeeded." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"This password reset token is invalid.\"]}}", "name": "Reset token or payload was invalid." } ] }, { "name": "Read Reset Token Payload", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/password\/reset\/:token", "query": [ { "key": "email", "value": "jane%40example.com", "description": "Account email from the reset link.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/auth\/password\/reset\/:token?email=jane%40example.com", "variable": [ { "id": "token", "key": "token", "value": "reset-token-value", "description": "Password reset token from reset link." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"architecto\",\"email\":\"zbailey@example.net\"}" }, "description": "Return reset token and email payload for API clients handling email reset links.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"token\":\"reset-token-value\",\"email\":\"jane@example.com\"}", "name": "Reset payload data." } ] } ] }, { "name": "Email Verification", "description": "", "item": [ { "name": "Verify Email", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/email\/verify\/:id\/:hash", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/email\/verify\/:id\/:hash", "variable": [ { "id": "id", "key": "id", "value": "01HZX3W3T4J8Q57XNZD5BPHJ92", "description": "User ULID from the signed verification link." }, { "id": "hash", "key": "hash", "value": "8c4f4370e5db9b5be6d0f4c95495f49f998fa32a", "description": "SHA-1 hash of the email from the signed verification link." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\",\"hash\":\"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqld\"}" }, "description": "Verify a user email using the signed verification link parameters.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Email verified successfully.\"}", "name": "Email was verified." }, { "header": [], "code": 403, "body": "{\"message\":\"Invalid verification link.\"}", "name": "Signed URL was invalid, expired, or mismatched." } ] }, { "name": "Send Verification Email", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/email\/verification-notification", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/email\/verification-notification" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Send (or resend) an email verification link to the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Verification link sent.\"}", "name": "Verification email queued\/sent." }, { "header": [], "code": 200, "body": "{\"message\":\"Email is already verified.\"}", "name": "User already verified." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." } ] } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "Handle the incoming request.", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/properties\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/properties\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the property." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Properties", "description": "", "item": [ { "name": "Property Lookup", "description": "", "item": [ { "name": "Get Property by Address", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/properties\/address", "query": [], "raw": "{{baseUrl}}\/v1\/properties\/address" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"address\":\"Calle Mayor 123, Madrid\",\"page\":1,\"per_page\":20}" }, "description": "Retrieve property data by sending the address string." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"success\",\"data\":{\"properties\":[{\"id\":\"01ABC...\",\"direccion\":\"Calle Mayor 123, Madrid\"}],\"pagination\":{\"current_page\":1,\"per_page\":20,\"total\":100,\"last_page\":5}}}", "name": "Properties retrieved successfully." }, { "header": [], "code": 404, "body": "{\"status\":\"error\",\"error\":{\"code\":\"NOT_FOUND\",\"message\":\"Property not found\"}}", "name": "Property with the given address was not found." } ] }, { "name": "Get Properties by Zip Code", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/properties\/zip", "query": [], "raw": "{{baseUrl}}\/v1\/properties\/zip" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"zip\":\"41001\",\"page\":1,\"per_page\":20}" }, "description": "Retrieve properties by sending a zip code. Returns multiple properties if available." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"success\",\"data\":{\"properties\":[{\"id\":\"01ABC...\",\"direccion\":\"Calle Mayor\",\"codigo_postal\":\"41001\"}],\"pagination\":{\"current_page\":1,\"per_page\":20,\"total\":100,\"last_page\":5}}}", "name": "Properties retrieved successfully." }, { "header": [], "code": 404, "body": "{\"status\":\"error\",\"error\":{\"code\":\"NOT_FOUND\",\"message\":\"No properties found for this zip code\"}}", "name": "No properties found with the given zip code." } ] }, { "name": "Get Properties by Cadastral Reference", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/properties\/cadastral", "query": [], "raw": "{{baseUrl}}\/v1\/properties\/cadastral" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"cadastral_reference\":\"1234567VG1234A0001BG\",\"page\":1,\"per_page\":20}" }, "description": "Retrieve properties by sending a cadastral reference. Returns one or more properties if available." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"success\",\"data\":{\"properties\":[{\"id\":\"01ABC...\",\"direccion\":\"Calle Mayor\",\"referencia_catastral\":\"1234567VG1234A0001BG\"}],\"pagination\":{\"current_page\":1,\"per_page\":20,\"total\":100,\"last_page\":5}}}", "name": "Properties retrieved successfully." }, { "header": [], "code": 404, "body": "{\"status\":\"error\",\"error\":{\"code\":\"NOT_FOUND\",\"message\":\"No properties found for this cadastral reference\"}}", "name": "No properties found with the given cadastral reference." } ] }, { "name": "Get Properties by Province", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/properties\/province", "query": [], "raw": "{{baseUrl}}\/v1\/properties\/province" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"province\":\"Sevilla\",\"page\":1,\"per_page\":20}" }, "description": "Retrieve properties by sending a province name. Returns multiple properties if available." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"success\",\"data\":{\"properties\":[{\"id\":\"01ABC...\",\"direccion\":\"Calle Mayor\",\"provincia\":\"Sevilla\"}],\"pagination\":{\"current_page\":1,\"per_page\":20,\"total\":100,\"last_page\":5}}}", "name": "Properties retrieved successfully." }, { "header": [], "code": 404, "body": "{\"status\":\"error\",\"error\":{\"code\":\"NOT_FOUND\",\"message\":\"No properties found for this province\"}}", "name": "No properties found with the given province." } ] }, { "name": "Get Properties by Municipality", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/properties\/municipality", "query": [], "raw": "{{baseUrl}}\/v1\/properties\/municipality" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"municipality\":\"Camas\",\"page\":1,\"per_page\":20}" }, "description": "Retrieve properties by sending a municipality name. Returns multiple properties if available." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"success\",\"data\":{\"properties\":[{\"id\":\"01ABC...\",\"direccion\":\"Calle Mayor\",\"municipio\":\"Camas\"}],\"pagination\":{\"current_page\":1,\"per_page\":20,\"total\":100,\"last_page\":5}}}", "name": "Properties retrieved successfully." }, { "header": [], "code": 404, "body": "{\"status\":\"error\",\"error\":{\"code\":\"NOT_FOUND\",\"message\":\"No properties found for this municipality\"}}", "name": "No properties found with the given municipality." } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }