{ "item": [ { "name": "Properties", "description": { "content": "The catalogue, and your own inventory within it. Read endpoints span everything we hold; write endpoints only ever touch records your organisation published.", "type": "text/plain" }, "item": [ { "name": "List properties", "request": { "name": "List properties", "description": { "content": "Page through the catalogue with filters.\n\nThe workhorse read endpoint. Filters combine with AND. Anything omitted is unconstrained, so an unfiltered call returns the whole catalogue in cursor order.\n\nRequires the `properties:read` scope.", "type": "text/plain" }, "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "city", "value": "Berlin", "description": "City to restrict to, as it appears on a property's address." }, { "disabled": true, "key": "district", "value": "Kreuzberg", "description": "District within the city." }, { "disabled": true, "key": "postal_code", "value": "10999", "description": "Postal code to restrict to." }, { "disabled": true, "key": "type", "value": "apartment", "description": "Kind of property." }, { "disabled": true, "key": "transaction_type", "value": "sale", "description": "Restrict to sales or rentals." }, { "disabled": true, "key": "status", "value": "active", "description": "Listing status. Omit for every status rather than only active ones." }, { "disabled": true, "key": "external_id", "value": "OBJ-10041", "description": "Your own identifier for a record, to find what an import created." }, { "disabled": true, "key": "min_price", "value": "250000", "description": "Inclusive lower bound on the asking price." }, { "disabled": true, "key": "max_price", "value": "750000", "description": "Inclusive upper bound on the asking price." }, { "disabled": true, "key": "min_living_area", "value": "60", "description": "Inclusive lower bound on living area, in square metres." }, { "disabled": true, "key": "min_bedrooms", "value": "2", "description": "Inclusive lower bound on bedroom count." }, { "disabled": true, "key": "limit", "value": "50", "description": "Records per page." }, { "disabled": true, "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9", "description": "Opaque pointer from the previous response. Omit for the first page. Cursors are stable across inserts, so paging never skips or repeats a record the way an offset does." }, { "disabled": true, "key": "sort", "value": "-created_at", "description": "Field to order by. Prefix with a minus for descending." }, { "disabled": true, "key": "expand", "value": "images", "description": "Related records to inline rather than fetch separately." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "city", "value": "Berlin" }, { "key": "district", "value": "Kreuzberg" }, { "key": "postal_code", "value": "10999" }, { "key": "type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "status", "value": "active" }, { "key": "external_id", "value": "OBJ-10041" }, { "key": "min_price", "value": "250000" }, { "key": "max_price", "value": "750000" }, { "key": "min_living_area", "value": "60" }, { "key": "min_bedrooms", "value": "2" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" }, { "key": "expand", "value": "images" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"prop_8f2a41c9d0\",\n \"type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"description\": \"Altbau flat on a quiet side street, two minutes from Görlitzer Park.\",\n \"listing\": {\n \"transaction_type\": \"sale\",\n \"status\": \"active\",\n \"price\": 429000,\n \"currency\": \"EUR\",\n \"price_per_sqm\": 5797.3,\n \"published_at\": \"2026-07-28T09:12:00Z\"\n },\n \"size\": {\n \"living_area_sqm\": 74\n },\n \"rooms\": {\n \"bedrooms\": 2,\n \"bathrooms\": 1,\n \"total_rooms\": 3,\n \"floor\": 4,\n \"floors_in_building\": 4\n },\n \"building\": {\n \"year_built\": 1908,\n \"construction_type\": \"altbau\",\n \"condition\": \"renovated\",\n \"heating_type\": \"district\"\n },\n \"address\": {\n \"street\": \"Oranienstrasse\",\n \"number\": \"12\",\n \"postal_code\": \"10999\",\n \"city\": \"Berlin\",\n \"district\": \"Kreuzberg\",\n \"country\": \"DE\"\n },\n \"location\": {\n \"latitude\": 52.4993,\n \"longitude\": 13.4184,\n \"precision\": \"street\"\n },\n \"energy\": {\n \"label\": \"C\",\n \"consumption_kwh\": 112.4\n },\n \"source\": \"api\",\n \"created_at\": \"2026-07-28T09:12:00Z\",\n \"updated_at\": \"2026-08-11T14:03:22Z\"\n },\n {\n \"id\": \"prop_1b77e0a4f2\",\n \"type\": \"apartment\",\n \"title\": \"Garden flat with a separate studio\",\n \"listing\": {\n \"transaction_type\": \"sale\",\n \"status\": \"active\",\n \"price\": 385000,\n \"currency\": \"EUR\",\n \"price_per_sqm\": 4750.62\n },\n \"size\": {\n \"living_area_sqm\": 81\n },\n \"rooms\": {\n \"bedrooms\": 3,\n \"bathrooms\": 1,\n \"total_rooms\": 4,\n \"floor\": 0\n },\n \"building\": {\n \"year_built\": 1962,\n \"condition\": \"good\"\n },\n \"address\": {\n \"street\": \"Weichselstrasse\",\n \"postal_code\": \"12045\",\n \"city\": \"Berlin\",\n \"district\": \"Neukölln\",\n \"country\": \"DE\"\n },\n \"location\": {\n \"latitude\": 52.4812,\n \"longitude\": 13.4331,\n \"precision\": \"area\"\n },\n \"source\": \"import\",\n \"created_at\": \"2026-06-02T08:00:00Z\",\n \"updated_at\": \"2026-08-09T11:20:10Z\"\n }\n ],\n \"meta\": {\n \"has_more\": false,\n \"limit\": 50,\n \"next_cursor\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "city", "value": "Berlin" }, { "key": "district", "value": "Kreuzberg" }, { "key": "postal_code", "value": "10999" }, { "key": "type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "status", "value": "active" }, { "key": "external_id", "value": "OBJ-10041" }, { "key": "min_price", "value": "250000" }, { "key": "max_price", "value": "750000" }, { "key": "min_living_area", "value": "60" }, { "key": "min_bedrooms", "value": "2" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" }, { "key": "expand", "value": "images" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "city", "value": "Berlin" }, { "key": "district", "value": "Kreuzberg" }, { "key": "postal_code", "value": "10999" }, { "key": "type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "status", "value": "active" }, { "key": "external_id", "value": "OBJ-10041" }, { "key": "min_price", "value": "250000" }, { "key": "max_price", "value": "750000" }, { "key": "min_living_area", "value": "60" }, { "key": "min_bedrooms", "value": "2" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" }, { "key": "expand", "value": "images" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "city", "value": "Berlin" }, { "key": "district", "value": "Kreuzberg" }, { "key": "postal_code", "value": "10999" }, { "key": "type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "status", "value": "active" }, { "key": "external_id", "value": "OBJ-10041" }, { "key": "min_price", "value": "250000" }, { "key": "max_price", "value": "750000" }, { "key": "min_living_area", "value": "60" }, { "key": "min_bedrooms", "value": "2" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" }, { "key": "expand", "value": "images" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "city", "value": "Berlin" }, { "key": "district", "value": "Kreuzberg" }, { "key": "postal_code", "value": "10999" }, { "key": "type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "status", "value": "active" }, { "key": "external_id", "value": "OBJ-10041" }, { "key": "min_price", "value": "250000" }, { "key": "max_price", "value": "750000" }, { "key": "min_living_area", "value": "60" }, { "key": "min_bedrooms", "value": "2" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" }, { "key": "expand", "value": "images" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "city", "value": "Berlin" }, { "key": "district", "value": "Kreuzberg" }, { "key": "postal_code", "value": "10999" }, { "key": "type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "status", "value": "active" }, { "key": "external_id", "value": "OBJ-10041" }, { "key": "min_price", "value": "250000" }, { "key": "max_price", "value": "750000" }, { "key": "min_living_area", "value": "60" }, { "key": "min_bedrooms", "value": "2" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" }, { "key": "expand", "value": "images" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create a property", "request": { "name": "Create a property", "description": { "content": "Publish a record from your own inventory.\n\nSend an Idempotency-Key so a retried request cannot create a duplicate listing. Records created this way belong to your organisation and are the only ones your key may modify.\n\nRequires the `properties:write` scope.", "type": "text/plain" }, "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique per logical creation. Replaying the same key returns the original result rather than creating a second record.", "key": "Idempotency-Key", "value": "a2f1c7e4-…" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"city\": \"Berlin\",\n \"country\": \"DE\",\n \"postal_code\": \"10999\",\n \"street\": \"Oranienstrasse\"\n },\n \"bedrooms\": 2,\n \"currency\": \"EUR\",\n \"living_area\": 74,\n \"price\": 42900000,\n \"property_type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"transaction_type\": \"sale\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. The Location header carries the new resource URL.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique per logical creation. Replaying the same key returns the original result rather than creating a second record.", "key": "Idempotency-Key", "value": "a2f1c7e4-…" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"city\": \"Berlin\",\n \"country\": \"DE\",\n \"postal_code\": \"10999\",\n \"street\": \"Oranienstrasse\"\n },\n \"bedrooms\": 2,\n \"currency\": \"EUR\",\n \"living_area\": 74,\n \"price\": 42900000,\n \"property_type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"transaction_type\": \"sale\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"prop_8f2a41c9d0\",\n \"type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"description\": \"Altbau flat on a quiet side street, two minutes from Görlitzer Park.\",\n \"listing\": {\n \"transaction_type\": \"sale\",\n \"status\": \"active\",\n \"price\": 429000,\n \"currency\": \"EUR\",\n \"price_per_sqm\": 5797.3,\n \"published_at\": \"2026-07-28T09:12:00Z\"\n },\n \"size\": {\n \"living_area_sqm\": 74\n },\n \"rooms\": {\n \"bedrooms\": 2,\n \"bathrooms\": 1,\n \"total_rooms\": 3,\n \"floor\": 4,\n \"floors_in_building\": 4\n },\n \"building\": {\n \"year_built\": 1908,\n \"construction_type\": \"altbau\",\n \"condition\": \"renovated\",\n \"heating_type\": \"district\"\n },\n \"address\": {\n \"street\": \"Oranienstrasse\",\n \"number\": \"12\",\n \"postal_code\": \"10999\",\n \"city\": \"Berlin\",\n \"district\": \"Kreuzberg\",\n \"country\": \"DE\"\n },\n \"location\": {\n \"latitude\": 52.4993,\n \"longitude\": 13.4184,\n \"precision\": \"street\"\n },\n \"energy\": {\n \"label\": \"C\",\n \"consumption_kwh\": 112.4\n },\n \"source\": \"api\",\n \"created_at\": \"2026-07-28T09:12:00Z\",\n \"updated_at\": \"2026-08-11T14:03:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique per logical creation. Replaying the same key returns the original result rather than creating a second record.", "key": "Idempotency-Key", "value": "a2f1c7e4-…" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"city\": \"Berlin\",\n \"country\": \"DE\",\n \"postal_code\": \"10999\",\n \"street\": \"Oranienstrasse\"\n },\n \"bedrooms\": 2,\n \"currency\": \"EUR\",\n \"living_area\": 74,\n \"price\": 42900000,\n \"property_type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"transaction_type\": \"sale\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique per logical creation. Replaying the same key returns the original result rather than creating a second record.", "key": "Idempotency-Key", "value": "a2f1c7e4-…" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"city\": \"Berlin\",\n \"country\": \"DE\",\n \"postal_code\": \"10999\",\n \"street\": \"Oranienstrasse\"\n },\n \"bedrooms\": 2,\n \"currency\": \"EUR\",\n \"living_area\": 74,\n \"price\": 42900000,\n \"property_type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"transaction_type\": \"sale\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique per logical creation. Replaying the same key returns the original result rather than creating a second record.", "key": "Idempotency-Key", "value": "a2f1c7e4-…" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"city\": \"Berlin\",\n \"country\": \"DE\",\n \"postal_code\": \"10999\",\n \"street\": \"Oranienstrasse\"\n },\n \"bedrooms\": 2,\n \"currency\": \"EUR\",\n \"living_area\": 74,\n \"price\": 42900000,\n \"property_type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"transaction_type\": \"sale\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An Idempotency-Key was reused with a different body.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique per logical creation. Replaying the same key returns the original result rather than creating a second record.", "key": "Idempotency-Key", "value": "a2f1c7e4-…" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"city\": \"Berlin\",\n \"country\": \"DE\",\n \"postal_code\": \"10999\",\n \"street\": \"Oranienstrasse\"\n },\n \"bedrooms\": 2,\n \"currency\": \"EUR\",\n \"living_area\": 74,\n \"price\": 42900000,\n \"property_type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"transaction_type\": \"sale\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The body parsed but failed validation. See the errors array.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique per logical creation. Replaying the same key returns the original result rather than creating a second record.", "key": "Idempotency-Key", "value": "a2f1c7e4-…" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"city\": \"Berlin\",\n \"country\": \"DE\",\n \"postal_code\": \"10999\",\n \"street\": \"Oranienstrasse\"\n },\n \"bedrooms\": 2,\n \"currency\": \"EUR\",\n \"living_area\": 74,\n \"price\": 42900000,\n \"property_type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"transaction_type\": \"sale\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique per logical creation. Replaying the same key returns the original result rather than creating a second record.", "key": "Idempotency-Key", "value": "a2f1c7e4-…" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": {\n \"city\": \"Berlin\",\n \"country\": \"DE\",\n \"postal_code\": \"10999\",\n \"street\": \"Oranienstrasse\"\n },\n \"bedrooms\": 2,\n \"currency\": \"EUR\",\n \"living_area\": 74,\n \"price\": 42900000,\n \"property_type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"transaction_type\": \"sale\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Search properties", "request": { "name": "Search properties", "description": { "content": "Semantic and geographic search that is too complex for a query string.\n\nTakes a natural-language query, a drawn polygon, or both. Results come back ranked by relevance rather than by a sortable column, so this endpoint ignores the sort parameter. It is a POST because a polygon does not belong in a URL, not because it changes anything.\n\nRequires the `properties:read` scope.", "type": "text/plain" }, "url": { "path": [ "properties", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"market\": \"berlin-de\",\n \"price_max\": 50000000,\n \"transaction_type\": \"sale\"\n },\n \"limit\": 20,\n \"query\": \"quiet two bedroom near a park, needs a home office\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "properties", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"market\": \"berlin-de\",\n \"price_max\": 50000000,\n \"transaction_type\": \"sale\"\n },\n \"limit\": 20,\n \"query\": \"quiet two bedroom near a park, needs a home office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"prop_8f2a41c9d0\",\n \"matched_on\": [\n \"quiet street\",\n \"park within 300m\",\n \"study alcove\"\n ],\n \"relevance\": 0.87,\n \"title\": \"Top-floor apartment…\"\n }\n ],\n \"meta\": {\n \"has_more\": false,\n \"limit\": 20\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"market\": \"berlin-de\",\n \"price_max\": 50000000,\n \"transaction_type\": \"sale\"\n },\n \"limit\": 20,\n \"query\": \"quiet two bedroom near a park, needs a home office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "properties", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"market\": \"berlin-de\",\n \"price_max\": 50000000,\n \"transaction_type\": \"sale\"\n },\n \"limit\": 20,\n \"query\": \"quiet two bedroom near a park, needs a home office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "properties", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"market\": \"berlin-de\",\n \"price_max\": 50000000,\n \"transaction_type\": \"sale\"\n },\n \"limit\": 20,\n \"query\": \"quiet two bedroom near a park, needs a home office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "properties", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"market\": \"berlin-de\",\n \"price_max\": 50000000,\n \"transaction_type\": \"sale\"\n },\n \"limit\": 20,\n \"query\": \"quiet two bedroom near a park, needs a home office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"market\": \"berlin-de\",\n \"price_max\": 50000000,\n \"transaction_type\": \"sale\"\n },\n \"limit\": 20,\n \"query\": \"quiet two bedroom near a park, needs a home office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Withdraw a property", "request": { "name": "Withdraw a property", "description": { "content": "Take one of your records off the market.\n\nWithdrawal is not deletion. The record moves to withdrawn, disappears from search, and keeps its price history so past analysis stays intelligible. A record owned by an import source is refused, because the next run would bring it straight back: withdraw it at the source instead.\n\nRequires the `properties:write` scope.", "type": "text/plain" }, "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to withdraw." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": null }, "response": [ { "name": "Withdrawn. No body.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to withdraw." } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to withdraw." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to withdraw." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to withdraw." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "managed_by_import. Withdraw it at the source, or delete the source first.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to withdraw." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to withdraw." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to withdraw." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve a property", "request": { "name": "Retrieve a property", "description": { "content": "One property with its full attribute set.\n\nRequires the `properties:read` scope.", "type": "text/plain" }, "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "expand", "value": "images", "description": "Related records to inline rather than fetch separately." } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Identifier returned by any collection endpoint." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "expand", "value": "images" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Identifier returned by any collection endpoint." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"prop_8f2a41c9d0\",\n \"type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"description\": \"Altbau flat on a quiet side street, two minutes from Görlitzer Park.\",\n \"listing\": {\n \"transaction_type\": \"sale\",\n \"status\": \"active\",\n \"price\": 429000,\n \"currency\": \"EUR\",\n \"price_per_sqm\": 5797.3,\n \"published_at\": \"2026-07-28T09:12:00Z\"\n },\n \"size\": {\n \"living_area_sqm\": 74\n },\n \"rooms\": {\n \"bedrooms\": 2,\n \"bathrooms\": 1,\n \"total_rooms\": 3,\n \"floor\": 4,\n \"floors_in_building\": 4\n },\n \"building\": {\n \"year_built\": 1908,\n \"construction_type\": \"altbau\",\n \"condition\": \"renovated\",\n \"heating_type\": \"district\"\n },\n \"address\": {\n \"street\": \"Oranienstrasse\",\n \"number\": \"12\",\n \"postal_code\": \"10999\",\n \"city\": \"Berlin\",\n \"district\": \"Kreuzberg\",\n \"country\": \"DE\"\n },\n \"location\": {\n \"latitude\": 52.4993,\n \"longitude\": 13.4184,\n \"precision\": \"street\"\n },\n \"energy\": {\n \"label\": \"C\",\n \"consumption_kwh\": 112.4\n },\n \"source\": \"api\",\n \"created_at\": \"2026-07-28T09:12:00Z\",\n \"updated_at\": \"2026-08-11T14:03:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "expand", "value": "images" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Identifier returned by any collection endpoint." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "expand", "value": "images" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Identifier returned by any collection endpoint." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unknown identifier, or a record your key cannot see. Treat as absence.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "expand", "value": "images" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Identifier returned by any collection endpoint." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "expand", "value": "images" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Identifier returned by any collection endpoint." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "expand", "value": "images" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Identifier returned by any collection endpoint." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update a property", "request": { "name": "Update a property", "description": { "content": "Change fields on a record you published.\n\nA partial update: send only what changes. Send If-Match with the ETag from your last read to avoid overwriting a concurrent edit. A record owned by an import source is refused here, because the next run would revert whatever you wrote: change it in the system that feeds the import instead.\n\nRequires the `properties:write` scope.", "type": "text/plain" }, "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to update." } ] }, "header": [ { "disabled": false, "description": "ETag from your last read. Rejected with 412 if the record moved on.", "key": "If-Match", "value": "\"3f8a2c1d9b\"" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"listing\": {\n \"price\": 419000,\n \"status\": \"active\"\n },\n \"title\": \"Top-floor apartment with a south-facing balcony and new windows\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to update." } ] }, "header": [ { "disabled": false, "description": "ETag from your last read. Rejected with 412 if the record moved on.", "key": "If-Match", "value": "\"3f8a2c1d9b\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listing\": {\n \"price\": 419000,\n \"status\": \"active\"\n },\n \"title\": \"Top-floor apartment with a south-facing balcony and new windows\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"prop_8f2a41c9d0\",\n \"type\": \"apartment\",\n \"title\": \"Top-floor apartment with a south-facing balcony\",\n \"description\": \"Altbau flat on a quiet side street, two minutes from Görlitzer Park.\",\n \"listing\": {\n \"transaction_type\": \"sale\",\n \"status\": \"active\",\n \"price\": 429000,\n \"currency\": \"EUR\",\n \"price_per_sqm\": 5797.3,\n \"published_at\": \"2026-07-28T09:12:00Z\"\n },\n \"size\": {\n \"living_area_sqm\": 74\n },\n \"rooms\": {\n \"bedrooms\": 2,\n \"bathrooms\": 1,\n \"total_rooms\": 3,\n \"floor\": 4,\n \"floors_in_building\": 4\n },\n \"building\": {\n \"year_built\": 1908,\n \"construction_type\": \"altbau\",\n \"condition\": \"renovated\",\n \"heating_type\": \"district\"\n },\n \"address\": {\n \"street\": \"Oranienstrasse\",\n \"number\": \"12\",\n \"postal_code\": \"10999\",\n \"city\": \"Berlin\",\n \"district\": \"Kreuzberg\",\n \"country\": \"DE\"\n },\n \"location\": {\n \"latitude\": 52.4993,\n \"longitude\": 13.4184,\n \"precision\": \"street\"\n },\n \"energy\": {\n \"label\": \"C\",\n \"consumption_kwh\": 112.4\n },\n \"source\": \"api\",\n \"created_at\": \"2026-07-28T09:12:00Z\",\n \"updated_at\": \"2026-08-11T14:03:22Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to update." } ] }, "header": [ { "disabled": false, "description": "ETag from your last read. Rejected with 412 if the record moved on.", "key": "If-Match", "value": "\"3f8a2c1d9b\"" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listing\": {\n \"price\": 419000,\n \"status\": \"active\"\n },\n \"title\": \"Top-floor apartment with a south-facing balcony and new windows\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The record exists but your organisation did not publish it.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to update." } ] }, "header": [ { "disabled": false, "description": "ETag from your last read. Rejected with 412 if the record moved on.", "key": "If-Match", "value": "\"3f8a2c1d9b\"" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listing\": {\n \"price\": 419000,\n \"status\": \"active\"\n },\n \"title\": \"Top-floor apartment with a south-facing balcony and new windows\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to update." } ] }, "header": [ { "disabled": false, "description": "ETag from your last read. Rejected with 412 if the record moved on.", "key": "If-Match", "value": "\"3f8a2c1d9b\"" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listing\": {\n \"price\": 419000,\n \"status\": \"active\"\n },\n \"title\": \"Top-floor apartment with a south-facing balcony and new windows\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "managed_by_import. The record belongs to an import source, which is authoritative for it. The body names the source.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to update." } ] }, "header": [ { "disabled": false, "description": "ETag from your last read. Rejected with 412 if the record moved on.", "key": "If-Match", "value": "\"3f8a2c1d9b\"" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listing\": {\n \"price\": 419000,\n \"status\": \"active\"\n },\n \"title\": \"Top-floor apartment with a south-facing balcony and new windows\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "If-Match did not match. Re-read and reapply your change.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to update." } ] }, "header": [ { "disabled": false, "description": "ETag from your last read. Rejected with 412 if the record moved on.", "key": "If-Match", "value": "\"3f8a2c1d9b\"" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listing\": {\n \"price\": 419000,\n \"status\": \"active\"\n },\n \"title\": \"Top-floor apartment with a south-facing balcony and new windows\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to update." } ] }, "header": [ { "disabled": false, "description": "ETag from your last read. Rejected with 412 if the record moved on.", "key": "If-Match", "value": "\"3f8a2c1d9b\"" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listing\": {\n \"price\": 419000,\n \"status\": \"active\"\n },\n \"title\": \"Top-floor apartment with a south-facing balcony and new windows\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties", ":property_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to update." } ] }, "header": [ { "disabled": false, "description": "ETag from your last read. Rejected with 412 if the record moved on.", "key": "If-Match", "value": "\"3f8a2c1d9b\"" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"listing\": {\n \"price\": 419000,\n \"status\": \"active\"\n },\n \"title\": \"Top-floor apartment with a south-facing balcony and new windows\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List images", "request": { "name": "List images", "description": { "content": "Image records for a property, in display order.\n\nRequires the `properties:read` scope.", "type": "text/plain" }, "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"img_2b7d4f1908\",\n \"url\": \"https://images.skautik.com/prop_8f2a41c9d0/1.jpg\",\n \"position\": 1,\n \"is_primary\": true,\n \"room_type\": \"living_room\"\n },\n {\n \"id\": \"img_7e1c9a4b52\",\n \"url\": \"https://images.skautik.com/prop_8f2a41c9d0/2.jpg\",\n \"position\": 2,\n \"is_primary\": false,\n \"room_type\": \"kitchen\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Upload an image", "request": { "name": "Upload an image", "description": { "content": "Attach an image to a record you published.\n\nMultipart upload. JPEG, PNG, or WebP up to 12 MB. Upload only images you hold the rights to: property photography is usually licensed to an agent rather than owned outright.\n\nRequires the `images:write` scope.", "type": "text/plain" }, "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "room_type", "value": "living_room", "description": "What the photograph shows, used to group images and to pick a source for staging." }, { "disabled": true, "key": "primary", "value": "true", "description": "Pass true to make this the primary image, which demotes the current one." } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to attach to." } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) Image payload." }, { "key": "position", "value": "1", "type": "text", "description": "Display order. The image at position 0 is the primary one." } ] } }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "room_type", "value": "living_room" }, { "key": "primary", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to attach to." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image payload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Display order. The image at position 0 is the primary one.", "type": "text/plain" }, "key": "position", "value": "1", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"img_2b7d4f1908\",\n \"url\": \"https://images.skautik.com/prop_8f2a41c9d0/1.jpg\",\n \"position\": 1,\n \"is_primary\": true,\n \"room_type\": \"living_room\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "room_type", "value": "living_room" }, { "key": "primary", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to attach to." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image payload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Display order. The image at position 0 is the primary one.", "type": "text/plain" }, "key": "position", "value": "1", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "room_type", "value": "living_room" }, { "key": "primary", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to attach to." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image payload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Display order. The image at position 0 is the primary one.", "type": "text/plain" }, "key": "position", "value": "1", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "room_type", "value": "living_room" }, { "key": "primary", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to attach to." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image payload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Display order. The image at position 0 is the primary one.", "type": "text/plain" }, "key": "position", "value": "1", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "File exceeds the size limit.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "room_type", "value": "living_room" }, { "key": "primary", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to attach to." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image payload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Display order. The image at position 0 is the primary one.", "type": "text/plain" }, "key": "position", "value": "1", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unsupported image format.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "room_type", "value": "living_room" }, { "key": "primary", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to attach to." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image payload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Display order. The image at position 0 is the primary one.", "type": "text/plain" }, "key": "position", "value": "1", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "room_type", "value": "living_room" }, { "key": "primary", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to attach to." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image payload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Display order. The image at position 0 is the primary one.", "type": "text/plain" }, "key": "position", "value": "1", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "room_type", "value": "living_room" }, { "key": "primary", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to attach to." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image payload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Display order. The image at position 0 is the primary one.", "type": "text/plain" }, "key": "position", "value": "1", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete an image", "request": { "name": "Delete an image", "description": { "content": "Remove an image from a record you published.\n\nRequires the `images:write` scope.", "type": "text/plain" }, "url": { "path": [ "properties", ":property_id", "images", ":image_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." }, { "disabled": false, "type": "any", "value": "img_2b7d4f1908", "key": "image_id", "description": "(Required) Image identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images", ":image_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." }, { "disabled": false, "type": "any", "value": "img_2b7d4f1908", "key": "image_id", "description": "(Required) Image identifier." } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images", ":image_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." }, { "disabled": false, "type": "any", "value": "img_2b7d4f1908", "key": "image_id", "description": "(Required) Image identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images", ":image_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." }, { "disabled": false, "type": "any", "value": "img_2b7d4f1908", "key": "image_id", "description": "(Required) Image identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images", ":image_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." }, { "disabled": false, "type": "any", "value": "img_2b7d4f1908", "key": "image_id", "description": "(Required) Image identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images", ":image_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." }, { "disabled": false, "type": "any", "value": "img_2b7d4f1908", "key": "image_id", "description": "(Required) Image identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "images", ":image_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." }, { "disabled": false, "type": "any", "value": "img_2b7d4f1908", "key": "image_id", "description": "(Required) Image identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Price history", "request": { "name": "Price history", "description": { "content": "Every asking price we observed while tracking the listing.\n\nThese are advertised prices, not transacted ones. A property may well have sold for something quite different from its final asking price.\n\nRequires the `properties:read` scope.", "type": "text/plain" }, "url": { "path": [ "properties", ":property_id", "price-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "price-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"price\": 449000,\n \"currency\": \"EUR\",\n \"observed_at\": \"2026-07-28T09:12:00Z\",\n \"source\": \"listing\"\n },\n {\n \"price\": 429000,\n \"currency\": \"EUR\",\n \"observed_at\": \"2026-08-11T14:03:22Z\",\n \"source\": \"listing\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "price-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "price-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "price-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "price-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "price-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Similar properties", "request": { "name": "Similar properties", "description": { "content": "Comparable records, for context or valuation support.\n\nSimilarity blends location, size, type, and condition. It is a convenience, not an appraisal, and comparables thin out quickly in low-supply areas.\n\nRequires the `properties:read` scope.\n\nAvailability: Growth and above.", "type": "text/plain" }, "url": { "path": [ "properties", ":property_id", "similar" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "10", "description": "Comparables to return, 1 to 50." } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to compare against." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "similar" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to compare against." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"prop_1b77e0a4f2\",\n \"type\": \"apartment\",\n \"title\": \"Garden flat with a separate studio\",\n \"listing\": {\n \"transaction_type\": \"sale\",\n \"status\": \"active\",\n \"price\": 385000,\n \"currency\": \"EUR\",\n \"price_per_sqm\": 4750.62\n },\n \"size\": {\n \"living_area_sqm\": 81\n },\n \"rooms\": {\n \"bedrooms\": 3,\n \"bathrooms\": 1,\n \"total_rooms\": 4,\n \"floor\": 0\n },\n \"building\": {\n \"year_built\": 1962,\n \"condition\": \"good\"\n },\n \"address\": {\n \"street\": \"Weichselstrasse\",\n \"postal_code\": \"12045\",\n \"city\": \"Berlin\",\n \"district\": \"Neukölln\",\n \"country\": \"DE\"\n },\n \"location\": {\n \"latitude\": 52.4812,\n \"longitude\": 13.4331,\n \"precision\": \"area\"\n },\n \"source\": \"import\",\n \"created_at\": \"2026-06-02T08:00:00Z\",\n \"updated_at\": \"2026-08-09T11:20:10Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "similar" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to compare against." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "similar" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to compare against." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "similar" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to compare against." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "similar" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to compare against." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "properties", ":property_id", "similar" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "type": "any", "value": "prop_8f2a41c9d0", "key": "property_id", "description": "(Required) Property to compare against." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Markets", "description": { "content": "Where we have coverage, how each market is subdivided, and the aggregate statistics computed across it.", "type": "text/plain" }, "item": [ { "name": "List markets", "request": { "name": "List markets", "description": { "content": "Every market with coverage, and how deep that coverage runs.\n\nCall this before hardcoding a market identifier. Coverage expands, and a market absent here has no systematic inventory yet rather than no property.\n\nRequires the `markets:read` scope.", "type": "text/plain" }, "url": { "path": [ "markets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "markets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"city\": \"Berlin\",\n \"periods\": [\n \"2026-07\",\n \"2026-06\",\n \"2026-05\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "markets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "markets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "markets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "markets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "markets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve a market", "request": { "name": "Retrieve a market", "description": { "content": "One market with supply and price distribution.\n\nRequires the `markets:read` scope.", "type": "text/plain" }, "url": { "path": [ "markets", ":city" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "period", "value": "2026-07", "description": "Month to report, as YYYY-MM. Defaults to the most recent computed." }, { "disabled": true, "key": "property_type", "value": "apartment", "description": "Restrict the figures to one kind of property." } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier, such as berlin-de." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "markets", ":city" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier, such as berlin-de." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"city\": \"Berlin\",\n \"district\": \"Kreuzberg\",\n \"property_type\": \"apartment\",\n \"period\": \"2026-07\",\n \"metrics\": [\n {\n \"name\": \"median_price\",\n \"value\": 429000,\n \"unit\": \"total\",\n \"currency\": \"EUR\",\n \"change_pct\": 1.8,\n \"sample_size\": 1482,\n \"computed_at\": \"2026-08-01T00:00:00Z\"\n },\n {\n \"name\": \"median_price_per_area\",\n \"value\": 5797,\n \"unit\": \"sqm\",\n \"currency\": \"EUR\",\n \"change_pct\": 2.4,\n \"sample_size\": 1482,\n \"computed_at\": \"2026-08-01T00:00:00Z\"\n },\n {\n \"name\": \"median_days_listed\",\n \"value\": 38,\n \"unit\": \"days\",\n \"sample_size\": 1482,\n \"computed_at\": \"2026-08-01T00:00:00Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "markets", ":city" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier, such as berlin-de." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "markets", ":city" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier, such as berlin-de." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "markets", ":city" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier, such as berlin-de." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "markets", ":city" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier, such as berlin-de." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "markets", ":city" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier, such as berlin-de." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List districts", "request": { "name": "List districts", "description": { "content": "Subdivisions of a market, for building your own filters.\n\nRequires the `markets:read` scope.", "type": "text/plain" }, "url": { "path": [ "markets", ":city", "districts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"district\": \"Kreuzberg\",\n \"listing_count\": 1482\n },\n {\n \"district\": \"Neukölln\",\n \"listing_count\": 1197\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve a district", "request": { "name": "Retrieve a district", "description": { "content": "District-level supply, price distribution, and amenity context.\n\nRequires the `markets:read` scope.\n\nAvailability: Growth and above.", "type": "text/plain" }, "url": { "path": [ "markets", ":city", "districts", ":district" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "period", "value": "2026-07", "description": "Month to report, as YYYY-MM. Defaults to the most recent computed." }, { "disabled": true, "key": "property_type", "value": "apartment", "description": "Restrict the figures to one kind of property." } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." }, { "disabled": false, "type": "any", "value": "kreuzberg", "key": "district", "description": "(Required) District identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts", ":district" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." }, { "disabled": false, "type": "any", "value": "kreuzberg", "key": "district", "description": "(Required) District identifier." } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts", ":district" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." }, { "disabled": false, "type": "any", "value": "kreuzberg", "key": "district", "description": "(Required) District identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts", ":district" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." }, { "disabled": false, "type": "any", "value": "kreuzberg", "key": "district", "description": "(Required) District identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts", ":district" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." }, { "disabled": false, "type": "any", "value": "kreuzberg", "key": "district", "description": "(Required) District identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts", ":district" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." }, { "disabled": false, "type": "any", "value": "kreuzberg", "key": "district", "description": "(Required) District identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "markets", ":city", "districts", ":district" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "2026-07" }, { "key": "property_type", "value": "apartment" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." }, { "disabled": false, "type": "any", "value": "kreuzberg", "key": "district", "description": "(Required) District identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Market statistics", "request": { "name": "Market statistics", "description": { "content": "Supply and price series over time, by property type.\n\nComputed from the catalogue we hold, which means these describe asking behaviour rather than transacted prices. They are not appraisals and must not be used for lending decisions.\n\nRequires the `markets:read` scope.", "type": "text/plain" }, "url": { "path": [ "markets", ":city", "statistics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "property_type", "value": "apartment", "description": "Narrow to one property type." }, { "disabled": true, "key": "transaction_type", "value": "sale", "description": "sale or rent." }, { "disabled": true, "key": "interval", "value": "month", "description": "Granularity of the returned series." }, { "disabled": true, "key": "since", "value": "2026-08-01T00:00:00Z", "description": "RFC 3339 lower bound on the series." } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "markets", ":city", "statistics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "property_type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "interval", "value": "month" }, { "key": "since", "value": "2026-08-01T00:00:00Z" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"city\": \"Berlin\",\n \"property_type\": \"apartment\",\n \"transaction_type\": \"sale\",\n \"interval\": \"month\",\n \"series\": [\n {\n \"period\": \"2026-05\",\n \"listing_count\": 1391,\n \"median_price\": 419000,\n \"median_price_per_area\": 5640,\n \"median_days_listed\": 41\n },\n {\n \"period\": \"2026-06\",\n \"listing_count\": 1435,\n \"median_price\": 424500,\n \"median_price_per_area\": 5712,\n \"median_days_listed\": 39\n },\n {\n \"period\": \"2026-07\",\n \"listing_count\": 1482,\n \"median_price\": 429000,\n \"median_price_per_area\": 5797,\n \"median_days_listed\": 38\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "markets", ":city", "statistics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "property_type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "interval", "value": "month" }, { "key": "since", "value": "2026-08-01T00:00:00Z" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "markets", ":city", "statistics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "property_type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "interval", "value": "month" }, { "key": "since", "value": "2026-08-01T00:00:00Z" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "markets", ":city", "statistics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "property_type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "interval", "value": "month" }, { "key": "since", "value": "2026-08-01T00:00:00Z" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "markets", ":city", "statistics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "property_type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "interval", "value": "month" }, { "key": "since", "value": "2026-08-01T00:00:00Z" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "markets", ":city", "statistics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "property_type", "value": "apartment" }, { "key": "transaction_type", "value": "sale" }, { "key": "interval", "value": "month" }, { "key": "since", "value": "2026-08-01T00:00:00Z" } ], "variable": [ { "disabled": false, "type": "any", "value": "berlin-de", "key": "city", "description": "(Required) Market identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Imports", "description": { "content": "Move inventory in from whatever system already holds it. A one-off import handles a migration; an import source keeps a CRM and Skautik in step indefinitely.", "type": "text/plain" }, "item": [ { "name": "List import sources", "request": { "name": "List import sources", "description": { "content": "Every standing connector your organisation has configured.\n\nCredentials are never returned. A fetched source often holds the login for your own server in its URL, so the URL comes back with the password removed.\n\nRequires the `imports:write` scope.", "type": "text/plain" }, "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"src_immoscout\",\n \"name\": \"Nightly listing sync\",\n \"format\": \"openimmo\",\n \"delivery\": {\n \"type\": \"fetch\",\n \"url\": \"https://partner.example.com/exports/latest.zip\",\n \"username\": \"skautik\"\n },\n \"schedule\": \"15 3 * * *\",\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"deletion_policy\": \"withdraw\",\n \"active\": true,\n \"last_delivery_at\": \"2026-08-13T03:15:04Z\",\n \"next_expected_at\": \"2026-08-14T03:15:00Z\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create an import source", "request": { "name": "Create an import source", "description": { "content": "A standing connector that imports on a schedule.\n\nConfigure once and stop thinking about it. A source holds the format, the delivery method, the field mapping, and the deletion policy, and every run against it produces an import you can inspect.\n\nRequires the `imports:write` scope.", "type": "text/plain" }, "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"deletion_policy\": \"explicit_only\",\n \"delivery\": {\n \"type\": \"fetch_url\",\n \"url\": \"https://feeds.example.com/stock.csv\"\n },\n \"format\": \"csv\",\n \"name\": \"Head office CRM\",\n \"schedule\": \"0 */4 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deletion_policy\": \"explicit_only\",\n \"delivery\": {\n \"type\": \"fetch_url\",\n \"url\": \"https://feeds.example.com/stock.csv\"\n },\n \"format\": \"csv\",\n \"name\": \"Head office CRM\",\n \"schedule\": \"0 */4 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"src_immoscout\",\n \"name\": \"Nightly listing sync\",\n \"format\": \"openimmo\",\n \"delivery\": {\n \"type\": \"fetch\",\n \"url\": \"https://partner.example.com/exports/latest.zip\",\n \"username\": \"skautik\"\n },\n \"schedule\": \"15 3 * * *\",\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"deletion_policy\": \"withdraw\",\n \"active\": true,\n \"last_delivery_at\": \"2026-08-13T03:15:04Z\",\n \"next_expected_at\": \"2026-08-14T03:15:00Z\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deletion_policy\": \"explicit_only\",\n \"delivery\": {\n \"type\": \"fetch_url\",\n \"url\": \"https://feeds.example.com/stock.csv\"\n },\n \"format\": \"csv\",\n \"name\": \"Head office CRM\",\n \"schedule\": \"0 */4 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deletion_policy\": \"explicit_only\",\n \"delivery\": {\n \"type\": \"fetch_url\",\n \"url\": \"https://feeds.example.com/stock.csv\"\n },\n \"format\": \"csv\",\n \"name\": \"Head office CRM\",\n \"schedule\": \"0 */4 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deletion_policy\": \"explicit_only\",\n \"delivery\": {\n \"type\": \"fetch_url\",\n \"url\": \"https://feeds.example.com/stock.csv\"\n },\n \"format\": \"csv\",\n \"name\": \"Head office CRM\",\n \"schedule\": \"0 */4 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deletion_policy\": \"explicit_only\",\n \"delivery\": {\n \"type\": \"fetch_url\",\n \"url\": \"https://feeds.example.com/stock.csv\"\n },\n \"format\": \"csv\",\n \"name\": \"Head office CRM\",\n \"schedule\": \"0 */4 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "import-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deletion_policy\": \"explicit_only\",\n \"delivery\": {\n \"type\": \"fetch_url\",\n \"url\": \"https://feeds.example.com/stock.csv\"\n },\n \"format\": \"csv\",\n \"name\": \"Head office CRM\",\n \"schedule\": \"0 */4 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete an import source", "request": { "name": "Delete an import source", "description": { "content": "Stop importing from this connector.\n\nDeleting a source stops future runs. It does not withdraw the properties it created, which stay under your organisation until you withdraw them yourself.\n\nRequires the `imports:write` scope.", "type": "text/plain" }, "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve an import source", "request": { "name": "Retrieve an import source", "description": { "content": "Configuration and recent run health.\n\nRequires the `imports:write` scope.", "type": "text/plain" }, "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"src_immoscout\",\n \"name\": \"Nightly listing sync\",\n \"format\": \"openimmo\",\n \"delivery\": {\n \"type\": \"fetch\",\n \"url\": \"https://partner.example.com/exports/latest.zip\",\n \"username\": \"skautik\"\n },\n \"schedule\": \"15 3 * * *\",\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"deletion_policy\": \"withdraw\",\n \"active\": true,\n \"last_delivery_at\": \"2026-08-13T03:15:04Z\",\n \"next_expected_at\": \"2026-08-14T03:15:00Z\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update an import source", "request": { "name": "Update an import source", "description": { "content": "Change the mapping, schedule, or deletion policy.\n\nRequires the `imports:write` scope.", "type": "text/plain" }, "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"schedule\": \"15 3 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"schedule\": \"15 3 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"src_immoscout\",\n \"name\": \"Nightly listing sync\",\n \"format\": \"openimmo\",\n \"delivery\": {\n \"type\": \"fetch\",\n \"url\": \"https://partner.example.com/exports/latest.zip\",\n \"username\": \"skautik\"\n },\n \"schedule\": \"15 3 * * *\",\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"deletion_policy\": \"withdraw\",\n \"active\": true,\n \"last_delivery_at\": \"2026-08-13T03:15:04Z\",\n \"next_expected_at\": \"2026-08-14T03:15:00Z\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"schedule\": \"15 3 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"schedule\": \"15 3 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"schedule\": \"15 3 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"schedule\": \"15 3 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "import-sources", ":source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "src_immoscout", "key": "source_id", "description": "(Required) Source identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"mapping\": {\n \"Kaufpreis\": \"price\",\n \"Objektnummer\": \"external_id\"\n },\n \"schedule\": \"15 3 * * *\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List imports", "request": { "name": "List imports", "description": { "content": "Import history for your organisation.\n\nRequires the `imports:write` scope.", "type": "text/plain" }, "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"imp_3d9b7e2145\",\n \"source_id\": \"src_immoscout\",\n \"format\": \"openimmo\",\n \"mode\": \"incremental\",\n \"status\": \"completed\",\n \"dry_run\": false,\n \"filename\": \"transfer-2026-08-12.zip\",\n \"bytes\": 4718592,\n \"counts\": {\n \"read\": 412,\n \"created\": 37,\n \"updated\": 361,\n \"withdrawn\": 9,\n \"unchanged\": 0,\n \"failed\": 0\n },\n \"created_at\": \"0001-01-01T00:00:00Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Start an import", "request": { "name": "Start an import", "description": { "content": "Upload a file, or point us at one, and process it.\n\nAccepts a multipart upload or a URL we fetch. Validation runs first and the whole file is rejected if it cannot be parsed; individual records that fail are reported without stopping the rest, unless you ask for all-or-nothing.\n\nRequires the `imports:write` scope.", "type": "text/plain" }, "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "format", "value": "csv", "description": "(Required) Format of the file being sent." }, { "disabled": true, "key": "mode", "value": "incremental", "description": "Incremental updates what the file contains and leaves the rest alone. A full sync also withdraws anything absent from it, which is why it is not the default." }, { "disabled": true, "key": "source_id", "value": "src_immoscout", "description": "Import source this transfer belongs to, when it comes from a standing connector rather than a one-off upload." }, { "disabled": true, "key": "dry_run", "value": "true", "description": "Parse and report what would change without writing anything. Worth doing once with a new mapping." }, { "disabled": true, "key": "filename", "value": "transfer-2026-08-12.zip", "description": "Original filename, recorded on the run so a failure can be traced back to the file that caused it." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Prevents a retried upload from being processed twice.", "key": "Idempotency-Key", "value": "a7f3c9e2-4b1d-4e8a-9c2f-1d3b5a7c9e01" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "The payload. Mutually exclusive with url." } ] } }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "csv" }, { "key": "mode", "value": "incremental" }, { "key": "source_id", "value": "src_immoscout" }, { "key": "dry_run", "value": "true" }, { "key": "filename", "value": "transfer-2026-08-12.zip" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Prevents a retried upload from being processed twice.", "key": "Idempotency-Key", "value": "a7f3c9e2-4b1d-4e8a-9c2f-1d3b5a7c9e01" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The payload. Mutually exclusive with url.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"imp_3d9b7e2145\",\n \"format\": \"openimmo\",\n \"mode\": \"incremental\",\n \"status\": \"queued\",\n \"dry_run\": false,\n \"filename\": \"transfer-2026-08-12.zip\",\n \"bytes\": 4718592,\n \"counts\": {\n \"read\": 0,\n \"created\": 0,\n \"updated\": 0,\n \"withdrawn\": 0,\n \"unchanged\": 0,\n \"failed\": 0\n },\n \"created_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Accepted for processing. Poll or await import.completed.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "csv" }, { "key": "mode", "value": "incremental" }, { "key": "source_id", "value": "src_immoscout" }, { "key": "dry_run", "value": "true" }, { "key": "filename", "value": "transfer-2026-08-12.zip" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Prevents a retried upload from being processed twice.", "key": "Idempotency-Key", "value": "a7f3c9e2-4b1d-4e8a-9c2f-1d3b5a7c9e01" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The payload. Mutually exclusive with url.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "csv" }, { "key": "mode", "value": "incremental" }, { "key": "source_id", "value": "src_immoscout" }, { "key": "dry_run", "value": "true" }, { "key": "filename", "value": "transfer-2026-08-12.zip" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Prevents a retried upload from being processed twice.", "key": "Idempotency-Key", "value": "a7f3c9e2-4b1d-4e8a-9c2f-1d3b5a7c9e01" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The payload. Mutually exclusive with url.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "csv" }, { "key": "mode", "value": "incremental" }, { "key": "source_id", "value": "src_immoscout" }, { "key": "dry_run", "value": "true" }, { "key": "filename", "value": "transfer-2026-08-12.zip" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Prevents a retried upload from being processed twice.", "key": "Idempotency-Key", "value": "a7f3c9e2-4b1d-4e8a-9c2f-1d3b5a7c9e01" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The payload. Mutually exclusive with url.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "csv" }, { "key": "mode", "value": "incremental" }, { "key": "source_id", "value": "src_immoscout" }, { "key": "dry_run", "value": "true" }, { "key": "filename", "value": "transfer-2026-08-12.zip" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Prevents a retried upload from being processed twice.", "key": "Idempotency-Key", "value": "a7f3c9e2-4b1d-4e8a-9c2f-1d3b5a7c9e01" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The payload. Mutually exclusive with url.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The payload is not the declared format.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "csv" }, { "key": "mode", "value": "incremental" }, { "key": "source_id", "value": "src_immoscout" }, { "key": "dry_run", "value": "true" }, { "key": "filename", "value": "transfer-2026-08-12.zip" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Prevents a retried upload from being processed twice.", "key": "Idempotency-Key", "value": "a7f3c9e2-4b1d-4e8a-9c2f-1d3b5a7c9e01" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The payload. Mutually exclusive with url.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The file parsed but no record in it was usable.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "csv" }, { "key": "mode", "value": "incremental" }, { "key": "source_id", "value": "src_immoscout" }, { "key": "dry_run", "value": "true" }, { "key": "filename", "value": "transfer-2026-08-12.zip" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Prevents a retried upload from being processed twice.", "key": "Idempotency-Key", "value": "a7f3c9e2-4b1d-4e8a-9c2f-1d3b5a7c9e01" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The payload. Mutually exclusive with url.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "csv" }, { "key": "mode", "value": "incremental" }, { "key": "source_id", "value": "src_immoscout" }, { "key": "dry_run", "value": "true" }, { "key": "filename", "value": "transfer-2026-08-12.zip" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Prevents a retried upload from being processed twice.", "key": "Idempotency-Key", "value": "a7f3c9e2-4b1d-4e8a-9c2f-1d3b5a7c9e01" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The payload. Mutually exclusive with url.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List accepted formats and columns", "request": { "name": "List accepted formats and columns", "description": { "content": "What an import may carry: the formats that work today, every CSV column, and the limits.\n\nServed from the same tables the parser reads, so it cannot fall behind what is actually accepted. Worth calling once when you build the integration rather than transcribing the column list from this page.\n\nRequires the `imports:write` scope.", "type": "text/plain" }, "url": { "path": [ "imports", "formats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "imports", "formats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"csv_columns\": [\n \"address_city\",\n \"address_country\",\n \"address_district\",\n \"address_number\",\n \"address_postal_code\",\n \"address_province\",\n \"address_street\",\n \"bathrooms\",\n \"bedrooms\",\n \"condition\",\n \"construction_type\",\n \"currency\",\n \"deposit\",\n \"description\",\n \"energy_consumption_kwh\",\n \"energy_label\",\n \"external_id\",\n \"floor\",\n \"floors_in_building\",\n \"half_bathrooms\",\n \"heating_type\",\n \"latitude\",\n \"living_area_sqm\",\n \"location_precision\",\n \"longitude\",\n \"plot_area_sqm\",\n \"price\",\n \"price_period\",\n \"service_charges\",\n \"status\",\n \"title\",\n \"total_rooms\",\n \"transaction_type\",\n \"type\",\n \"usable_area_sqm\",\n \"year_built\",\n \"year_renovated\"\n ],\n \"formats\": [\n \"csv\",\n \"json\"\n ],\n \"limits\": {\n \"max_bytes\": 33554432,\n \"max_records\": 10000,\n \"required_field\": \"external_id\"\n },\n \"modes\": [\n \"incremental\",\n \"full_sync\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "imports", "formats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "imports", "formats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "imports", "formats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "imports", "formats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "imports", "formats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve an import", "request": { "name": "Retrieve an import", "description": { "content": "Progress, counts, and a summary of what changed.\n\nRequires the `imports:write` scope.", "type": "text/plain" }, "url": { "path": [ "imports", ":import_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "imports", ":import_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"imp_3d9b7e2145\",\n \"source_id\": \"src_immoscout\",\n \"format\": \"openimmo\",\n \"mode\": \"incremental\",\n \"status\": \"completed\",\n \"dry_run\": false,\n \"filename\": \"transfer-2026-08-12.zip\",\n \"bytes\": 4718592,\n \"counts\": {\n \"read\": 412,\n \"created\": 37,\n \"updated\": 361,\n \"withdrawn\": 9,\n \"unchanged\": 0,\n \"failed\": 0\n },\n \"created_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "imports", ":import_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "imports", ":import_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "imports", ":import_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "imports", ":import_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "imports", ":import_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List import records", "request": { "name": "List import records", "description": { "content": "Per-record outcome, including why any failed.\n\nFilter to failed to get the working list for a fix. Each entry names the source identifier and the line or element it came from, so a problem can be found in your export rather than guessed at.\n\nRequires the `imports:write` scope.", "type": "text/plain" }, "url": { "path": [ "imports", ":import_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "imports", ":import_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"location\": \"row 14\",\n \"external_id\": \"OBJ-10041\",\n \"property_id\": \"prop_8f2a41c9d0\",\n \"outcome\": \"updated\"\n },\n {\n \"location\": \"row 15\",\n \"external_id\": \"OBJ-10042\",\n \"outcome\": \"rejected\",\n \"errors\": [\n \"price must be a positive number\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "imports", ":import_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "imports", ":import_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "imports", ":import_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "imports", ":import_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "imports", ":import_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "imp_3d9b7e2145", "key": "import_id", "description": "(Required) Import identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Webhooks", "description": { "content": "Subscribe to changes rather than polling for them. A webhook costs nothing against your request quota, which makes it much cheaper than re-reading a market on a timer.", "type": "text/plain" }, "item": [ { "name": "List webhooks", "request": { "name": "List webhooks", "description": { "content": "Every endpoint your organisation has registered.\n\nThe signing secret is never included. It is shown once when the endpoint is created, and an endpoint list that returned it would hand it to everyone who can read this call.\n\nRequires the `webhooks:manage` scope.", "type": "text/plain" }, "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"whk_1b7e6c19a1\",\n \"url\": \"https://example.com/hooks/skautik\",\n \"events\": [\n \"property.created\",\n \"property.updated\",\n \"property.withdrawn\"\n ],\n \"active\": true,\n \"created_at\": \"2026-08-13T10:43:37Z\",\n \"updated_at\": \"2026-08-13T10:43:37Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create a webhook", "request": { "name": "Create a webhook", "description": { "content": "Register an HTTPS endpoint for a set of events.\n\nThe response includes a signing secret, shown once. Store it immediately: every delivery is signed with it, and a handler that does not verify the signature will accept forged calls from anyone who learns the URL.\n\nRequires the `webhooks:manage` scope.", "type": "text/plain" }, "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"property.created\",\n \"property.withdrawn\"\n ],\n \"url\": \"https://example.com/hooks/skautik\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created. signing_secret appears in this response only.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"property.created\",\n \"property.withdrawn\"\n ],\n \"url\": \"https://example.com/hooks/skautik\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"secret\": \"whsec_uEw7ugUA3saVyNo087Sg3XvhBnWI0txICtik-ySKD2k\",\n \"webhook\": {\n \"active\": true,\n \"created_at\": \"2026-08-13T10:43:37Z\",\n \"events\": [\n \"property.created\",\n \"property.withdrawn\"\n ],\n \"id\": \"whk_1b7e6c19a139404cb173d23fcb3331c4\",\n \"updated_at\": \"2026-08-13T10:43:37Z\",\n \"url\": \"https://example.com/hooks/skautik\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"property.created\",\n \"property.withdrawn\"\n ],\n \"url\": \"https://example.com/hooks/skautik\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"property.created\",\n \"property.withdrawn\"\n ],\n \"url\": \"https://example.com/hooks/skautik\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"property.created\",\n \"property.withdrawn\"\n ],\n \"url\": \"https://example.com/hooks/skautik\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "URL is not HTTPS, unreachable, or an event name is unknown.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"property.created\",\n \"property.withdrawn\"\n ],\n \"url\": \"https://example.com/hooks/skautik\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"property.created\",\n \"property.withdrawn\"\n ],\n \"url\": \"https://example.com/hooks/skautik\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List available events", "request": { "name": "List available events", "description": { "content": "The events an endpoint may subscribe to, with what each means.\n\nServed from the same list the API validates against, so it cannot fall behind what is actually deliverable.\n\nRequires the `webhooks:manage` scope.", "type": "text/plain" }, "url": { "path": [ "webhooks", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "webhooks", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"description\": \"A property was added to your organisation.\",\n \"name\": \"property.created\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "webhooks", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "webhooks", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "webhooks", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "webhooks", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "webhooks", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete a webhook", "request": { "name": "Delete a webhook", "description": { "content": "Stop deliveries and forget the endpoint.\n\nRequires the `webhooks:manage` scope.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve a webhook", "request": { "name": "Retrieve a webhook", "description": { "content": "One endpoint with its recent delivery health.\n\nRequires the `webhooks:manage` scope.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"whk_1b7e6c19a1\",\n \"url\": \"https://example.com/hooks/skautik\",\n \"events\": [\n \"property.created\",\n \"property.updated\",\n \"property.withdrawn\"\n ],\n \"active\": true,\n \"created_at\": \"2026-08-13T10:43:37Z\",\n \"updated_at\": \"2026-08-13T10:43:37Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update a webhook", "request": { "name": "Update a webhook", "description": { "content": "Change the URL, the events, or whether it is active.\n\nA partial update: anything you omit is left alone. Setting active to false stops deliveries without losing the registration, which is what to reach for while you are fixing a handler.\n\nRequires the `webhooks:manage` scope.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"whk_1b7e6c19a1\",\n \"url\": \"https://example.com/hooks/skautik\",\n \"events\": [\n \"property.created\",\n \"property.updated\",\n \"property.withdrawn\"\n ],\n \"active\": true,\n \"created_at\": \"2026-08-13T10:43:37Z\",\n \"updated_at\": \"2026-08-13T10:43:37Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List deliveries", "request": { "name": "List deliveries", "description": { "content": "Recent attempts, their response codes, and retry state.\n\nRetained for 30 days. The place to look when a handler silently stopped working.\n\nRequires the `webhooks:manage` scope.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhook_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "status", "value": "succeeded", "description": "Filter by outcome." }, { "disabled": true, "key": "limit", "value": "100", "description": "How many attempts to return, newest first. Capped at 100." } ], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "succeeded" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"dlv_9c4e1f2308\",\n \"event\": \"property.created\",\n \"status\": \"delivered\",\n \"attempts\": 1,\n \"max_attempts\": 6,\n \"response_status\": 200,\n \"delivered_at\": \"2026-08-13T10:44:02Z\",\n \"created_at\": \"2026-08-13T10:44:01Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "succeeded" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "succeeded" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "succeeded" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "succeeded" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "succeeded" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Rotate the signing secret", "request": { "name": "Rotate the signing secret", "description": { "content": "Issue a new secret and stop the old one immediately.\n\nWhat to reach for if a secret leaks. The previous secret stops working the moment this returns, so deliveries signed with it will fail verification: deploy the new one before rotating, or accept a gap.\n\nRequires the `webhooks:manage` scope.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"note\": \"The previous secret stopped working immediately.\",\n \"secret\": \"whsec_4_j7SxmfWXaoJnLbkypLXAw-Pjs8J74_OyWb-oj7fik\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Send a test delivery", "request": { "name": "Send a test delivery", "description": { "content": "Fire a synthetic event to prove your handler works.\n\nSends a webhook.test event with the same signing and retry behaviour as a real delivery, so you can verify signature checking before anything real depends on it.\n\nRequires the `webhooks:manage` scope.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":webhook_id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "webhooks", ":webhook_id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "whk_1b7e6c19a139404cb173d23fcb3331c4", "key": "webhook_id", "description": "(Required) Webhook identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Exports", "description": { "content": "Bulk extracts for volumes that would be unreasonable to page through. An export is asynchronous: you request one, we build it, and you fetch the file when it is ready.", "type": "text/plain" }, "item": [ { "name": "List exports", "request": { "name": "List exports", "description": { "content": "Recent exports for your organisation, newest first.\n\nStatuses only. Download links are not included here: minting one per row would sign a URL for every export you have ever made on a call you probably wanted statuses from. Fetch the export itself for a link.\n\nRequires the `exports:create` scope.", "type": "text/plain" }, "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"exp_74c0ab5e91\",\n \"status\": \"pending\",\n \"format\": \"ndjson\",\n \"created_at\": \"2026-08-12T10:04:00Z\",\n \"expires_at\": \"0001-01-01T00:00:00Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Request an export", "request": { "name": "Request an export", "description": { "content": "Queue a bulk extract of the catalogue.\n\nAccepts the same filters as the list endpoint. Returns immediately with a pending export; subscribe to export.completed rather than polling. Note that a narrowed field set may not round trip: feeding an export back into an import needs the columns an import requires, external_id and type among them, so omit fields for analysis rather than for a re-import.\n\nRequires the `exports:create` scope.", "type": "text/plain" }, "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"external_id\",\n \"price\",\n \"living_area_sqm\",\n \"address_city\"\n ],\n \"filters\": {\n \"city\": \"Berlin\",\n \"status\": \"active\"\n },\n \"format\": \"ndjson\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"external_id\",\n \"price\",\n \"living_area_sqm\",\n \"address_city\"\n ],\n \"filters\": {\n \"city\": \"Berlin\",\n \"status\": \"active\"\n },\n \"format\": \"ndjson\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"exp_74c0ab5e91\",\n \"status\": \"pending\",\n \"format\": \"ndjson\",\n \"created_at\": \"2026-08-12T10:04:00Z\",\n \"expires_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"external_id\",\n \"price\",\n \"living_area_sqm\",\n \"address_city\"\n ],\n \"filters\": {\n \"city\": \"Berlin\",\n \"status\": \"active\"\n },\n \"format\": \"ndjson\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"external_id\",\n \"price\",\n \"living_area_sqm\",\n \"address_city\"\n ],\n \"filters\": {\n \"city\": \"Berlin\",\n \"status\": \"active\"\n },\n \"format\": \"ndjson\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"external_id\",\n \"price\",\n \"living_area_sqm\",\n \"address_city\"\n ],\n \"filters\": {\n \"city\": \"Berlin\",\n \"status\": \"active\"\n },\n \"format\": \"ndjson\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"external_id\",\n \"price\",\n \"living_area_sqm\",\n \"address_city\"\n ],\n \"filters\": {\n \"city\": \"Berlin\",\n \"status\": \"active\"\n },\n \"format\": \"ndjson\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"external_id\",\n \"price\",\n \"living_area_sqm\",\n \"address_city\"\n ],\n \"filters\": {\n \"city\": \"Berlin\",\n \"status\": \"active\"\n },\n \"format\": \"ndjson\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve an export", "request": { "name": "Retrieve an export", "description": { "content": "Status, and the download URL once it is ready.\n\nDownload URLs are signed and expire one hour after issue, and are minted per request rather than stored, so ask again if one lapses. The file itself is kept for seven days; after that the export still appears in your history with no link, because the object has been swept.\n\nRequires the `exports:create` scope.", "type": "text/plain" }, "url": { "path": [ "exports", ":export_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "exp_74c0ab", "key": "export_id", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "exports", ":export_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "exp_74c0ab", "key": "export_id", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"exp_74c0ab5e91\",\n \"status\": \"ready\",\n \"format\": \"ndjson\",\n \"record_count\": 18432,\n \"byte_size\": 24518720,\n \"download_url\": \"https://exports.skautik.com/exp_74c0ab5e91.ndjson.gz\",\n \"created_at\": \"2026-08-12T10:04:00Z\",\n \"expires_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "exports", ":export_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "exp_74c0ab", "key": "export_id", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "exports", ":export_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "exp_74c0ab", "key": "export_id", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "exports", ":export_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "exp_74c0ab", "key": "export_id", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "exports", ":export_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "exp_74c0ab", "key": "export_id", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "exports", ":export_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "exp_74c0ab", "key": "export_id", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Account and status", "description": { "content": "Endpoints about your key rather than about property.", "type": "text/plain" }, "item": [ { "name": "Service status", "request": { "name": "Service status", "description": { "content": "Unauthenticated liveness check.\n\nServed at the host root rather than under the versioned prefix, and answered without a key. Use it to tell an outage from a credential problem: a healthy host that refuses your calls is an authentication question, not an availability one.", "type": "text/plain" }, "url": { "path": [ "healthz" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "healthz" ], "host": [ "{{healthz-Url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\",\n \"version\": \"2026-08-01\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Key introspection", "request": { "name": "Key introspection", "description": { "content": "Which organisation a key belongs to, its plan, and its remaining quota.\n\nUseful in a health check: it proves a key is valid without spending a meaningful request, and it reports both limits without waiting to be refused by either. Read burst_per_second and pace yourself, rather than discovering the burst limit through a 429.\n\nRequires the `properties:read` scope.", "type": "text/plain" }, "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "An organisation on a negotiated plan reports quota as { \"metered\": false } rather than a limit of zero, which would read as an allowance of nothing.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"api_key_id\": \"key_7b7d501a194845f9b6a9cd0162c5b8c5\",\n \"organization_id\": \"org_67c6bc5cf2a74bc1a8d18656db5a2dba\",\n \"quota\": {\n \"burst_per_second\": 3,\n \"limit\": 100000,\n \"metered\": true,\n \"remaining\": 99988,\n \"resets_at\": \"2026-09-12T15:12:56Z\",\n \"used\": 12\n },\n \"scopes\": [\n \"properties:read\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Inquiries", "description": { "content": "Enquiries people have made about your properties, and the state you have moved each one to. Scoped to the properties your organisation owns: an enquiry belongs to whoever owns the property it is about.", "type": "text/plain" }, "item": [ { "name": "List inquiries", "request": { "name": "List inquiries", "description": { "content": "Enquiries about your properties, newest first.\n\nCursor paginated like every other collection. Filter by property or by status to build a work queue rather than paging the lot.\n\nRequires the `inquiries:read` scope.", "type": "text/plain" }, "url": { "path": [ "inquiries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "status", "value": "new", "description": "Only enquiries in this state." }, { "disabled": true, "key": "property_id", "value": "prop_9ad0ddd2e01949ddb471899aba67d577", "description": "Only enquiries about this property." }, { "disabled": true, "key": "limit", "value": "50", "description": "Page size. Clamped to 200." }, { "disabled": true, "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9", "description": "Opaque cursor from the previous page's meta.next_cursor." }, { "disabled": true, "key": "sort", "value": "-created_at", "description": "Field to order by. Prefix with a minus for descending." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "inquiries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "new" }, { "key": "property_id", "value": "prop_9ad0ddd2e01949ddb471899aba67d577" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"inq_db6f3d5316\",\n \"property_id\": \"prop_8f2a41c9d0\",\n \"sender_name\": \"Anna Schmidt\",\n \"sender_email\": \"anna.schmidt@example.com\",\n \"sender_phone\": \"+49 30 5550172\",\n \"message\": \"Is the balcony south facing, and is the kitchen included?\",\n \"status\": \"new\",\n \"channel\": \"web\",\n \"created_at\": \"0001-01-01T00:00:00Z\"\n }\n ],\n \"meta\": {\n \"has_more\": false,\n \"limit\": 50,\n \"next_cursor\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "inquiries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "new" }, { "key": "property_id", "value": "prop_9ad0ddd2e01949ddb471899aba67d577" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "inquiries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "new" }, { "key": "property_id", "value": "prop_9ad0ddd2e01949ddb471899aba67d577" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "inquiries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "new" }, { "key": "property_id", "value": "prop_9ad0ddd2e01949ddb471899aba67d577" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "inquiries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "new" }, { "key": "property_id", "value": "prop_9ad0ddd2e01949ddb471899aba67d577" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "inquiries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "new" }, { "key": "property_id", "value": "prop_9ad0ddd2e01949ddb471899aba67d577" }, { "key": "limit", "value": "50" }, { "key": "cursor", "value": "eyJpZCI6InByb3BfMWI3N2UwYTRmMiJ9" }, { "key": "sort", "value": "-created_at" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve an inquiry", "request": { "name": "Retrieve an inquiry", "description": { "content": "One enquiry in full.\n\nAn enquiry about a property your organisation does not own answers exactly as a missing one does, so the API cannot be used to probe for records you cannot read.\n\nRequires the `inquiries:read` scope.", "type": "text/plain" }, "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"inq_db6f3d5316\",\n \"property_id\": \"prop_8f2a41c9d0\",\n \"sender_name\": \"Anna Schmidt\",\n \"sender_email\": \"anna.schmidt@example.com\",\n \"sender_phone\": \"+49 30 5550172\",\n \"message\": \"Is the balcony south facing, and is the kitchen included?\",\n \"status\": \"new\",\n \"channel\": \"web\",\n \"created_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Set the status", "request": { "name": "Set the status", "description": { "content": "Move an enquiry through your workflow.\n\nSetting replied records when it happened, and that record survives a later move to closed: the fact that somebody was answered is not undone by filing the conversation away.\n\nRequires the `inquiries:read` scope.", "type": "text/plain" }, "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"status\": \"replied\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"replied\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"inq_db6f3d5316\",\n \"property_id\": \"prop_8f2a41c9d0\",\n \"sender_name\": \"Anna Schmidt\",\n \"sender_email\": \"anna.schmidt@example.com\",\n \"sender_phone\": \"+49 30 5550172\",\n \"message\": \"Is the balcony south facing, and is the kitchen included?\",\n \"status\": \"new\",\n \"channel\": \"web\",\n \"created_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"replied\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"replied\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"replied\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"replied\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"replied\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Mark as read", "request": { "name": "Mark as read", "description": { "content": "Record that you have seen it.\n\nread_at is set once and does not move on later calls. It answers when you first saw the enquiry, which is what the person waiting for a reply cares about; overwriting it would answer when you last looked, which nobody asked. Marking read will not pull a status backwards: an enquiry you have already replied to stays replied.\n\nRequires the `inquiries:read` scope.", "type": "text/plain" }, "url": { "path": [ "inquiries", ":inquiry_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "inquiries", ":inquiry_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "inq_db6f3d5316884c649ea1848c278bbf44", "key": "inquiry_id", "description": "(Required) Inquiry identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Image generations", "description": { "content": "Transform a photograph you have already uploaded: stage an empty room, remove clutter, or correct how a picture was taken. Each request is queued and produced in the background.", "type": "text/plain" }, "item": [ { "name": "List generations", "request": { "name": "List generations", "description": { "content": "Recent requests for your organisation, newest first.\n\nRequires the `images:write` scope.", "type": "text/plain" }, "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"gen_5c1e9a2b3d\",\n \"kind\": \"staging\",\n \"status\": \"completed\",\n \"property_id\": \"prop_8f2a41c9d0\",\n \"source_image_id\": \"img_2b7d4f1908\",\n \"created_at\": \"0001-01-01T00:00:00Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Request a generation", "request": { "name": "Request a generation", "description": { "content": "Queue a transformation of one of your property images.\n\nReturns immediately with a queued generation. Poll the retrieve endpoint, or subscribe to a webhook, rather than holding the request open. The source image must already belong to one of your properties: there is no way to submit an arbitrary URL, which is deliberate.\n\nRequires the `images:write` scope.", "type": "text/plain" }, "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"kind\": \"virtual_staging\",\n \"room_type\": \"living room\",\n \"source_image_id\": \"img_ce1c9e04db6140eda7c6934af60daebb\",\n \"style\": \"scandinavian\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"virtual_staging\",\n \"room_type\": \"living room\",\n \"source_image_id\": \"img_ce1c9e04db6140eda7c6934af60daebb\",\n \"style\": \"scandinavian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"gen_5c1e9a2b3d\",\n \"kind\": \"staging\",\n \"status\": \"queued\",\n \"property_id\": \"prop_8f2a41c9d0\",\n \"source_image_id\": \"img_2b7d4f1908\",\n \"created_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"virtual_staging\",\n \"room_type\": \"living room\",\n \"source_image_id\": \"img_ce1c9e04db6140eda7c6934af60daebb\",\n \"style\": \"scandinavian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"virtual_staging\",\n \"room_type\": \"living room\",\n \"source_image_id\": \"img_ce1c9e04db6140eda7c6934af60daebb\",\n \"style\": \"scandinavian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The source image does not exist, or is not on one of your properties. The two are indistinguishable on purpose.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"virtual_staging\",\n \"room_type\": \"living room\",\n \"source_image_id\": \"img_ce1c9e04db6140eda7c6934af60daebb\",\n \"style\": \"scandinavian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"virtual_staging\",\n \"room_type\": \"living room\",\n \"source_image_id\": \"img_ce1c9e04db6140eda7c6934af60daebb\",\n \"style\": \"scandinavian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "generations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"virtual_staging\",\n \"room_type\": \"living room\",\n \"source_image_id\": \"img_ce1c9e04db6140eda7c6934af60daebb\",\n \"style\": \"scandinavian\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List what can be generated", "request": { "name": "List what can be generated", "description": { "content": "The transformations available, and what each does.\n\nServed from the same list the API validates against, so it cannot fall behind. It also names what is deliberately not available and why, which is more useful than an absence you have to infer.\n\nRequires the `images:write` scope.", "type": "text/plain" }, "url": { "path": [ "generations", "kinds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "generations", "kinds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"kinds\": [\n {\n \"description\": \"Furnish an empty room in a chosen style, leaving the architecture untouched.\",\n \"kind\": \"virtual_staging\"\n },\n {\n \"description\": \"Remove personal clutter from a room without changing the furniture or the fabric of the building.\",\n \"kind\": \"decluttering\"\n },\n {\n \"description\": \"Correct exposure, white balance, and straightness, without altering what the photograph shows.\",\n \"kind\": \"enhancement\"\n }\n ],\n \"not_available\": [\n {\n \"kind\": \"floorplan_render\",\n \"reason\": \"Named in the schema and not implemented. Rendering a floor plan needs a provider we have not integrated, and a plausible but wrong plan of somebody's home is worse than none.\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "generations", "kinds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "generations", "kinds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "generations", "kinds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "generations", "kinds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "generations", "kinds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve a generation", "request": { "name": "Retrieve a generation", "description": { "content": "Status, and the image once it is ready.\n\nMoves through queued, running, and then completed or failed. A failed generation carries the reason, including when the model declined rather than errored: those are different problems and only one is worth retrying.\n\nRequires the `images:write` scope.", "type": "text/plain" }, "url": { "path": [ "generations", ":generation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "gen_5c1e9a2b3d", "key": "generation_id", "description": "(Required) Generation identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The request succeeded.", "originalRequest": { "url": { "path": [ "generations", ":generation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "gen_5c1e9a2b3d", "key": "generation_id", "description": "(Required) Generation identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"gen_5c1e9a2b3d\",\n \"kind\": \"staging\",\n \"status\": \"completed\",\n \"property_id\": \"prop_8f2a41c9d0\",\n \"source_image_id\": \"img_2b7d4f1908\",\n \"created_at\": \"0001-01-01T00:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The API key is missing or not valid.", "originalRequest": { "url": { "path": [ "generations", ":generation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "gen_5c1e9a2b3d", "key": "generation_id", "description": "(Required) Generation identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The key does not carry the scope this endpoint requires.", "originalRequest": { "url": { "path": [ "generations", ":generation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "gen_5c1e9a2b3d", "key": "generation_id", "description": "(Required) Generation identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No such record, or one belonging to another organisation.", "originalRequest": { "url": { "path": [ "generations", ":generation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "gen_5c1e9a2b3d", "key": "generation_id", "description": "(Required) Generation identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request was understood and something in it is not acceptable.", "originalRequest": { "url": { "path": [ "generations", ":generation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "gen_5c1e9a2b3d", "key": "generation_id", "description": "(Required) Generation identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The rate limit or the plan's monthly allowance is exhausted.", "originalRequest": { "url": { "path": [ "generations", ":generation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "gen_5c1e9a2b3d", "key": "generation_id", "description": "(Required) Generation identifier." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"code\": \"not_found\",\n \"detail\": \"No property with that id, or one belonging to another organisation.\",\n \"errors\": [\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n },\n {\n \"code\": \"invalid\",\n \"detail\": \"Must be a positive whole number of minor units.\",\n \"field\": \"price\"\n }\n ],\n \"request_id\": \"req_8f2a41c9d0\",\n \"status\": 404,\n \"title\": \"Not found\",\n \"type\": \"https://skautik.com/developers/docs/errors#not_found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.skautik.com/v1/api", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "info": { "name": "Skautik Partner API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Generated from the Skautik OpenAPI description.\n\nSet `apiKey` in the environment to a key from the developer console. Every request authenticates with it through the collection's own auth, so there is no Authorization header to paste into each one.\n\n`baseUrl` points at production. Change it in one place to point the whole collection somewhere else." } }