{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.showdigs.com" } ], "info": { "name": "Showdigs API", "_postman_id": "c2f0334f-3b77-48d2-8f78-4b90c30c9f3e", "description": "Showdigs API Documentation", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Agent Coverage", "description": "\nEndpoints for checking agent coverage.", "item": [ { "name": "Check location coverage", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/coverage", "query": [ { "key": "latitude", "value": "40.762569", "description": "Coordinate latitude.", "disabled": false }, { "key": "longitude", "value": "-73.8314318", "description": "Coordinate longitude.", "disabled": false }, { "key": "price", "value": "45", "description": "Optional showing price.", "disabled": false }, { "key": "address", "value": "", "description": "", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/coverage?latitude=40.762569&longitude=-73.8314318&price=45&address=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the coverage status of a location.\nFor better accuracy and performance, we recommend using the latitude and longitude parameters." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"probability\": 0.87, \"is_covered\": true, \"network\": \"primary\"}}", "name": "" }, { "header": [], "code": 422, "body": "{ \"message\": \"failed to match given address to a place\"}", "name": "" }, { "header": [], "code": 424, "body": "{\"message\": \"Unable to determine coverage at this time\"}", "name": "" } ] } ] }, { "name": "Units", "description": "\nEndpoints for managing units.", "item": [ { "name": "Get all units", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/units", "query": [ { "key": "page", "value": "1", "description": "The page number. Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page. Must be at least 1. Must not be greater than 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/units?page=1&per_page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of all units." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"35d5abef-2e5d-46dc-a7ed-005d3ea3fcdc\",\"timezone\":\"Asia\\\/Jerusalem\",\"name\":null,\"short_address\":\"26432 Leuschke Throughway Apt. 227, Lake Noahberg\",\"vicinity\":\"Lake Noahberg\",\"location\":{\"latitude\":32.064511,\"longitude\":34.897845},\"size\":null,\"bedrooms\":null,\"bathrooms\":null,\"listing_title\":null,\"listing_description\":null,\"amenities\":[],\"is_showing\":false,\"origin_id\":null},{\"id\":\"ec54b498-a119-4ac3-97ef-de8502c28c70\",\"timezone\":\"Asia\\\/Jerusalem\",\"name\":null,\"short_address\":\"771 Padberg Expressway, Port Lethachester\",\"vicinity\":\"Port Lethachester\",\"location\":{\"latitude\":32.024912,\"longitude\":34.883938},\"size\":null,\"bedrooms\":null,\"bathrooms\":null,\"listing_title\":null,\"listing_description\":null,\"amenities\":[],\"is_showing\":false,\"origin_id\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":null,\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"current_page_url\":\"\\\/?page=1\",\"from\":1,\"path\":\"\\\/\",\"per_page\":\"10\",\"to\":2}}", "name": "" } ] }, { "name": "Get unit by uuid", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/units\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/units\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "e1d8e8da-36e5-4083-83db-1f2bd1e35c6a", "description": "The UUID of the unit." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a specific unit by UUID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"286d0ce0-e3d4-45f6-8600-f0e20ea5691c\",\"timezone\":\"Asia\\\/Jerusalem\",\"name\":null,\"short_address\":\"27905 Fahey Wells, West Herberttown\",\"vicinity\":\"West Herberttown\",\"location\":{\"latitude\":32.042066,\"longitude\":34.781538},\"size\":null,\"bedrooms\":null,\"bathrooms\":null,\"listing_title\":null,\"listing_description\":null,\"amenities\":[],\"is_showing\":false,\"origin_id\":null}}", "name": "" } ] } ] }, { "name": "Listings", "description": "\nEndpoints for managing listings.", "item": [ { "name": "Create a Listing", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/units\/:uuid\/listing", "query": [], "raw": "{{baseUrl}}\/api\/v1\/units\/:uuid\/listing", "variable": [ { "id": "uuid", "key": "uuid", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the unit." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"architecto\",\"agent_backup\":false,\"only_consecutive_tours\":false,\"property_link\":\"https:\\\/\\\/example.com\\\/property\",\"application_link\":\"https:\\\/\\\/example.com\\\/application\",\"manager_email\":\"manager@example.com\",\"access_hardware\":\"keypad\",\"access_code\":\"1234 (required for non smart access hardware such as lockboxes or keypads)\",\"serial_number\":\"12345678 (required if `access_hardware` is set to smart device: Codebox, Sentrilock)\",\"notes\":\"This is a sample listing.\",\"tours_limit\":10,\"rent\":1000,\"security_deposit\":500,\"screening_template_uuid\":\"123e4567-e89b-12d3-a456-426614174000\",\"schedule_template_uuid\":\"123e4567-e89b-12d3-a456-426614174000 (required if `type` is restricted)\",\"ai_identity_verification\":true,\"tenants\":null,\"report_emails\":null,\"availability_date\":\"2023-01-01\",\"showing_start_date\":\"2023-01-01\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"unit_uuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"scheduling_url\": \"https:\/\/showdigs.co\/x1Y2z3\",\n \"pms_unit_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Unit not found\"\n}", "name": "unit not found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Validation error\",\n \"errors\": {\n \"field_name\": [\"The field_name field is required.\"]\n }\n}", "name": "validation error" } ] }, { "name": "Update a Listing", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/units\/:uuid\/listing", "query": [], "raw": "{{baseUrl}}\/api\/v1\/units\/:uuid\/listing", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"rent\":1500,\"security_deposit\":500,\"application_url\":\"https:\\\/\\\/application.com\\\/123Main\",\"notes\":\"Updated notes\"}" }, "description": "Update a listing by UUID param." }, "response": [ { "header": [], "code": 200, "body": "{ \"message\": \"Listing updated successfully\" }", "name": "success" }, { "header": [], "code": 404, "body": "{ \"message\": \"Unit not found\" }", "name": "unit not found" }, { "header": [], "code": 422, "body": "{ \"message\": \"Unit is not listed\" }", "name": "unit is not listed" } ] }, { "name": "List all listings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/listings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/listings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of all listings." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"units\": [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"property_id\": 123,\n \"timezone\": \"America\/Los_Angeles\",\n \"name\": \"Unit 101\",\n \"cover_image\": \"https:\/\/example.com\/listing.jpg\",\n \"market_name\": \"Seattle\",\n \"short_address\": \"42 Florentia St, Seattle\",\n \"vicinity\": \"Seattle\",\n \"state\": \"WA\",\n \"location\": {\n \"latitude\": 47.6512,\n \"longitude\": -122.3519\n },\n \"rent\": 1800,\n \"size\": 750,\n \"bedrooms\": \"1\",\n \"bathrooms\": 1,\n \"screening_criteria\": {\n \"availability_date\": \"2026-08-01 00:00:00\"\n },\n \"is_high_availability\": true,\n \"is_video_tours_supported\": false,\n \"is_self_showing\": false,\n \"is_open_house\": false,\n \"is_publish_listing\": false,\n \"scheduling_url\": \"https:\/\/showdigs.co\/x1Y2z3\",\n \"application_url\": \"https:\/\/example.com\/apply\",\n \"listing_url\": \"https:\/\/example.com\/listing\",\n \"pms_unit_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"pms_listing_id\": \"660e8400-e29b-41d4-a716-446655440001\"\n }\n ],\n \"business\": {\n \"formatted_phone_number\": \"(206) 555-0100\",\n \"email\": \"leasing@example.com\",\n \"name\": \"Example Property Management\",\n \"show_listing_apply_button\": true,\n \"logo_url\": \"https:\/\/example.com\/logo.png\",\n \"website_url\": \"https:\/\/example.com\",\n \"theme\": {\n \"primary\": \"#1F2937\"\n }\n }\n }\n}", "name": "Listings returned" } ] }, { "name": "Get listing by uuid", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/listings\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/listings\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the unit." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a specific listing by UUID.\n\nPlease provide UUID for better accuracy and performance.\nUUID can be either Showdigs unit UUID or PMS listing ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"unit\": {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"property_id\": 123,\n \"timezone\": \"America\/Los_Angeles\",\n \"name\": \"Unit 101\",\n \"cover_image\": \"https:\/\/example.com\/listing.jpg\",\n \"market_name\": \"Seattle\",\n \"short_address\": \"42 Florentia St, Seattle\",\n \"vicinity\": \"Seattle\",\n \"state\": \"WA\",\n \"location\": {\n \"latitude\": 47.6512,\n \"longitude\": -122.3519\n },\n \"rent\": 1800,\n \"size\": 750,\n \"bedrooms\": \"1\",\n \"bathrooms\": 1,\n \"screening_criteria\": {\n \"availability_date\": \"2026-08-01 00:00:00\"\n },\n \"is_high_availability\": true,\n \"is_video_tours_supported\": false,\n \"is_self_showing\": false,\n \"is_open_house\": false,\n \"is_publish_listing\": false,\n \"scheduling_url\": \"https:\/\/showdigs.co\/x1Y2z3\",\n \"application_url\": \"https:\/\/example.com\/apply\",\n \"listing_url\": \"https:\/\/example.com\/listing\",\n \"pms_unit_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"pms_listing_id\": \"660e8400-e29b-41d4-a716-446655440001\"\n },\n \"business\": {\n \"formatted_phone_number\": \"(206) 555-0100\",\n \"email\": \"leasing@example.com\",\n \"name\": \"Example Property Management\",\n \"show_listing_apply_button\": true,\n \"logo_url\": \"https:\/\/example.com\/logo.png\",\n \"website_url\": \"https:\/\/example.com\",\n \"theme\": {\n \"primary\": \"#1F2937\"\n }\n }\n }\n}", "name": "Listing returned" } ] }, { "name": "Delete listing by uuid", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/listings\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/listings\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a listing by UUID param.\n\nPlease provide UUID for better accuracy and performance.\nThe UUID can be either Showdigs unit UUID, PMS unit ID, or PMS listing ID." }, "response": [ { "header": [], "code": 200, "body": "scenario { \"message\": \"Listing deactivated successfully\" }", "name": "" }, { "header": [], "code": 404, "body": "scenario { \"message\": \"Unit not found\" }", "name": "" }, { "header": [], "code": 422, "body": "scenario { \"message\": \"Unit is not listed\" } || { \"message\": \"Some tours are planned to take place soon and can not be cancelled, try deactivating the listing after those tours are completed\" }", "name": "" } ] } ] }, { "name": "Inquiries", "description": "\nEndpoints for managing inquiries.", "item": [ { "name": "Create an inquiry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/inquiries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/inquiries" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"johndoe@example.com\",\"phone_number\":\"+123456789\",\"property_interest\":\"42 florentia st, Seattle\",\"listing_id\":\"1f06224c-1587-49ac-999f-5e9fcca35fac\",\"campaign\":\"Summer Leasing Push\"}" }, "description": "Creates a new inquiry." }, "response": [ { "header": [], "code": 200, "body": "{\n \"inquiry_id\": \"7494ab9f-7da6-4598-8c3f-bc2c1f10e7b5\",\n \"scheduling_url\": \"https:\/\/showdigs.co\/x1Y2z3\"\n}", "name": "Inquiry created" } ] } ] }, { "name": "Condition reports", "description": "\nEndpoints for requesting, retrieving, and cancelling condition reports.", "item": [ { "name": "List requested and recently completed condition reports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/condition-reports", "query": [ { "key": "page", "value": "1", "description": "The page number. Must be at least 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page. Must be at least 1. Must not be greater than 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/condition-reports?page=1&per_page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list owned by the authenticated business. Includes all\nin-progress reports and reports completed in the last month, matching the\nRequested and Recently Completed tabs. Cancelled reports are excluded.\n`state` is the machine-readable state; `status` is the PM UI label.\n`preferred_from` and `preferred_until` describe the current requested or\nscheduled inspection window in UTC; they are null before a time is chosen." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"uuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\", \"condition_report_id\": 12345, \"type\": \"periodic\", \"state\": \"waiting_for_tenant\", \"status\": \"Waiting for tenant\", \"unit_uuid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\", \"address\": \"506 E Howell St, Seattle - E-308\", \"timezone\": \"America\/Los_Angeles\", \"preferred_from\": null, \"preferred_until\": null, \"instructions\": \"Check smoke alarms\", \"lock_box_code\": null, \"access_instructions\": null, \"associated_member_email\": \"manager@example.com\", \"tenants\": [{\"first_name\": \"Jane\", \"last_name\": \"Doe\", \"phone_number\": \"+12065550123\", \"email\": \"jane@example.com\"}], \"price\": 249, \"created_at\": \"2026-06-11T18:30:00.000000Z\", \"completed_at\": null, \"report_url\": null}], \"links\": {\"first\": \"https:\/\/api.showdigs.com\/api\/v1\/condition-reports?page=1\", \"last\": \"https:\/\/api.showdigs.com\/api\/v1\/condition-reports?page=1\", \"prev\": null, \"next\": null}, \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 15, \"total\": 1}}", "name": "" } ] }, { "name": "Get a condition report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/condition-reports\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/condition-reports\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "description": "The report UUID returned by POST. GET also accepts the numeric condition_report_id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a report owned by the authenticated business, including archived\ncompleted and cancelled reports. Accepts either identifier returned by POST.\nTimes are UTC; `preferred_from` \/ `preferred_until` are the current requested\nor scheduled window. `status` uses the PM UI labels while `state` is stable\nfor integrations. Completion notifications are documented under\n[Condition report completed](https:\/\/api.showdigs.com\/docs#condition-report-completed)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"uuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\", \"condition_report_id\": 12345, \"type\": \"move_in_out\", \"state\": \"scheduled\", \"status\": \"Scheduled\", \"unit_uuid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\", \"address\": \"506 E Howell St, Seattle - E-308\", \"timezone\": \"America\/Los_Angeles\", \"preferred_from\": \"2026-06-20T16:00:00.000000Z\", \"preferred_until\": \"2026-06-20T20:00:00.000000Z\", \"instructions\": \"Check smoke alarms\", \"lock_box_code\": \"1234\", \"access_instructions\": \"Use the side entrance\", \"associated_member_email\": \"manager@example.com\", \"tenants\": [], \"price\": 249, \"created_at\": \"2026-06-11T18:30:00.000000Z\", \"completed_at\": null, \"report_url\": null}}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\": \"Condition report not found\"}", "name": "" } ] }, { "name": "Schedule a condition report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/condition-reports", "query": [], "raw": "{{baseUrl}}\/api\/v1\/condition-reports" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"move_in_out\",\"unit_uuid\":\"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\"instructions\":\"Focus on kitchen appliances\",\"associated_member_email\":\"manager@example.com\",\"lock_box_code\":\"4821\",\"access_instructions\":\"Lockbox on the railing by the front door.\",\"preferred_from\":\"2026-06-20 09:00:00 -07:00\",\"tenants\":[{\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"phone_number\":\"+12065550123\",\"email\":\"jane@example.com\"}]}" }, "description": "Creates a condition report for a unit owned by the authenticated business.\n\nSupported types:\n- `move_in_out`: requires `lock_box_code`, `access_instructions`, and `preferred_from` inside operating hours. The unit must already have `bedrooms` set. The server creates the default move-in\/out inspection window from `preferred_from`.\n- `periodic`: requires `tenants`; the first tenant must include both `phone_number` and `email`.\n- `vacancy_check`: requires `lock_box_code`, `access_instructions`, and a property-local `preferred_from` date; the server creates a 9 AM to 6 PM property-local window.\n\nThe create response `uuid` is the inspection UUID used for cancellation. The `completed_condition_report` webhook's `uuid` field currently refers to the unit UUID." }, "response": [ { "header": [], "code": 201, "body": "{\n \"uuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"condition_report_id\": 12345,\n \"type\": \"move_in_out\",\n \"state\": \"ordered\",\n \"unit_uuid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"address\": \"506 E Howell St, Seattle - E-308\",\n \"timezone\": \"America\/Los_Angeles\",\n \"preferred_from\": \"2026-06-20T16:00:00.000000Z\",\n \"preferred_until\": \"2026-06-20T20:00:00.000000Z\",\n \"price\": 249,\n \"created_at\": \"2026-06-11T18:30:00.000000Z\"\n}", "name": "move-in\/out scheduled" }, { "header": [], "code": 404, "body": "{ \"message\": \"Unit not found\" }", "name": "unit not found" }, { "header": [], "code": 422, "body": "{ \"message\": \"Please renew your subscription\" }", "name": "no subscription" }, { "header": [], "code": 422, "body": "{ \"message\": \"Please note that the vacancy check report is not available because this unit is occupied\" }", "name": "occupied vacancy check" }, { "header": [], "code": 422, "body": "{ \"message\": \"Existing condition report for this unit is currently in progress.\", \"error\": \"existingInspection\" }", "name": "existing report" } ] }, { "name": "Cancel a condition report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/condition-reports\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/condition-reports\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "description": "The inspection UUID returned by the create endpoint." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Cancels a condition report that belongs to the authenticated business and has not completed or already been cancelled." }, "response": [ { "header": [], "code": 204, "body": "null", "name": "cancelled" }, { "header": [], "code": 404, "body": "{ \"message\": \"Condition report not found\" }", "name": "condition report not found" }, { "header": [], "code": 422, "body": "{ \"message\": \"Inspection is already completed\" }", "name": "already completed" }, { "header": [], "code": 422, "body": "{ \"message\": \"Inspection is already cancelled\" }", "name": "already cancelled" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "POST api\/v1\/webhooks\/subscribe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/subscribe", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/subscribe" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"https:\"}" }, "description": "" }, "response": [] }, { "name": "DELETE api\/v1\/webhooks\/unsubscribe", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/unsubscribe", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/unsubscribe" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"https:\"}" }, "description": "" }, "response": [] }, { "name": "GET api\/v1\/webhooks\/sample", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/sample", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/sample" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Properties", "description": "\nEndpoints for managing properties and their units.", "item": [ { "name": "Create a Property and its Units", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/properties", "query": [], "raw": "{{baseUrl}}\/api\/v1\/properties" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"origin_id\":\"p_1\",\"property_type\":\"Single Family Home\",\"street\":\"4536 S Pennsylvania Ave\",\"city\":\"Oklahoma City\",\"state\":\"OK\",\"zip\":\"73119\",\"latitude\":35.4197022,\"longitude\":-97.5471714,\"units\":[{\"name\":\"Unit A\",\"bedrooms\":3,\"bathrooms\":2,\"size\":1200,\"images\":[\"https:\\\/\\\/placehold.co\\\/600x400\\\/blue\\\/black\"]}]}" }, "description": "This endpoint allows you to create a new property along with its associated units." }, "response": [ { "header": [], "code": 201, "body": "{\n \"origin_id\": \"p_1\",\n \"created_at\": \"2024-07-25 13:40:54\",\n \"updated_at\": \"2024-07-25 13:40:54\",\n \"property_type\": \"Single Family Home\",\n \"short_address\": \"4536 S Pennsylvania Ave, Oklahoma City\",\n \"timezone\": \"America\/Denver\",\n \"location\": {\n \"type\": \"Point\",\n \"coordinates\": [-97.5471714, 35.4197022]\n },\n \"units\": [\n {\n \"uuid\": \"u_1\",\n \"created_at\": \"2024-07-25 13:40:54\",\n \"updated_at\": \"2024-07-25 13:40:54\",\n \"name\": null,\n \"images\": [\"https:\/\/example.com\/pic.jpg\", \"https:\/\/example.com\/pic2.jpg\"],\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"size\": 1200\n }\n ]\n}", "name": "Property created" } ] }, { "name": "Update a Property and its Units", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/properties\/:origin_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/properties\/:origin_id", "variable": [ { "id": "origin_id", "key": "origin_id", "value": "architecto", "description": "The ID of the origin." }, { "id": "propertyOriginId", "key": "propertyOriginId", "value": "p_1", "description": "The unique identifier for the property." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"property_type\":\"Single Family Home\",\"street\":\"4536 S Pennsylvania Ave\",\"city\":\"Oklahoma City\",\"state\":\"OK\",\"zip\":\"73119\",\"latitude\":35.4197022,\"longitude\":-97.5471714,\"units\":[{\"uuid\":\"54f4b3b3-1b1b-4b3b-8b3b-1b1b4b3b8b3b\",\"name\":\"Unit A\",\"bedrooms\":3,\"bathrooms\":2,\"size\":1200,\"images\":[\"https:\\\/\\\/placehold.co\\\/600x400\\\/blue\\\/black\"]}]}" }, "description": "This endpoint allows you to update an existing property along with its associated units." }, "response": [ { "header": [], "code": 202, "body": "{\n \"origin_id\": \"p_1\",\n \"created_at\": \"2024-07-25 13:40:54\",\n \"updated_at\": \"2024-07-25 13:40:54\",\n \"property_type\": \"Single Family Home\",\n \"short_address\": \"4536 S Pennsylvania Ave, Oklahoma City\",\n \"timezone\": \"America\/Denver\",\n \"location\": {\n \"type\": \"Point\",\n \"coordinates\": [-97.5471714, 35.4197022]\n },\n \"units\": [\n {\n \"uuid\": \"u_1\",\n \"created_at\": \"2024-07-25 13:40:54\",\n \"updated_at\": \"2024-07-25 13:40:54\",\n \"name\": null,\n \"images\": [\"https:\/\/example.com\/pic.jpg\", \"https:\/\/example.com\/pic2.jpg\"],\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"size\": 1200\n }\n ]\n }", "name": "Property updated" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"street\": [\"The street field is required.\"],\n \"city\": [\"The city field is required.\"],\n \"state\": [\"The state field is required.\"],\n \"zip\": [\"The zip field is required.\"],\n \"latitude\": [\"The latitude field is required.\"],\n \"longitude\": [\"The longitude field is required.\"],\n \"units\": [\"The units field is required.\"],\n \"units.0.uuid\": [\"The units.0.uuid id field is required.\"],\n \"units.0.bedrooms\": [\"The units.0.bedrooms field is required.\"],\n \"units.0.bathrooms\": [\"The units.0.bathrooms field is required.\"],\n \"units.0.size\": [\"The units.0.size field is required.\"]\n }\n}", "name": "update property validation error" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "type": "string" } ] } }