{ "info": { "_postman_id": "6e5cdd52-917b-4271-9c01-17cacaac9de5", "name": "Arthur Units API", "description": "Arthur Units API - the units surface of the Arthur API v2, the UK property management platform from Arthur Online (an Aareon company). Derived operation-for-operation from the provider's public Postman Documenter collection at https://developer.arthuronline.co.uk/. Every request is scoped to an Arthur entity via the mandatory X-EntityID header and authorised with an OAuth 2.0 Authorization Code access token.\n\nContact Support:\n Name: Arthur Online API Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:04:58.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "lastUpdatedBy": "35240", "uid": "35240-6e5cdd52-917b-4271-9c01-17cacaac9de5" }, "item": [ { "name": "units", "item": [ { "name": "{unit_id}", "item": [ { "name": "property", "item": [ { "name": "View parent Property", "id": "5a4c52e9-ec56-4fb9-9a5e-8da3f4dd5f84", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/property", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "property" ], "variable": [ { "id": "60289dff-2573-4a41-9d44-7cd6223df6a3", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves the property associated with the given unit ID." }, "response": [ { "id": "b6d3caec-85fa-45fe-b5d8-eea2d74ff5fc", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/property", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "property" ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-b6d3caec-85fa-45fe-b5d8-eea2d74ff5fc" }, { "id": "2eb18cfd-7000-414a-8076-f2f085812e3f", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/property", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "property" ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-2eb18cfd-7000-414a-8076-f2f085812e3f" }, { "id": "7b509946-5d77-4f63-8ba2-b4188fa4b47b", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/property", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "property" ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-7b509946-5d77-4f63-8ba2-b4188fa4b47b" }, { "id": "d9b12fa7-ea6f-404a-b1b8-f19a26e5b59a", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/property", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "property" ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-d9b12fa7-ea6f-404a-b1b8-f19a26e5b59a" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-5a4c52e9-ec56-4fb9-9a5e-8da3f4dd5f84" } ], "id": "ddb7dbe0-b4a5-49c4-9353-24c827b35586", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-ddb7dbe0-b4a5-49c4-9353-24c827b35586" }, { "name": "assets", "item": [ { "name": "List Assets On Unit", "id": "e99ec185-76cc-49b7-9bf5-08c081affb34", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/assets?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "44d08ac7-8de0-4e20-a85e-456c6e2c2fad", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of assets associated with the given unit ID." }, "response": [ { "id": "a4e3480e-2c67-46fe-9a32-0314a4a51d72", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/assets?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-a4e3480e-2c67-46fe-9a32-0314a4a51d72" }, { "id": "e077b7e6-61ba-4692-b957-033390981118", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/assets?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e077b7e6-61ba-4692-b957-033390981118" }, { "id": "74bcc3d2-77b3-4909-8294-e37cf01815e1", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/assets?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-74bcc3d2-77b3-4909-8294-e37cf01815e1" }, { "id": "bd663032-09af-4246-8a72-235df7fbcb32", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/assets?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-bd663032-09af-4246-8a72-235df7fbcb32" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e99ec185-76cc-49b7-9bf5-08c081affb34" }, { "name": "Create Asset On Unit", "id": "fd3210b0-17b4-411b-8285-30cb11a0e5d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "53f0cc69-19d6-4faa-a935-f9facf6c38a4", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new asset related to a unit . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nasset_type \n image \n String \n No \n\nname \n inventory \n String \n No \n\nshare_manager \n true \n Boolean \n No \n\nshare_tenant \n false \n Boolean \n No \n\nshare_contractor \n true \n Boolean \n No \n\nshare_owner \n true \n Boolean \n No \n\nfile \n base64 \n String \n Yes \n\nmime_type \n application/pdf \n String \n Yes \n\nfile_name \n inventory \n String \n Yes" }, "response": [ { "id": "31d8f31f-8b31-44df-936a-13e102589f28", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-31d8f31f-8b31-44df-936a-13e102589f28" }, { "id": "d054d019-ed22-4336-8a46-1e640b78acff", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-d054d019-ed22-4336-8a46-1e640b78acff" }, { "id": "79c54278-8184-4457-8583-08ea47687883", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-79c54278-8184-4457-8583-08ea47687883" }, { "id": "84ab2c55-2ba5-4671-afed-7116b7d8784d", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-84ab2c55-2ba5-4671-afed-7116b7d8784d" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-fd3210b0-17b4-411b-8285-30cb11a0e5d9" } ], "id": "474d7fc2-9fa9-4295-83c6-26ae94a9f01f", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-474d7fc2-9fa9-4295-83c6-26ae94a9f01f" }, { "name": "certificates", "item": [ { "name": "List Certificates On Unit", "id": "4b213d44-6f2f-49c8-b552-cd3b81280568", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/certificates?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "certificates" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "939da84d-5cea-4452-99c4-df3ff0fc88b1", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of certificates associated with the given unit ID." }, "response": [ { "id": "b23232c7-3c80-46be-bf79-f9357c8fe60b", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/certificates?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "certificates" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-b23232c7-3c80-46be-bf79-f9357c8fe60b" }, { "id": "ebcef5c7-4127-48be-b24d-41cb7ec4d7e0", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/certificates?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "certificates" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-ebcef5c7-4127-48be-b24d-41cb7ec4d7e0" }, { "id": "ac966e9a-dede-4bcc-96c3-dfc96a9c2b57", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/certificates?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "certificates" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-ac966e9a-dede-4bcc-96c3-dfc96a9c2b57" }, { "id": "8c5c63ed-7a8d-440b-8481-90e274cd1fd0", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/certificates?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "certificates" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-8c5c63ed-7a8d-440b-8481-90e274cd1fd0" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-4b213d44-6f2f-49c8-b552-cd3b81280568" }, { "name": "Add Certificate on Unit", "id": "13a2eea3-c8ee-4eb0-97cd-4e14e7f97679", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"expiry_date\": \"\",\n \"notes\": \"\",\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/certificates?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "certificates" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "1fb0a55d-ee61-40e8-ab51-0b96b6184b45", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new certificate related to a\u00a0 property . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntype \n Boiler Service \n String \n Yes \n\nexpiry_date \n 2023-12-05 \n String \n No \n\nnotes \n Fully assessed \n String \n No \n\nfile \n Base64 \n String \n No \n\nmime_type \n application/pdf \n String \n No (Required if File field is present) \n\nfile_name \n Certificate Document \n string \n No (Required if File field is present)" }, "response": [ { "id": "80da7c50-9c11-4faf-890c-4f6d8868e152", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"expiry_date\": \"\",\n \"notes\": \"\",\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/certificates?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "certificates" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"data\": {}\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-80da7c50-9c11-4faf-890c-4f6d8868e152" }, { "id": "0bc4215b-3e9c-41cb-aa4c-628325c173a4", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"expiry_date\": \"\",\n \"notes\": \"\",\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/certificates?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "certificates" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-0bc4215b-3e9c-41cb-aa4c-628325c173a4" }, { "id": "e1e63b85-0a55-4a53-92f4-21b61e01c0d5", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"expiry_date\": \"\",\n \"notes\": \"\",\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/certificates?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "certificates" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e1e63b85-0a55-4a53-92f4-21b61e01c0d5" }, { "id": "58f700f4-1075-48c2-aabd-d14d256a2d46", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"expiry_date\": \"\",\n \"notes\": \"\",\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/certificates?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "certificates" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-58f700f4-1075-48c2-aabd-d14d256a2d46" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-13a2eea3-c8ee-4eb0-97cd-4e14e7f97679" } ], "id": "b1368288-1007-4193-8ec7-ffc3bc4deb73", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-b1368288-1007-4193-8ec7-ffc3bc4deb73" }, { "name": "conversation_recipients", "item": [ { "name": "Get Recipients for Unit", "id": "99d226ae-1b6f-429d-9dc9-26f8a9896cd2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversation_recipients" ], "variable": [ { "id": "6264e7a6-5977-4111-a249-e3270e861e58", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of conversation recipients on a unit record, identified by its unique\u00a0 unit_id ." }, "response": [ { "id": "ce2ed79f-d8bc-468c-9669-0df78bfe0e4f", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversation_recipients" ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-ce2ed79f-d8bc-468c-9669-0df78bfe0e4f" }, { "id": "72ddbc2c-5df6-4b79-9e3b-8d18c37526fd", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversation_recipients" ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-72ddbc2c-5df6-4b79-9e3b-8d18c37526fd" }, { "id": "46d2feb3-beab-4322-8ab4-47948f752f8b", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversation_recipients" ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-46d2feb3-beab-4322-8ab4-47948f752f8b" }, { "id": "2185a802-63b5-4fe5-95ff-e5e6cbfab95a", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversation_recipients" ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-2185a802-63b5-4fe5-95ff-e5e6cbfab95a" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-99d226ae-1b6f-429d-9dc9-26f8a9896cd2" } ], "id": "107cddb2-29b3-412d-899a-a3abefc4fe85", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-107cddb2-29b3-412d-899a-a3abefc4fe85" }, { "name": "conversations", "item": [ { "name": "List Conversation On Unit", "id": "d6fad654-7819-4f71-8528-32666d193a97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/conversations?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversations" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "18687f4b-921c-4e37-8251-38b6c1d3d1bd", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of conversations associated with the given unit ID." }, "response": [ { "id": "9af6bdb2-efa3-4223-8c39-0f1cb7a4d368", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/conversations?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversations" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-9af6bdb2-efa3-4223-8c39-0f1cb7a4d368" }, { "id": "e889bfcd-c049-43cd-9709-84b545567cbd", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/conversations?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversations" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e889bfcd-c049-43cd-9709-84b545567cbd" }, { "id": "5e4984e4-b92c-4d2e-a774-c9cd815e2484", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/conversations?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversations" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-5e4984e4-b92c-4d2e-a774-c9cd815e2484" }, { "id": "0fec2259-c2b4-4f65-ba0f-ed224f46d15a", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/conversations?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversations" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-0fec2259-c2b4-4f65-ba0f-ed224f46d15a" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-d6fad654-7819-4f71-8528-32666d193a97" }, { "name": "Create Conversation On Unit", "id": "e7faa013-4b9b-4f7e-9763-5f7f5dee8c43", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"subject\": \"\",\n \"person_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversations" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "9c9b1edb-362a-45e1-8bf3-38e682104db3", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new conversation related to a unit . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nmessage \n It's done \n String \n Yes \n\nsubject \n Meeting tomorrow \n String \n Yes \n\nperson_ids \n ['1','2'] \n Array(String) \n Yes" }, "response": [ { "id": "e402ff70-a944-4291-9c25-8ae1e348a9f4", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"subject\": \"\",\n \"person_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversations" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e402ff70-a944-4291-9c25-8ae1e348a9f4" }, { "id": "a2bb0a63-d40c-4e28-91de-60d9317749e9", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"subject\": \"\",\n \"person_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversations" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-a2bb0a63-d40c-4e28-91de-60d9317749e9" }, { "id": "89aeee29-a113-47e2-9b6b-4202461850a2", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"subject\": \"\",\n \"person_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversations" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-89aeee29-a113-47e2-9b6b-4202461850a2" }, { "id": "8af1aa08-c2b1-4f8c-837c-67f187801366", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"subject\": \"\",\n \"person_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "conversations" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-8af1aa08-c2b1-4f8c-837c-67f187801366" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e7faa013-4b9b-4f7e-9763-5f7f5dee8c43" } ], "id": "9d7befc2-69fd-4ffa-90df-2d7b8a5eb16c", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-9d7befc2-69fd-4ffa-90df-2d7b8a5eb16c" }, { "name": "faqs", "item": [ { "name": "List General Info for Unit", "id": "773c4805-f456-4aa6-8d1b-7fd7c19633d6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/faqs?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "faqs" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "bb0ab131-edb2-4fa0-9c2c-d5e88bcefb36", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of general information records associated with the given unit ID." }, "response": [ { "id": "ce27741e-dee3-4bd6-9e79-08f61f973b8a", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/faqs?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "faqs" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-ce27741e-dee3-4bd6-9e79-08f61f973b8a" }, { "id": "48375b6c-8a1e-4a80-94e8-55e46503fdc6", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/faqs?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "faqs" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-48375b6c-8a1e-4a80-94e8-55e46503fdc6" }, { "id": "9a263d0c-a02e-43e5-bcb4-da66413947fc", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/faqs?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "faqs" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-9a263d0c-a02e-43e5-bcb4-da66413947fc" }, { "id": "9661bf00-d4c2-45fa-b845-ca8a1d1d5a39", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/faqs?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "faqs" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-9661bf00-d4c2-45fa-b845-ca8a1d1d5a39" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-773c4805-f456-4aa6-8d1b-7fd7c19633d6" }, { "name": "Add General Info for Unit", "id": "24a12a94-a29d-483a-a978-65fe8edeb894", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"faq_type\": \"\",\n \"share_owner\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/faqs?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "faqs" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "51994955-cc7b-4454-ac79-fe7e040dceb7", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new general information record for the unit . The API will return the saved data and a unique general information ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n\ntitle \n Maintenance \n String \n\ndescription \n Weekly clean \n String \n\nfaq_type \n General \n String \n\nshare_owner \n true \n Boolean \n\nshare_tenant \n true \n Boolean \n\nshare_contractor \n false \n Boolean" }, "response": [ { "id": "6ece947b-6eca-47a0-926a-2e1246adef3c", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"faq_type\": \"\",\n \"share_owner\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/faqs?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "faqs" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"data\": {}\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-6ece947b-6eca-47a0-926a-2e1246adef3c" }, { "id": "452caba3-e54e-49b1-905f-7d796126860f", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"faq_type\": \"\",\n \"share_owner\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/faqs?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "faqs" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-452caba3-e54e-49b1-905f-7d796126860f" }, { "id": "52f2df1c-1120-4783-96d3-f9440f7300df", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"faq_type\": \"\",\n \"share_owner\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/faqs?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "faqs" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-52f2df1c-1120-4783-96d3-f9440f7300df" }, { "id": "7c578b9b-b491-4519-914b-ee03b75212f8", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"faq_type\": \"\",\n \"share_owner\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/faqs?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "faqs" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-7c578b9b-b491-4519-914b-ee03b75212f8" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-24a12a94-a29d-483a-a978-65fe8edeb894" } ], "id": "1010705b-977a-433c-a37e-ce83cd9b7696", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-1010705b-977a-433c-a37e-ce83cd9b7696" }, { "name": "notes", "item": [ { "name": "{note_id}", "item": [ { "name": "View Note On Unit", "id": "710879e0-a2de-4897-8d24-8f2adb4c3272", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "variable": [ { "id": "acf7109c-dbed-4d67-a62b-b842f80906ec", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." }, { "id": "d27ef6e6-1672-4fde-ad8a-4c67b051b55e", "key": "note_id", "value": "", "description": "(Required) Arthur note id." } ] }, "description": "This API endpoint retrieves the details of a single\u00a0 note , identified by its unique\u00a0 id ." }, "response": [ { "id": "c727211d-e8e1-4a08-ad65-eb7f9aa03d3d", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-c727211d-e8e1-4a08-ad65-eb7f9aa03d3d" }, { "id": "fd9b6518-58c3-4dae-a219-92d6d9d2d3ff", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-fd9b6518-58c3-4dae-a219-92d6d9d2d3ff" }, { "id": "ab07b3e0-a967-491d-82e6-20d07e141001", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-ab07b3e0-a967-491d-82e6-20d07e141001" }, { "id": "e803379a-32eb-4a52-903f-5bbcf977cb19", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e803379a-32eb-4a52-903f-5bbcf977cb19" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-710879e0-a2de-4897-8d24-8f2adb4c3272" }, { "name": "Update Note On Unit", "id": "71f7fb2e-1358-4c88-9c29-9f1ee1d1e2a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "8e95e8cf-0f86-4382-94f4-5158ed0857be", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." }, { "id": "bf406167-5de3-4068-8b33-594599687b55", "key": "note_id", "value": "", "description": "(Required) Arthur note id." } ] }, "description": "This endpoint updates an existing note using the same fields as the 'Add Note' endpoint. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n No \n\ntags \n ['one','two'] \n Array(String) \n No" }, "response": [ { "id": "a057cf19-6680-4b92-bb34-ad5f46fb495f", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-a057cf19-6680-4b92-bb34-ad5f46fb495f" }, { "id": "75de42c4-9071-4966-840c-514c6e326df2", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-75de42c4-9071-4966-840c-514c6e326df2" }, { "id": "208f3b9f-df28-437f-aabc-995ec0db98cb", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-208f3b9f-df28-437f-aabc-995ec0db98cb" }, { "id": "ac86ea56-6cd8-49bc-a19e-3546ec3858a1", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-ac86ea56-6cd8-49bc-a19e-3546ec3858a1" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-71f7fb2e-1358-4c88-9c29-9f1ee1d1e2a2" }, { "name": "Delete Note On Unit", "id": "d671f9ad-beec-44d3-8d8b-f2fcc8573189", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "variable": [ { "id": "88c84c6f-ec0c-4890-a050-9110c3c622d0", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." }, { "id": "36ed1bcd-bb1a-4182-a6d8-987353ac58d8", "key": "note_id", "value": "", "description": "(Required) Arthur note id." } ] }, "description": "This endpoint deletes an existing note using the note\u00a0 id ." }, "response": [ { "id": "c285241c-192e-4810-9287-5f12942fcaa9", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-c285241c-192e-4810-9287-5f12942fcaa9" }, { "id": "454a5b8d-2d8d-47cf-937f-6666c5b9b301", "name": "The request was invalid or malformed.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-454a5b8d-2d8d-47cf-937f-6666c5b9b301" }, { "id": "257b93fd-7c7f-4ee5-960f-5b8b3989bb73", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-257b93fd-7c7f-4ee5-960f-5b8b3989bb73" }, { "id": "5ec7032d-5931-4212-a953-a363aee5cd79", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes", ":note_id" ], "variable": [ { "key": "unit_id" }, { "key": "note_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-5ec7032d-5931-4212-a953-a363aee5cd79" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-d671f9ad-beec-44d3-8d8b-f2fcc8573189" } ], "id": "0995710e-7ecd-4909-b517-6f6cafcc3752", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-0995710e-7ecd-4909-b517-6f6cafcc3752" }, { "name": "List Notes On Unit", "id": "8ba57240-7f78-43ac-9d91-e1dc762b737b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "2ad40acb-ad6b-454f-95d8-97c363e68aa3", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of\u00a0 notes \u00a0associated with the given unit ID." }, "response": [ { "id": "1afddb41-1b6d-4786-a7d4-47f0e240c0f5", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-1afddb41-1b6d-4786-a7d4-47f0e240c0f5" }, { "id": "e1e4e153-dcec-4097-8f40-766114e873e0", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e1e4e153-dcec-4097-8f40-766114e873e0" }, { "id": "4e4d5c7d-723b-468d-9808-07fa3df64fd5", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-4e4d5c7d-723b-468d-9808-07fa3df64fd5" }, { "id": "15fd8b45-dfca-4b9e-8ea4-8cf889cd6a58", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/notes?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-15fd8b45-dfca-4b9e-8ea4-8cf889cd6a58" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-8ba57240-7f78-43ac-9d91-e1dc762b737b" }, { "name": "Add Note On Unit", "id": "84db7b8f-cbd5-4b65-b566-7661d397f1f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "1d332b40-f127-4ac3-b8c2-d8e227fe5796", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new note record for the unit . The API will return the saved data and a unique note ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n Yes" }, "response": [ { "id": "e44465aa-3d71-4af9-bbfa-8338a032fe26", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e44465aa-3d71-4af9-bbfa-8338a032fe26" }, { "id": "cf44a013-2240-4529-9d36-406de569a574", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-cf44a013-2240-4529-9d36-406de569a574" }, { "id": "37164f8c-16f7-4903-8cae-b06b8a071773", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-37164f8c-16f7-4903-8cae-b06b8a071773" }, { "id": "6ccae9a3-8fa0-498e-8ee6-da21413b3cc8", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "notes" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-6ccae9a3-8fa0-498e-8ee6-da21413b3cc8" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-84db7b8f-cbd5-4b65-b566-7661d397f1f0" } ], "id": "2ba52462-5095-4847-80f1-c6eb238a64f6", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-2ba52462-5095-4847-80f1-c6eb238a64f6" }, { "name": "viewings", "item": [ { "name": "List Viewings on Unit", "id": "f587b7e5-017a-4641-b0ed-62f46263b4ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/viewings?status=&assignedTo=&viewingDate=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "viewings" ], "query": [ { "description": "Filter the viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assignedTo", "value": "" }, { "description": "Filter the viewings by the date.", "key": "viewingDate", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "72952663-bf94-4b01-8dc7-9675dd00d01f", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of viewings associated with the given unit ID." }, "response": [ { "id": "b91fdf25-5b35-404d-958a-514fc62a6a39", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/viewings?status=&assignedTo=&viewingDate=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "viewings" ], "query": [ { "description": "Filter the viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assignedTo", "value": "" }, { "description": "Filter the viewings by the date.", "key": "viewingDate", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-b91fdf25-5b35-404d-958a-514fc62a6a39" }, { "id": "7d98efb5-321b-439f-9504-53babd1bc935", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/viewings?status=&assignedTo=&viewingDate=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "viewings" ], "query": [ { "description": "Filter the viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assignedTo", "value": "" }, { "description": "Filter the viewings by the date.", "key": "viewingDate", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-7d98efb5-321b-439f-9504-53babd1bc935" }, { "id": "e684bd96-b390-41c4-8406-b5b37cee9d83", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/viewings?status=&assignedTo=&viewingDate=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "viewings" ], "query": [ { "description": "Filter the viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assignedTo", "value": "" }, { "description": "Filter the viewings by the date.", "key": "viewingDate", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e684bd96-b390-41c4-8406-b5b37cee9d83" }, { "id": "c292980b-e8ed-4b8e-8d11-f1e24e4c6ea9", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/viewings?status=&assignedTo=&viewingDate=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "viewings" ], "query": [ { "description": "Filter the viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assignedTo", "value": "" }, { "description": "Filter the viewings by the date.", "key": "viewingDate", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-c292980b-e8ed-4b8e-8d11-f1e24e4c6ea9" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-f587b7e5-017a-4641-b0ed-62f46263b4ce" }, { "name": "Add Viewing on Unit", "id": "13d0803e-ed9f-4e6e-8917-f8691f92b050", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"applicant_id\": \"\",\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"Month\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "viewings" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "id": "5700c1e3-45e0-409f-9f88-08a83a974f37", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new viewing record for the\u00a0 unit . The API will return the saved data and a unique viewing ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Default \n Required? \n\napplicant_id \n 123 \n Integer \n\nYes \n\nviewing_date \n 2019-05-28 \n Date \n\nNo \n\nviewing_time \n 00:00 \n Time \n\nNo \n\noffer_amount \n 250.00 \n Float \n\nNo \n\noffer_frequency \n Week \n Enum \n Month \n No \n\nmove_in_date \n 2019-07-01 \n Date \n\nNo \n\nassigned_to_ids \n [123,124] \n Array (Integer) \n\nNo \n\nsource \n My website \n Simple \n\nNo \n\nnotes \n Landlord will be present for this viewing. \n String \n\nNo" }, "response": [ { "id": "08bb4084-c194-46f8-898d-1ac58c004672", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"applicant_id\": \"\",\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"Month\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "viewings" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-08bb4084-c194-46f8-898d-1ac58c004672" }, { "id": "afc2f911-5fd3-444c-a071-109776e18b32", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"applicant_id\": \"\",\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"Month\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "viewings" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-afc2f911-5fd3-444c-a071-109776e18b32" }, { "id": "aa0c28f1-eb65-4c82-91e1-bbc564962aa9", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"applicant_id\": \"\",\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"Month\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "viewings" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-aa0c28f1-eb65-4c82-91e1-bbc564962aa9" }, { "id": "1835d4d4-dead-4fc9-b2f4-aa67f5e646bc", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"applicant_id\": \"\",\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"Month\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "viewings" ], "query": [ { "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-1835d4d4-dead-4fc9-b2f4-aa67f5e646bc" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-13d0803e-ed9f-4e6e-8917-f8691f92b050" } ], "id": "71c3c6f4-71fb-430c-9148-9b01b1ffe01d", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-71c3c6f4-71fb-430c-9148-9b01b1ffe01d" }, { "name": "tenancies", "item": [ { "name": "List Tenancies on Unit", "id": "62c6df35-c520-4fd6-b732-3ba3a09a1c8a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tenancies?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tenancies" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "001a0968-42d8-4e9f-88e0-692d58af1b81", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of tenancies associated with the given unit ID." }, "response": [ { "id": "4b810c92-a4b5-425e-b69d-07724c3c3f53", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tenancies?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tenancies" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-4b810c92-a4b5-425e-b69d-07724c3c3f53" }, { "id": "08105e52-8f2c-4ce0-9b1e-92463659b756", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tenancies?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tenancies" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-08105e52-8f2c-4ce0-9b1e-92463659b756" }, { "id": "5acea9b6-7535-46a8-8ed3-b3d5ff4559c7", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tenancies?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tenancies" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-5acea9b6-7535-46a8-8ed3-b3d5ff4559c7" }, { "id": "2189d8c5-75bf-466c-b189-caf24400fe0e", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tenancies?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tenancies" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-2189d8c5-75bf-466c-b189-caf24400fe0e" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-62c6df35-c520-4fd6-b732-3ba3a09a1c8a" }, { "name": "Add Tenancy On Unit", "id": "c49824b4-9579-434a-8371-7291530ffc90", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"rent_amount\": \"\",\n \"status\": \"\",\n \"tenancy_type\": \"\",\n \"letting_agent_id\": \"\",\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"end_date\": \"\",\n \"break_clause_date\": \"\",\n \"fixed_break_date\": \"\",\n \"rolling_break_date\": \"\",\n \"notice_period\": \"1 months\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"\",\n \"move_in_time\": \"\",\n \"move_out_date\": \"\",\n \"move_out_time\": \"\",\n \"rent_frequency\": \"\",\n \"deposit_held_by\": \"\",\n \"rent_payment_bank_id\": \"\",\n \"deposit_payment_bank_id\": \"\",\n \"default_rent_payment_method\": \"\",\n \"rent_insured\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tenancies" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "a7b4fe2b-b82a-45b2-8ffb-9b6f64f97739", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new tenancy record for the\u00a0 unit . The API will return the saved data and a unique tenancy ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Default \n Required? \n\nstatus \n Current \n Integer \n Prospective \n No \n\ntenancy_type \n Commercial \n Integer \n Residential \n No \n\nletting_agent_id \n 90909 \n Integer \n\nNo \n\ncontract_type \n Company \n String \n\nNo \n\nrenter_company \n Renter Ltd. \n String \n\nNo \n\nstart_date \n 2019-01-01 \n Date \n\nYes \n\nend_date \n 2020-01-01 \n Date \n\nNo \n\nbreak_clause_date \n 2019-06-01 \n Date \n\nNo \n\nfixed_break_date \n 2019-06-01 \n Date \n\nNo \n\nrolling_break_date \n 2019-09-18 \n Date \n\nNo \n\nnotice_period \n 2 months \n String \n 1 months \n No \n\nissue_break_clause_to \n landlord \n String \n\nNo \n\nmove_in_date \n 2019-01-01 \n Date \n\nNo \n\nmove_in_time \n 12:00 \n Time \n\nNo \n\nmove_out_date \n 2020-01-01 \n Date \n\nNo \n\nmove_out_time \n 12:00 \n Time \n\nNo \n\nrent_amount \n 875 \n Float \n\nYes \n\nrent_frequency \n Monthly \n String \n\nNo \n\ndeposit_held_by \n DPS \n String \n\nNo \n\nrent_payment_bank_id \n 1423 \n Integer \n\nNo \n\ndeposit_payment_bank_id \n 4132 \n Integer \n\nNo \n\ndefault_rent_payment_method \n Bank Transfer \n String \n\nNo \n\nrent_insured \n false \n Boolean \n\nNo \n\ntags \n [\"12 month contract\"] \n Array (String) \n\nNo" }, "response": [ { "id": "01d69f18-417c-4a89-a8c4-7c0bce4d5662", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"rent_amount\": \"\",\n \"status\": \"\",\n \"tenancy_type\": \"\",\n \"letting_agent_id\": \"\",\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"end_date\": \"\",\n \"break_clause_date\": \"\",\n \"fixed_break_date\": \"\",\n \"rolling_break_date\": \"\",\n \"notice_period\": \"1 months\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"\",\n \"move_in_time\": \"\",\n \"move_out_date\": \"\",\n \"move_out_time\": \"\",\n \"rent_frequency\": \"\",\n \"deposit_held_by\": \"\",\n \"rent_payment_bank_id\": \"\",\n \"deposit_payment_bank_id\": \"\",\n \"default_rent_payment_method\": \"\",\n \"rent_insured\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tenancies" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-01d69f18-417c-4a89-a8c4-7c0bce4d5662" }, { "id": "9836f694-b703-44a5-8cfa-76580ea30dc0", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"rent_amount\": \"\",\n \"status\": \"\",\n \"tenancy_type\": \"\",\n \"letting_agent_id\": \"\",\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"end_date\": \"\",\n \"break_clause_date\": \"\",\n \"fixed_break_date\": \"\",\n \"rolling_break_date\": \"\",\n \"notice_period\": \"1 months\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"\",\n \"move_in_time\": \"\",\n \"move_out_date\": \"\",\n \"move_out_time\": \"\",\n \"rent_frequency\": \"\",\n \"deposit_held_by\": \"\",\n \"rent_payment_bank_id\": \"\",\n \"deposit_payment_bank_id\": \"\",\n \"default_rent_payment_method\": \"\",\n \"rent_insured\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tenancies" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-9836f694-b703-44a5-8cfa-76580ea30dc0" }, { "id": "79dd3dcb-99cd-4939-a284-6ed7ea7eecce", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"rent_amount\": \"\",\n \"status\": \"\",\n \"tenancy_type\": \"\",\n \"letting_agent_id\": \"\",\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"end_date\": \"\",\n \"break_clause_date\": \"\",\n \"fixed_break_date\": \"\",\n \"rolling_break_date\": \"\",\n \"notice_period\": \"1 months\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"\",\n \"move_in_time\": \"\",\n \"move_out_date\": \"\",\n \"move_out_time\": \"\",\n \"rent_frequency\": \"\",\n \"deposit_held_by\": \"\",\n \"rent_payment_bank_id\": \"\",\n \"deposit_payment_bank_id\": \"\",\n \"default_rent_payment_method\": \"\",\n \"rent_insured\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tenancies" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-79dd3dcb-99cd-4939-a284-6ed7ea7eecce" }, { "id": "7a5f93bf-710f-4138-aadc-d79d004c18e1", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"rent_amount\": \"\",\n \"status\": \"\",\n \"tenancy_type\": \"\",\n \"letting_agent_id\": \"\",\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"end_date\": \"\",\n \"break_clause_date\": \"\",\n \"fixed_break_date\": \"\",\n \"rolling_break_date\": \"\",\n \"notice_period\": \"1 months\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"\",\n \"move_in_time\": \"\",\n \"move_out_date\": \"\",\n \"move_out_time\": \"\",\n \"rent_frequency\": \"\",\n \"deposit_held_by\": \"\",\n \"rent_payment_bank_id\": \"\",\n \"deposit_payment_bank_id\": \"\",\n \"default_rent_payment_method\": \"\",\n \"rent_insured\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tenancies" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-7a5f93bf-710f-4138-aadc-d79d004c18e1" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-c49824b4-9579-434a-8371-7291530ffc90" } ], "id": "2aed855c-12e4-4396-bfeb-a8aa93d50a1e", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-2aed855c-12e4-4396-bfeb-a8aa93d50a1e" }, { "name": "tasks", "item": [ { "name": "{task_id}", "item": [ { "name": "View Task On Unit", "id": "cbf856d0-7fe7-4d2d-92ee-f216cf56e2a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "variable": [ { "id": "52179b0b-a664-45d2-921c-01f9a3133746", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." }, { "id": "48b337ef-cffd-438e-8927-26dd5e96b49e", "key": "task_id", "value": "", "description": "(Required) Arthur task id." } ] }, "description": "This API endpoint retrieves the details of a single unit\u00a0 task , identified by its unique\u00a0 id ." }, "response": [ { "id": "277e5381-4995-47ae-8e80-34ee6c02af4b", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-277e5381-4995-47ae-8e80-34ee6c02af4b" }, { "id": "d1e4b5c2-421e-41b2-8df0-a588482bb0c7", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-d1e4b5c2-421e-41b2-8df0-a588482bb0c7" }, { "id": "b824faff-0879-4a5a-ad62-87c872f94378", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-b824faff-0879-4a5a-ad62-87c872f94378" }, { "id": "a9f6e838-1ac6-4e68-9887-e2c5f3a006db", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-a9f6e838-1ac6-4e68-9887-e2c5f3a006db" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-cbf856d0-7fe7-4d2d-92ee-f216cf56e2a7" }, { "name": "Update Task On Unit", "id": "6e0a2e8f-51bf-4fc0-9440-22175c779d77", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"task_type\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "d630cc89-77c6-4c65-b450-856116c61b8a", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." }, { "id": "ad36fd0d-651b-42ed-bb8a-4259679a73f5", "key": "task_id", "value": "", "description": "(Required) Arthur task id." } ] }, "description": "This endpoint updates an existing task using the same fields as the 'Add Task' endpoint. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntask_type \n Inspection \n String \n No \n\ndescription \n Radiator not working \n String \n No \n\ntags \n ['one','two'] \n Array(String) \n No \n\ndue_date \n 2020-10-11 \n Date \n No \n\ndue_time \n 15:32 \n Time \n No \n\nassigned_managers \n [123,1234] \n Array(Integer) \n No \n\nemergency \n True \n Boolean \n No \n\nprivate \n True \n Boolean \n No \n\napi_notes \n Landlord will be present \n String \n No" }, "response": [ { "id": "5356a08c-8a25-4ded-a68b-41ebff56c3b2", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"task_type\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-5356a08c-8a25-4ded-a68b-41ebff56c3b2" }, { "id": "89c41745-8174-4345-a76a-a78b16f17edc", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"task_type\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-89c41745-8174-4345-a76a-a78b16f17edc" }, { "id": "207012ec-ff24-44f6-95ba-c4d5b81627c6", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"task_type\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-207012ec-ff24-44f6-95ba-c4d5b81627c6" }, { "id": "2e73a212-93f9-42ec-b9ee-c9f2218e2a46", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"task_type\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-2e73a212-93f9-42ec-b9ee-c9f2218e2a46" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-6e0a2e8f-51bf-4fc0-9440-22175c779d77" }, { "name": "Delete Task On Unit", "id": "e7e80a85-d93d-4ebd-a2f0-4c9b72384e7e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "variable": [ { "id": "e27c3af5-5ec9-4a03-846b-73256ab8b544", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." }, { "id": "db151e49-4941-47a2-a956-122d5d52b938", "key": "task_id", "value": "", "description": "(Required) Arthur task id." } ] }, "description": "This endpoint deletes an existing asset record using the task\u00a0 id , under a unit ID" }, "response": [ { "id": "f38c0275-85c9-4832-91ca-f63c9244d942", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-f38c0275-85c9-4832-91ca-f63c9244d942" }, { "id": "08156580-d6db-4106-b67e-1582105dcbdb", "name": "The request was invalid or malformed.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-08156580-d6db-4106-b67e-1582105dcbdb" }, { "id": "a339e4ce-c604-491f-b044-9a08edcd99b2", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-a339e4ce-c604-491f-b044-9a08edcd99b2" }, { "id": "9558fa0c-f79b-44b6-8126-88fd16a117e5", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks", ":task_id" ], "variable": [ { "key": "unit_id" }, { "key": "task_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-9558fa0c-f79b-44b6-8126-88fd16a117e5" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e7e80a85-d93d-4ebd-a2f0-4c9b72384e7e" } ], "id": "da8d4b8c-dbcf-41b8-a037-1a4c29d74c66", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-da8d4b8c-dbcf-41b8-a037-1a4c29d74c66" }, { "name": "List Tasks On Unit", "id": "9ee7b0c2-cae3-4e92-998a-ffed36a25127", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "1bbbaf7c-1ed5-42c4-bfe7-1320f028f762", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of tasks associated with the given unit ID." }, "response": [ { "id": "0558d6a5-2372-496a-8cc9-d97671610be0", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-0558d6a5-2372-496a-8cc9-d97671610be0" }, { "id": "bad8f5ab-feac-4a6c-800a-69a903921a8a", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-bad8f5ab-feac-4a6c-800a-69a903921a8a" }, { "id": "02309094-72fa-4f32-8760-59d74fe7ffab", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-02309094-72fa-4f32-8760-59d74fe7ffab" }, { "id": "497dd4e6-a784-4d7d-bfc4-0259ae38df5a", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-497dd4e6-a784-4d7d-bfc4-0259ae38df5a" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-9ee7b0c2-cae3-4e92-998a-ffed36a25127" }, { "name": "Add Task On Unit", "id": "e784e590-effd-4b08-8994-8766772dce56", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"task_type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "8cda4e5d-cd7d-484c-8910-a19a9f2046ef", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new task record for the unit . The API will return the saved data and a unique task ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntask_type \n Inspection \n String \n No \n\ndescription \n Radiator not working \n String \n Yes \n\ntags \n ['one','two'] \n Array(String) \n No \n\ndue_date \n 2020-10-11 \n Date \n No \n\ndue_time \n 15:32 \n Time \n No \n\nassigned_managers \n [123,1234] \n Array(Integer) \n No \n\nemergency \n True \n Boolean \n No \n\nprivate \n True \n Boolean \n No \n\napi_notes \n Landlord will be present \n String \n No \n\nfiles \n\n(each object must contain \"file_type\", \"file_name\", and \"file\") \n { \n\"file_type\":\"application/pdf\", \n\"file_name\":\"testing\", \n\"file\":\"(base 64)\" \n} \n [Array {Objects}] \n No" }, "response": [ { "id": "852e1c59-8998-4569-bb49-3237bae50e77", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"task_type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-852e1c59-8998-4569-bb49-3237bae50e77" }, { "id": "55817481-8286-454a-9968-cb097d962e6f", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"task_type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-55817481-8286-454a-9968-cb097d962e6f" }, { "id": "9333eaa9-9c25-4cbf-93cb-e3b2a25c7720", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"task_type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-9333eaa9-9c25-4cbf-93cb-e3b2a25c7720" }, { "id": "91a9b846-ca82-455b-a2f2-1a66414072e6", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"task_type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tasks?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tasks" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-91a9b846-ca82-455b-a2f2-1a66414072e6" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e784e590-effd-4b08-8994-8766772dce56" } ], "id": "af3ff335-a4f6-4d26-8343-b654a359367d", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-af3ff335-a4f6-4d26-8343-b654a359367d" }, { "name": "workorders", "item": [ { "name": "{workorder_id}", "item": [ { "name": "View Workorders On Unit", "id": "2f8738fc-8863-46e6-86d0-8903f3f5bbe6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders/:workorder_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders", ":workorder_id" ], "variable": [ { "id": "f2dd895d-8c0c-4b5e-8307-e8afd17fda12", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." }, { "id": "1df38624-4c5a-4340-86aa-90ce0b415678", "key": "workorder_id", "value": "", "description": "(Required) Arthur workorder id." } ] }, "description": "This API endpoint retrieves the details of a single unit\u00a0 workorder , identified by its unique\u00a0 id ." }, "response": [ { "id": "528b888e-ed10-4c5c-bbad-f035a7e75760", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders/:workorder_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders", ":workorder_id" ], "variable": [ { "key": "unit_id" }, { "key": "workorder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-528b888e-ed10-4c5c-bbad-f035a7e75760" }, { "id": "a0edafb2-d76d-4e52-be08-b2fc662119c2", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders/:workorder_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders", ":workorder_id" ], "variable": [ { "key": "unit_id" }, { "key": "workorder_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-a0edafb2-d76d-4e52-be08-b2fc662119c2" }, { "id": "3086feb8-2f96-47f7-baae-a9540477049c", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders/:workorder_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders", ":workorder_id" ], "variable": [ { "key": "unit_id" }, { "key": "workorder_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-3086feb8-2f96-47f7-baae-a9540477049c" }, { "id": "05f384fb-cd49-48b2-a399-1c3b4a1c1157", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders/:workorder_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders", ":workorder_id" ], "variable": [ { "key": "unit_id" }, { "key": "workorder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-05f384fb-cd49-48b2-a399-1c3b4a1c1157" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-2f8738fc-8863-46e6-86d0-8903f3f5bbe6" }, { "name": "Update Workorders On Unit", "id": "71a488ce-7f4c-4da3-ac6a-e06a6848069c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"service_type\": \"\",\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders/:workorder_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders", ":workorder_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "cf5c6f29-e988-465a-8dbd-451ea8e2d82e", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." }, { "id": "53e9c64c-7aec-49ab-ad87-9aed229fc808", "key": "workorder_id", "value": "", "description": "(Required) Arthur workorder id." } ] }, "description": "This endpoint updates an existing workorder using the same fields as the 'Add Workorder' endpoint. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n No \n\nstart_date \n 2020-02-20 \n Date \n No \n\ndue_date \n 2020-02-20 \n Date \n No \n\nbudget \n 1000,00 \n Float \n No \n\nallocated_time_hours \n 20 \n Float \n No \n\nactual_time_hours \n 20 \n Float \n No \n\nprice_per_hour \n 7,90 \n Float \n No \n\nemergency \n true \n Boolean \n No \n\nquote_required \n true \n Boolean \n No \n\nshare_assets \n false \n Boolean \n No \n\nhide_tenant_details \n true \n Boolean \n No" }, "response": [ { "id": "5a7c0589-24e9-43a9-b540-7f05078385ff", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"service_type\": \"\",\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders/:workorder_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders", ":workorder_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "workorder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-5a7c0589-24e9-43a9-b540-7f05078385ff" }, { "id": "0e948f67-0600-4bd5-b869-7e3e3d4bc4d5", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"service_type\": \"\",\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders/:workorder_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders", ":workorder_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "workorder_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-0e948f67-0600-4bd5-b869-7e3e3d4bc4d5" }, { "id": "b2517e3e-ff4c-421a-9abc-c67b2cf8b38a", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"service_type\": \"\",\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders/:workorder_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders", ":workorder_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "workorder_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-b2517e3e-ff4c-421a-9abc-c67b2cf8b38a" }, { "id": "4b501c9e-d51d-4735-ab53-edc0298825c8", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"service_type\": \"\",\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders/:workorder_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders", ":workorder_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" }, { "key": "workorder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-4b501c9e-d51d-4735-ab53-edc0298825c8" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-71a488ce-7f4c-4da3-ac6a-e06a6848069c" } ], "id": "a0963a3f-3839-455f-97d2-579115ff20dc", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-a0963a3f-3839-455f-97d2-579115ff20dc" }, { "name": "List Workorders On Unit", "id": "3ec768c6-60d5-4ec8-8c23-631a1bda9c0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "8a137021-54f9-45e1-b202-5ee443c4bc78", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of workorders associated with the given unit ID." }, "response": [ { "id": "83d33291-ec9d-4bca-9c53-4357bde3b0d2", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-83d33291-ec9d-4bca-9c53-4357bde3b0d2" }, { "id": "3f0b8b2d-b186-4e43-98f7-c62665e6924a", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-3f0b8b2d-b186-4e43-98f7-c62665e6924a" }, { "id": "70e40473-ab10-428c-96ea-a4c09a38a042", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-70e40473-ab10-428c-96ea-a4c09a38a042" }, { "id": "c5371bb0-e803-4068-b1a9-26f5da12ba86", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-c5371bb0-e803-4068-b1a9-26f5da12ba86" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-3ec768c6-60d5-4ec8-8c23-631a1bda9c0a" }, { "name": "Create Workorders On Unit", "id": "4fb3260f-3849-4ea6-9786-025a200bb2a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "595d190e-267e-450b-994b-16e005c4419a", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new workorder record for the unit . The API will return the saved data and a unique workorder ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n Yes \n\nstart_date \n 2020-02-20 \n Date \n No \n\ndue_date \n 2020-02-20 \n Date \n No \n\nbudget \n 1000,00 \n Float \n No \n\nallocated_time_hours \n 20 \n Float \n No \n\nactual_time_hours \n 20 \n Float \n No \n\nprice_per_hour \n 7,90 \n Float \n No \n\nemergency \n true \n Boolean \n No \n\nquote_required \n true \n Boolean \n No \n\nshare_assets \n false \n Boolean \n No \n\nhide_tenant_details \n true \n Boolean \n No" }, "response": [ { "id": "d07e5213-c301-4bfc-9beb-0eb1fdd3f79d", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-d07e5213-c301-4bfc-9beb-0eb1fdd3f79d" }, { "id": "f3d31556-6839-4d7e-a000-f4f91a27e965", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-f3d31556-6839-4d7e-a000-f4f91a27e965" }, { "id": "0d2d6212-6e8a-4f03-961a-71bf86f9e133", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-0d2d6212-6e8a-4f03-961a-71bf86f9e133" }, { "id": "566e2d78-bc7f-47ca-9a86-4cfad3facf20", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/workorders?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "workorders" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-566e2d78-bc7f-47ca-9a86-4cfad3facf20" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-4fb3260f-3849-4ea6-9786-025a200bb2a6" } ], "id": "c4e26622-6144-41ab-8e01-5fc3482800d4", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-c4e26622-6144-41ab-8e01-5fc3482800d4" }, { "name": "utilities", "item": [ { "name": "List Utilities On Unit", "id": "2bbbd422-6ed2-41db-b5da-5f11b0b87806", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/utilities?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "utilities" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "f4055987-6e99-4319-8090-e5b00a451e54", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint retrieves a list of utilities associated with the given unit ID." }, "response": [ { "id": "d5facff4-03c2-4e97-a8ac-e840861df551", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/utilities?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "utilities" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-d5facff4-03c2-4e97-a8ac-e840861df551" }, { "id": "0de87686-2284-48bb-9210-433030bed7b7", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/utilities?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "utilities" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-0de87686-2284-48bb-9210-433030bed7b7" }, { "id": "14008c0c-ab99-4fe7-b34b-5aa5f29d5426", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/utilities?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "utilities" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-14008c0c-ab99-4fe7-b34b-5aa5f29d5426" }, { "id": "b5b3d075-be43-4590-a84f-4f803111265c", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/utilities?page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "utilities" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-b5b3d075-be43-4590-a84f-4f803111265c" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-2bbbd422-6ed2-41db-b5da-5f11b0b87806" }, { "name": "Create Utility On Unit", "id": "b9ac4580-908c-4ae9-bd88-93cb46de2703", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"notes\": \"\",\n \"serial_number\": \"\",\n \"account_number\": \"\",\n \"provider\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/utilities?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "utilities" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "9ad6cd44-8362-43d4-a436-88c024fbebf9", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new utility record for the unit . The API will return the saved data and a unique utility ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntype \n gas \n String \n Yes \n\nnotes \n behind back doors \n String \n No \n\nserial_number \n GA212FP21 \n String \n No \n\naccount_number \n 12344321 \n string \n No \n\nprovider \n company_name \n string \n No" }, "response": [ { "id": "2b08e4d0-3df3-4a76-8170-c32e27f603c6", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"notes\": \"\",\n \"serial_number\": \"\",\n \"account_number\": \"\",\n \"provider\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/utilities?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "utilities" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-2b08e4d0-3df3-4a76-8170-c32e27f603c6" }, { "id": "1741a24a-1313-4251-91ea-94b0a51499d3", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"notes\": \"\",\n \"serial_number\": \"\",\n \"account_number\": \"\",\n \"provider\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/utilities?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "utilities" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-1741a24a-1313-4251-91ea-94b0a51499d3" }, { "id": "3403f74d-1039-40d5-b9a8-0133371e7e95", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"notes\": \"\",\n \"serial_number\": \"\",\n \"account_number\": \"\",\n \"provider\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/utilities?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "utilities" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-3403f74d-1039-40d5-b9a8-0133371e7e95" }, { "id": "6d15c6aa-886b-4a57-a03c-7df460910a0e", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"notes\": \"\",\n \"serial_number\": \"\",\n \"account_number\": \"\",\n \"provider\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/utilities?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "utilities" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-6d15c6aa-886b-4a57-a03c-7df460910a0e" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-b9ac4580-908c-4ae9-bd88-93cb46de2703" } ], "id": "45229f36-3762-4941-91ff-9fbfff26b75a", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-45229f36-3762-4941-91ff-9fbfff26b75a" }, { "name": "transactions", "item": [ { "name": "List Transactions On Unit", "id": "0c61b527-aa8f-4989-9001-35fefdc7a75f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/transactions?statement=&status=&date_from=&date_to=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "transactions" ], "query": [ { "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices", "key": "statement", "value": "" }, { "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status.", "key": "status", "value": "" }, { "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_from", "value": "" }, { "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_to", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "a4856c06-6c17-464f-a596-2d00ac87d4fb", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This retrieves a list of transactions for a Unit \n\nSee available filters below to customize the list of transactions returned." }, "response": [ { "id": "de8a3e5d-c389-4139-a1ef-92f4be004be7", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/transactions?statement=&status=&date_from=&date_to=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "transactions" ], "query": [ { "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices", "key": "statement", "value": "" }, { "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status.", "key": "status", "value": "" }, { "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_from", "value": "" }, { "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_to", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-de8a3e5d-c389-4139-a1ef-92f4be004be7" }, { "id": "0cf0eef0-0d2d-4925-a0d1-0e8ca443106c", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/transactions?statement=&status=&date_from=&date_to=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "transactions" ], "query": [ { "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices", "key": "statement", "value": "" }, { "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status.", "key": "status", "value": "" }, { "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_from", "value": "" }, { "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_to", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-0cf0eef0-0d2d-4925-a0d1-0e8ca443106c" }, { "id": "965a9c32-2e1e-449b-95a2-33d66a6c1753", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/transactions?statement=&status=&date_from=&date_to=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "transactions" ], "query": [ { "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices", "key": "statement", "value": "" }, { "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status.", "key": "status", "value": "" }, { "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_from", "value": "" }, { "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_to", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-965a9c32-2e1e-449b-95a2-33d66a6c1753" }, { "id": "99903910-d010-46ea-b3a9-f41db0e91ef5", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/transactions?statement=&status=&date_from=&date_to=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "transactions" ], "query": [ { "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices", "key": "statement", "value": "" }, { "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status.", "key": "status", "value": "" }, { "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_from", "value": "" }, { "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_to", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-99903910-d010-46ea-b3a9-f41db0e91ef5" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-0c61b527-aa8f-4989-9001-35fefdc7a75f" } ], "id": "351c4a9e-56bf-4197-ba37-e9e37c3c7aa0", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-351c4a9e-56bf-4197-ba37-e9e37c3c7aa0" }, { "name": "tags", "item": [ { "name": "Tag Unit", "id": "1fecb034-824e-4288-9d48-fb889513e431", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tags" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "37fec9e7-a48b-45f5-a937-ac8ab19c429a", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to create a new tag record for the unit . The API will return the saved data and a unique tag ID.\n\nSupported Fields \n The following fields are supported for the request body\nTag field should be a valid tag ID or name.\n\nField \n Example \n Type \n Default \n Required? \n\ntag \n [\"123\"] \n Array(String) \n\nYes" }, "response": [ { "id": "2612d94b-64d4-44c6-a5e2-e617ce197817", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tags" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-2612d94b-64d4-44c6-a5e2-e617ce197817" }, { "id": "e2ffaa7c-cc6c-400d-965f-c0efc4b39dd5", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tags" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e2ffaa7c-cc6c-400d-965f-c0efc4b39dd5" }, { "id": "7ab75fd9-2c06-4de6-a818-44d909c169b8", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tags" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-7ab75fd9-2c06-4de6-a818-44d909c169b8" }, { "id": "6e60c3c8-494d-46d1-895a-34e8cb2e25b4", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "tags" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-6e60c3c8-494d-46d1-895a-34e8cb2e25b4" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-1fecb034-824e-4288-9d48-fb889513e431" } ], "id": "a8727941-3601-4332-a6bc-16a25f064b9f", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-a8727941-3601-4332-a6bc-16a25f064b9f" }, { "name": "untag", "item": [ { "name": "Untag Unit", "id": "7dd6341b-17df-4a0b-be13-2cec8b9dfa24", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "untag" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "d8a1e29d-c3f4-4027-ad06-86088d107159", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to unassign tag record from the\u00a0 unit . The API will return the saved data and a unique workorder ID. Tag field should be a valid tag ID or name.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntag \n 123 \n String \n Yes" }, "response": [ { "id": "deffe606-481d-48b0-bdfa-f4add8f638e1", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "untag" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-deffe606-481d-48b0-bdfa-f4add8f638e1" }, { "id": "9a462fe2-1d2f-4af3-ad85-f6c89e625a68", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "untag" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-9a462fe2-1d2f-4af3-ad85-f6c89e625a68" }, { "id": "e843595f-d2b1-4f76-8bbf-30ea79a145fd", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "untag" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-e843595f-d2b1-4f76-8bbf-30ea79a145fd" }, { "id": "284f520d-63d6-459e-9ce0-18ccf777ca1b", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "untag" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-284f520d-63d6-459e-9ce0-18ccf777ca1b" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-7dd6341b-17df-4a0b-be13-2cec8b9dfa24" } ], "id": "24062cc3-129c-4757-9717-da158c8b3a19", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-24062cc3-129c-4757-9717-da158c8b3a19" }, { "name": "untag_all", "item": [ { "name": "Untag All Unit Tags", "id": "74860c56-b76f-478d-8dc7-d40cbfa4957e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "untag_all" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "95289b67-0d5b-4082-954f-d4cf6e213cb1", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "Use this endpoint to unassign all tags from the\u00a0 unit ." }, "response": [ { "id": "3d57520e-d735-4a2a-bdc9-b5d1a515dbd6", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "untag_all" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-3d57520e-d735-4a2a-bdc9-b5d1a515dbd6" }, { "id": "3fe408f8-c452-4557-9f1d-428629c90e56", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "untag_all" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-3fe408f8-c452-4557-9f1d-428629c90e56" }, { "id": "4b7bbe5a-9e60-4a87-b94f-e6c35d2749f1", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "untag_all" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-4b7bbe5a-9e60-4a87-b94f-e6c35d2749f1" }, { "id": "3a38a7d4-81c2-46c6-bac6-9cc0d5a59849", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id", "untag_all" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-3a38a7d4-81c2-46c6-bac6-9cc0d5a59849" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-74860c56-b76f-478d-8dc7-d40cbfa4957e" } ], "id": "368169ec-c579-4d29-9d84-877f4e5e7021", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-368169ec-c579-4d29-9d84-877f4e5e7021" }, { "name": "View Unit", "id": "a68642a9-84aa-4caa-9694-9c2f2f4d9e4b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id" ], "variable": [ { "id": "8130c1a0-0242-4248-ac31-d3d332d16f7f", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This API endpoint retrieves the details of a single unit, identified by its unique\u00a0 unit_id .\n\nUse this endpoint to view the specific details of a unit." }, "response": [ { "id": "7cd345fe-4335-4eb3-b196-d7885774fb96", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id" ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-7cd345fe-4335-4eb3-b196-d7885774fb96" }, { "id": "5ea5c035-6c85-4442-bc10-cc0ee8f3d3b1", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id" ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-5ea5c035-6c85-4442-bc10-cc0ee8f3d3b1" }, { "id": "de322c85-fe38-4f90-8298-c10436f5e577", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id" ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-de322c85-fe38-4f90-8298-c10436f5e577" }, { "id": "edd3134b-6bbb-4fce-95bd-2ff5f1a85907", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:unit_id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id" ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-edd3134b-6bbb-4fce-95bd-2ff5f1a85907" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-a68642a9-84aa-4caa-9694-9c2f2f4d9e4b" }, { "name": "Update Unit", "id": "eb27b15c-3638-4712-8769-e79f0e1d5b76", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"unit_type\": \"\",\n \"unit_status\": \"\",\n \"unit_ref\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"area\": \"\",\n \"postcode\": \"\",\n \"market_rent\": \"\",\n \"market_rent_frequency\": \"\",\n \"available_from\": \"\",\n \"available_since\": \"\",\n \"unit_owner_id\": \"\",\n \"letting_agent_id\": \"\",\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"\",\n \"bathrooms\": \"\",\n \"floors\": \"\",\n \"bedrooms\": \"\",\n \"receptions\": \"\",\n \"smart_meters\": \"\",\n \"date_available\": \"\",\n \"rental_term\": \"\",\n \"deposit_amount\": \"\",\n \"service_charge\": \"\",\n \"service_charge_amount\": \"\",\n \"council_tax_band\": \"\",\n \"council_account_no\": \"\",\n \"council_id\": \"\",\n \"portal_market_rent\": \"\",\n \"portal_market_rent_frequency\": \"\",\n \"sharing_tenancies\": \"\",\n \"i_manage_this\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "40bb578b-6375-4b4c-af47-a26da52e68c4", "key": "unit_id", "value": "", "description": "(Required) Arthur unit id." } ] }, "description": "This endpoint updates an existing unit using the same fields as the 'Add Unit' endpoint excluding the property_id . Any fields that are not provided will not be changed. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nunit_type \n Residential \n String \n No \n\nunit_status \n Available to Let \n String \n No \n\nunit_ref \n Unit 1 \n String \n No \n\naddress_line_1 \n Arthur House \n String \n No \n\naddress_line_2 \n 123 Property Street \n String \n No \n\ncity \n Stevenage \n String \n No \n\ncounty \n Hertfordshire \n String \n No \n\ncountry \n United Kingdom \n String \n No \n\narea \n South East \n String \n No \n\npostcode \n AB1 2CD \n String \n No \n\nmarket_rent \n 800.00 \n Float \n No \n\nmarket_rent_frequency \n Monthly \n String \n No \n\navailable_from \n 2019-01-01 \n Date \n No \n\navailable_since \n 2019-01-01 \n Date \n No \n\nunit_owner_id \n 3456 \n Integer \n No \n\nletting_agent_id \n 4567 \n Integer \n No \n\nportal_address \n Property Street, Stevenage, AB1 \n String \n No \n\nshort_description \n Brand new furnished unit in the heart of the city center! \n String \n No \n\ndescription \n This fabulous new property has been recently refurbished with close links to city center and nearby public transport. Please call now to book a viewing. \n String \n No \n\nportal_unit_type \n Apartment \n String \n No \n\nsize \n 500 \n String \n No \n\nsize_unit \n Sq Meter \n String \n No \n\nfurnished \n Part-Furnished \n String \n No \n\nmax_occupancy \n 1 \n String \n No \n\nbathrooms \n 1 \n String \n No \n\nfloors \n 1 \n String \n No \n\nbedrooms \n 1 \n String \n No \n\nreceptions \n 1 \n String \n No \n\nsmart_meters \n No \n String \n No \n\ndate_available \n 2019-01-01 \n Date \n No \n\nrental_term \n Long \n String \n No \n\ndeposit_amount \n 1600.00 \n Float \n No \n\nservice_charge \n true \n Boolean \n No \n\nservice_charge_amount \n 75.00 \n Float \n No \n\ncouncil_tax_band \n C \n String \n No \n\ncouncil_account_no \n ABC123 \n String \n No \n\ncouncil_id \n 9874 \n Integer \n No \n\nportal_market_rent \n 800.00 \n Float \n No \n\nportal_market_rent_frequency \n Monthly \n String \n No \n\nsharing_tenancies \n N/A \n String \n No \n\ni_manage_this \n true \n Boolean \n No \n\nfeatures \n [ \"Internet\", \"Fireplace\", \"Smart home integration\" ] \n Array (String) \n No \n\ntags \n [ \"Cheap Rent\" ] \n Array (String) \n No" }, "response": [ { "id": "15c306d1-9109-4eb2-8dd1-64b7efb90866", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"unit_type\": \"\",\n \"unit_status\": \"\",\n \"unit_ref\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"area\": \"\",\n \"postcode\": \"\",\n \"market_rent\": \"\",\n \"market_rent_frequency\": \"\",\n \"available_from\": \"\",\n \"available_since\": \"\",\n \"unit_owner_id\": \"\",\n \"letting_agent_id\": \"\",\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"\",\n \"bathrooms\": \"\",\n \"floors\": \"\",\n \"bedrooms\": \"\",\n \"receptions\": \"\",\n \"smart_meters\": \"\",\n \"date_available\": \"\",\n \"rental_term\": \"\",\n \"deposit_amount\": \"\",\n \"service_charge\": \"\",\n \"service_charge_amount\": \"\",\n \"council_tax_band\": \"\",\n \"council_account_no\": \"\",\n \"council_id\": \"\",\n \"portal_market_rent\": \"\",\n \"portal_market_rent_frequency\": \"\",\n \"sharing_tenancies\": \"\",\n \"i_manage_this\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"data\": {}\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-15c306d1-9109-4eb2-8dd1-64b7efb90866" }, { "id": "06f6a1d2-e8a8-45b7-b300-d5a6b371a784", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"unit_type\": \"\",\n \"unit_status\": \"\",\n \"unit_ref\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"area\": \"\",\n \"postcode\": \"\",\n \"market_rent\": \"\",\n \"market_rent_frequency\": \"\",\n \"available_from\": \"\",\n \"available_since\": \"\",\n \"unit_owner_id\": \"\",\n \"letting_agent_id\": \"\",\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"\",\n \"bathrooms\": \"\",\n \"floors\": \"\",\n \"bedrooms\": \"\",\n \"receptions\": \"\",\n \"smart_meters\": \"\",\n \"date_available\": \"\",\n \"rental_term\": \"\",\n \"deposit_amount\": \"\",\n \"service_charge\": \"\",\n \"service_charge_amount\": \"\",\n \"council_tax_band\": \"\",\n \"council_account_no\": \"\",\n \"council_id\": \"\",\n \"portal_market_rent\": \"\",\n \"portal_market_rent_frequency\": \"\",\n \"sharing_tenancies\": \"\",\n \"i_manage_this\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-06f6a1d2-e8a8-45b7-b300-d5a6b371a784" }, { "id": "7e2caa93-74ef-461a-8f93-993e3d85c812", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"unit_type\": \"\",\n \"unit_status\": \"\",\n \"unit_ref\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"area\": \"\",\n \"postcode\": \"\",\n \"market_rent\": \"\",\n \"market_rent_frequency\": \"\",\n \"available_from\": \"\",\n \"available_since\": \"\",\n \"unit_owner_id\": \"\",\n \"letting_agent_id\": \"\",\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"\",\n \"bathrooms\": \"\",\n \"floors\": \"\",\n \"bedrooms\": \"\",\n \"receptions\": \"\",\n \"smart_meters\": \"\",\n \"date_available\": \"\",\n \"rental_term\": \"\",\n \"deposit_amount\": \"\",\n \"service_charge\": \"\",\n \"service_charge_amount\": \"\",\n \"council_tax_band\": \"\",\n \"council_account_no\": \"\",\n \"council_id\": \"\",\n \"portal_market_rent\": \"\",\n \"portal_market_rent_frequency\": \"\",\n \"sharing_tenancies\": \"\",\n \"i_manage_this\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-7e2caa93-74ef-461a-8f93-993e3d85c812" }, { "id": "ad09cd36-8352-4a64-a7b6-4e9cce6465da", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"unit_type\": \"\",\n \"unit_status\": \"\",\n \"unit_ref\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"area\": \"\",\n \"postcode\": \"\",\n \"market_rent\": \"\",\n \"market_rent_frequency\": \"\",\n \"available_from\": \"\",\n \"available_since\": \"\",\n \"unit_owner_id\": \"\",\n \"letting_agent_id\": \"\",\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"\",\n \"bathrooms\": \"\",\n \"floors\": \"\",\n \"bedrooms\": \"\",\n \"receptions\": \"\",\n \"smart_meters\": \"\",\n \"date_available\": \"\",\n \"rental_term\": \"\",\n \"deposit_amount\": \"\",\n \"service_charge\": \"\",\n \"service_charge_amount\": \"\",\n \"council_tax_band\": \"\",\n \"council_account_no\": \"\",\n \"council_id\": \"\",\n \"portal_market_rent\": \"\",\n \"portal_market_rent_frequency\": \"\",\n \"sharing_tenancies\": \"\",\n \"i_manage_this\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units/:unit_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units", ":unit_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "unit_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-ad09cd36-8352-4a64-a7b6-4e9cce6465da" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-eb27b15c-3638-4712-8769-e79f0e1d5b76" } ], "id": "c47f4799-0f1d-426d-af96-a3c1ad6d54fa", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-c47f4799-0f1d-426d-af96-a3c1ad6d54fa" }, { "name": "{id}", "item": [ { "name": "tags", "item": [ { "name": "Get Tags on Unit", "id": "f5d004d4-46a5-44b4-87bd-f25ff894ae3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:id/tags", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id", "tags" ], "variable": [ { "id": "6222dfd2-fb86-4082-81f0-48bff48ce978", "key": "id" } ] }, "description": "This endpoint retrieves a list of tags associated with the given unit ID." }, "response": [ { "id": "3c8079a7-792b-495a-bb33-1ee68d55247d", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:id/tags", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id", "tags" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"data\": {}\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-3c8079a7-792b-495a-bb33-1ee68d55247d" }, { "id": "5c5eb87e-355d-481d-a655-61d2ba4a9f52", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:id/tags", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id", "tags" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-5c5eb87e-355d-481d-a655-61d2ba4a9f52" }, { "id": "9179423c-c908-4f7a-ba95-952a4106fe16", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:id/tags", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id", "tags" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-9179423c-c908-4f7a-ba95-952a4106fe16" }, { "id": "1d3cd68c-15bd-44cf-8fc8-e6829ac4f23f", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:id/tags", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id", "tags" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-1d3cd68c-15bd-44cf-8fc8-e6829ac4f23f" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-f5d004d4-46a5-44b4-87bd-f25ff894ae3e" } ], "id": "1f889a49-fda4-4f6b-89ce-ed0a15658634", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-1f889a49-fda4-4f6b-89ce-ed0a15658634" } ], "id": "803c1596-fbb3-4f4d-b1c9-2117688e45b9", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-803c1596-fbb3-4f4d-b1c9-2117688e45b9" }, { "name": "List Units", "id": "842a14ee-051c-4301-9406-6377299030e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units?unit_ref=&address_line_1=&address_line_2=&city=&county=&area_id=&area=&postcode=&portal=&unit_vacant=&available_move_in_date=&available_move_out_date=&unit_type=&unit_status=&market_rent=&bedrooms=&floors=&tags=&i_manage_this=&unit_owner_id=&max_occupancy=&_q=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "description": "Filter by the address name of the unit", "key": "unit_ref", "value": "" }, { "description": "Filter by the address 1 field of the unit", "key": "address_line_1", "value": "" }, { "description": "Filter by the address 2 field of the unit", "key": "address_line_2", "value": "" }, { "description": "Filter by the city of the unit", "key": "city", "value": "" }, { "description": "Filter by the county of the unit", "key": "county", "value": "" }, { "description": "Filter by the area ID of the unit", "key": "area_id", "value": "" }, { "description": "Filter by the area name of the unit", "key": "area", "value": "" }, { "description": "Filter by the postcode of the unit", "key": "postcode", "value": "" }, { "description": "Filter units by portal", "key": "portal", "value": "" }, { "description": "Filter units by unit vacancy (boolean)", "key": "unit_vacant", "value": "" }, { "description": "Filter by unit availability date range. Use the format yyyy-mm-dd to input the date", "key": "available_move_in_date", "value": "" }, { "description": "Filter by unit avaiability date range. Use the format yyyy-mm-dd to input the date", "key": "available_move_out_date", "value": "" }, { "description": "Filter units by unit type", "key": "unit_type", "value": "" }, { "description": "Filter based on the current status of units, including Available To Let, Under Offer, Let, and Unavailable to Let", "key": "unit_status", "value": "" }, { "description": "Filter units by market rent amount", "key": "market_rent", "value": "" }, { "description": "Filter units by bedroom count", "key": "bedrooms", "value": "" }, { "description": "Filter units by floor count", "key": "floors", "value": "" }, { "description": "Filter by tags associated with the units, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filter based on the management status of the property (boolean)", "key": "i_manage_this", "value": "" }, { "description": "Filter by the ID of the owner of the unit", "key": "unit_owner_id", "value": "" }, { "description": "Filter by the max occupancy on a unit", "key": "max_occupancy", "value": "" }, { "description": "Filter by keyword", "key": "_q", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ] }, "description": "This retrieves a list of units.\n\nSee available filters below to customize the list of units returned." }, "response": [ { "id": "44d43488-6983-4322-bc0e-1898260a11d5", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units?unit_ref=&address_line_1=&address_line_2=&city=&county=&area_id=&area=&postcode=&portal=&unit_vacant=&available_move_in_date=&available_move_out_date=&unit_type=&unit_status=&market_rent=&bedrooms=&floors=&tags=&i_manage_this=&unit_owner_id=&max_occupancy=&_q=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "description": "Filter by the address name of the unit", "key": "unit_ref", "value": "" }, { "description": "Filter by the address 1 field of the unit", "key": "address_line_1", "value": "" }, { "description": "Filter by the address 2 field of the unit", "key": "address_line_2", "value": "" }, { "description": "Filter by the city of the unit", "key": "city", "value": "" }, { "description": "Filter by the county of the unit", "key": "county", "value": "" }, { "description": "Filter by the area ID of the unit", "key": "area_id", "value": "" }, { "description": "Filter by the area name of the unit", "key": "area", "value": "" }, { "description": "Filter by the postcode of the unit", "key": "postcode", "value": "" }, { "description": "Filter units by portal", "key": "portal", "value": "" }, { "description": "Filter units by unit vacancy (boolean)", "key": "unit_vacant", "value": "" }, { "description": "Filter by unit availability date range. Use the format yyyy-mm-dd to input the date", "key": "available_move_in_date", "value": "" }, { "description": "Filter by unit avaiability date range. Use the format yyyy-mm-dd to input the date", "key": "available_move_out_date", "value": "" }, { "description": "Filter units by unit type", "key": "unit_type", "value": "" }, { "description": "Filter based on the current status of units, including Available To Let, Under Offer, Let, and Unavailable to Let", "key": "unit_status", "value": "" }, { "description": "Filter units by market rent amount", "key": "market_rent", "value": "" }, { "description": "Filter units by bedroom count", "key": "bedrooms", "value": "" }, { "description": "Filter units by floor count", "key": "floors", "value": "" }, { "description": "Filter by tags associated with the units, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filter based on the management status of the property (boolean)", "key": "i_manage_this", "value": "" }, { "description": "Filter by the ID of the owner of the unit", "key": "unit_owner_id", "value": "" }, { "description": "Filter by the max occupancy on a unit", "key": "max_occupancy", "value": "" }, { "description": "Filter by keyword", "key": "_q", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-44d43488-6983-4322-bc0e-1898260a11d5" }, { "id": "a9973af9-5888-4b76-82d8-3835b4046b2b", "name": "The request was invalid or malformed.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units?unit_ref=&address_line_1=&address_line_2=&city=&county=&area_id=&area=&postcode=&portal=&unit_vacant=&available_move_in_date=&available_move_out_date=&unit_type=&unit_status=&market_rent=&bedrooms=&floors=&tags=&i_manage_this=&unit_owner_id=&max_occupancy=&_q=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "description": "Filter by the address name of the unit", "key": "unit_ref", "value": "" }, { "description": "Filter by the address 1 field of the unit", "key": "address_line_1", "value": "" }, { "description": "Filter by the address 2 field of the unit", "key": "address_line_2", "value": "" }, { "description": "Filter by the city of the unit", "key": "city", "value": "" }, { "description": "Filter by the county of the unit", "key": "county", "value": "" }, { "description": "Filter by the area ID of the unit", "key": "area_id", "value": "" }, { "description": "Filter by the area name of the unit", "key": "area", "value": "" }, { "description": "Filter by the postcode of the unit", "key": "postcode", "value": "" }, { "description": "Filter units by portal", "key": "portal", "value": "" }, { "description": "Filter units by unit vacancy (boolean)", "key": "unit_vacant", "value": "" }, { "description": "Filter by unit availability date range. Use the format yyyy-mm-dd to input the date", "key": "available_move_in_date", "value": "" }, { "description": "Filter by unit avaiability date range. Use the format yyyy-mm-dd to input the date", "key": "available_move_out_date", "value": "" }, { "description": "Filter units by unit type", "key": "unit_type", "value": "" }, { "description": "Filter based on the current status of units, including Available To Let, Under Offer, Let, and Unavailable to Let", "key": "unit_status", "value": "" }, { "description": "Filter units by market rent amount", "key": "market_rent", "value": "" }, { "description": "Filter units by bedroom count", "key": "bedrooms", "value": "" }, { "description": "Filter units by floor count", "key": "floors", "value": "" }, { "description": "Filter by tags associated with the units, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filter based on the management status of the property (boolean)", "key": "i_manage_this", "value": "" }, { "description": "Filter by the ID of the owner of the unit", "key": "unit_owner_id", "value": "" }, { "description": "Filter by the max occupancy on a unit", "key": "max_occupancy", "value": "" }, { "description": "Filter by keyword", "key": "_q", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-a9973af9-5888-4b76-82d8-3835b4046b2b" }, { "id": "719c287a-bba5-45f1-a1c0-e1d0b0c3e4e3", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units?unit_ref=&address_line_1=&address_line_2=&city=&county=&area_id=&area=&postcode=&portal=&unit_vacant=&available_move_in_date=&available_move_out_date=&unit_type=&unit_status=&market_rent=&bedrooms=&floors=&tags=&i_manage_this=&unit_owner_id=&max_occupancy=&_q=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "description": "Filter by the address name of the unit", "key": "unit_ref", "value": "" }, { "description": "Filter by the address 1 field of the unit", "key": "address_line_1", "value": "" }, { "description": "Filter by the address 2 field of the unit", "key": "address_line_2", "value": "" }, { "description": "Filter by the city of the unit", "key": "city", "value": "" }, { "description": "Filter by the county of the unit", "key": "county", "value": "" }, { "description": "Filter by the area ID of the unit", "key": "area_id", "value": "" }, { "description": "Filter by the area name of the unit", "key": "area", "value": "" }, { "description": "Filter by the postcode of the unit", "key": "postcode", "value": "" }, { "description": "Filter units by portal", "key": "portal", "value": "" }, { "description": "Filter units by unit vacancy (boolean)", "key": "unit_vacant", "value": "" }, { "description": "Filter by unit availability date range. Use the format yyyy-mm-dd to input the date", "key": "available_move_in_date", "value": "" }, { "description": "Filter by unit avaiability date range. Use the format yyyy-mm-dd to input the date", "key": "available_move_out_date", "value": "" }, { "description": "Filter units by unit type", "key": "unit_type", "value": "" }, { "description": "Filter based on the current status of units, including Available To Let, Under Offer, Let, and Unavailable to Let", "key": "unit_status", "value": "" }, { "description": "Filter units by market rent amount", "key": "market_rent", "value": "" }, { "description": "Filter units by bedroom count", "key": "bedrooms", "value": "" }, { "description": "Filter units by floor count", "key": "floors", "value": "" }, { "description": "Filter by tags associated with the units, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filter based on the management status of the property (boolean)", "key": "i_manage_this", "value": "" }, { "description": "Filter by the ID of the owner of the unit", "key": "unit_owner_id", "value": "" }, { "description": "Filter by the max occupancy on a unit", "key": "max_occupancy", "value": "" }, { "description": "Filter by keyword", "key": "_q", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-719c287a-bba5-45f1-a1c0-e1d0b0c3e4e3" }, { "id": "758c2f98-47cd-4e7c-a8bf-a6256ff8c08d", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/units?unit_ref=&address_line_1=&address_line_2=&city=&county=&area_id=&area=&postcode=&portal=&unit_vacant=&available_move_in_date=&available_move_out_date=&unit_type=&unit_status=&market_rent=&bedrooms=&floors=&tags=&i_manage_this=&unit_owner_id=&max_occupancy=&_q=&page=&limit=&sort=&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "description": "Filter by the address name of the unit", "key": "unit_ref", "value": "" }, { "description": "Filter by the address 1 field of the unit", "key": "address_line_1", "value": "" }, { "description": "Filter by the address 2 field of the unit", "key": "address_line_2", "value": "" }, { "description": "Filter by the city of the unit", "key": "city", "value": "" }, { "description": "Filter by the county of the unit", "key": "county", "value": "" }, { "description": "Filter by the area ID of the unit", "key": "area_id", "value": "" }, { "description": "Filter by the area name of the unit", "key": "area", "value": "" }, { "description": "Filter by the postcode of the unit", "key": "postcode", "value": "" }, { "description": "Filter units by portal", "key": "portal", "value": "" }, { "description": "Filter units by unit vacancy (boolean)", "key": "unit_vacant", "value": "" }, { "description": "Filter by unit availability date range. Use the format yyyy-mm-dd to input the date", "key": "available_move_in_date", "value": "" }, { "description": "Filter by unit avaiability date range. Use the format yyyy-mm-dd to input the date", "key": "available_move_out_date", "value": "" }, { "description": "Filter units by unit type", "key": "unit_type", "value": "" }, { "description": "Filter based on the current status of units, including Available To Let, Under Offer, Let, and Unavailable to Let", "key": "unit_status", "value": "" }, { "description": "Filter units by market rent amount", "key": "market_rent", "value": "" }, { "description": "Filter units by bedroom count", "key": "bedrooms", "value": "" }, { "description": "Filter units by floor count", "key": "floors", "value": "" }, { "description": "Filter by tags associated with the units, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filter based on the management status of the property (boolean)", "key": "i_manage_this", "value": "" }, { "description": "Filter by the ID of the owner of the unit", "key": "unit_owner_id", "value": "" }, { "description": "Filter by the max occupancy on a unit", "key": "max_occupancy", "value": "" }, { "description": "Filter by keyword", "key": "_q", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "ASC" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-758c2f98-47cd-4e7c-a8bf-a6256ff8c08d" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-842a14ee-051c-4301-9406-6377299030e3" }, { "name": "Add Unit", "id": "806719ec-909d-41e2-a96f-1caf3f855543", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"unit_ref\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"postcode\": \"\",\n \"unit_type\": \"\",\n \"unit_status\": \"Available to Let\",\n \"address_line_2\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"area\": \"\",\n \"market_rent\": \"\",\n \"market_rent_frequency\": \"\",\n \"available_from\": \"\",\n \"available_since\": \"\",\n \"unit_owner_id\": \"\",\n \"letting_agent_id\": \"\",\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"\",\n \"bathrooms\": \"\",\n \"floors\": \"\",\n \"bedrooms\": \"\",\n \"receptions\": \"\",\n \"smart_meters\": \"\",\n \"date_available\": \"\",\n \"rental_term\": \"\",\n \"deposit_amount\": \"\",\n \"service_charge\": \"\",\n \"service_charge_amount\": \"\",\n \"council_tax_band\": \"\",\n \"council_account_no\": \"\",\n \"council_id\": \"\",\n \"portal_market_rent\": \"\",\n \"portal_market_rent_frequency\": \"\",\n \"sharing_tenancies\": \"\",\n \"i_manage_this\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ] }, "description": "Use this endpoint to create a new unit. The API will return the saved data and a unique Unit ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Default \n Required? \n\nproperty_id \n 12345 \n Integer \n\nYes \n\nunit_type \n Residential \n String \n\nNo \n\nunit_status \n Available to Let \n String \n Available to Let \n No \n\nunit_ref \n Unit 1 \n String \n\nYes \n\naddress_line_1 \n Arthur House \n String \n\nYes \n\naddress_line_2 \n 123 Property Street \n String \n\nNo \n\ncity \n Stevenage \n String \n\nYes \n\ncounty \n Hertfordshire \n String \n\nNo \n\ncountry \n United Kingdom \n String \n\nNo \n\narea \n South East \n String \n\nNo \n\npostcode \n AB1 2CD \n String \n\nYes \n\nmarket_rent \n 800.00 \n Float \n\nNo \n\nmarket_rent_frequency \n Monthly \n String \n\nNo \n\navailable_from \n 2019-01-01 \n Date \n\nNo \n\navailable_since \n 2019-01-01 \n Date \n\nNo \n\nunit_owner_id \n 3456 \n Integer \n\nNo \n\nletting_agent_id \n 4567 \n Integer \n\nNo \n\nportal_address \n Property Street, Stevenage, AB1 \n String \n\nNo \n\nshort_description \n Brand new furnished unit in the heart of the city center! \n String \n\nNo \n\ndescription \n This fabulous new property has been recently refurbished with close links to city center and nearby public transport. Please call now to book a viewing. \n String \n\nNo \n\nportal_unit_type \n Apartment \n String \n\nNo \n\nsize \n 500 \n String \n\nNo \n\nsize_unit \n Sq Meter \n String \n\nNo \n\nfurnished \n Part-Furnished \n String \n\nNo \n\nmax_occupancy \n 1 \n String \n\nNo \n\nbathrooms \n 1 \n String \n\nNo \n\nfloors \n 1 \n String \n\nNo \n\nbedrooms \n 1 \n String \n\nNo \n\nreceptions \n 1 \n String \n\nNo \n\nsmart_meters \n No \n String \n\nNo \n\ndate_available \n 2019-01-01 \n Date \n\nNo \n\nrental_term \n Long \n String \n\nNo \n\ndeposit_amount \n 1600.00 \n Float \n\nNo \n\nservice_charge \n true \n Boolean \n\nNo \n\nservice_charge_amount \n 75.00 \n Float \n\nNo \n\ncouncil_tax_band \n C \n String \n\nNo \n\ncouncil_account_no \n ABC123 \n String \n\nNo \n\ncouncil_id \n 9874 \n Integer \n\nNo \n\nportal_market_rent \n 800.00 \n Float \n\nNo \n\nportal_market_rent_frequency \n Monthly \n String \n\nNo \n\nsharing_tenancies \n N/A \n String \n\nNo \n\ni_manage_this \n true \n Boolean \n\nNo \n\nfeatures \n [ \"Internet\", \"Fireplace\", \"Smart home integration\" ] \n Array (String) \n\nNo \n\ntags \n [ \"Cheap Rent\" ] \n Array (String) \n\nNo" }, "response": [ { "id": "b71bf15e-762b-4106-ac93-26f8925f0d31", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"unit_ref\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"postcode\": \"\",\n \"unit_type\": \"\",\n \"unit_status\": \"Available to Let\",\n \"address_line_2\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"area\": \"\",\n \"market_rent\": \"\",\n \"market_rent_frequency\": \"\",\n \"available_from\": \"\",\n \"available_since\": \"\",\n \"unit_owner_id\": \"\",\n \"letting_agent_id\": \"\",\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"\",\n \"bathrooms\": \"\",\n \"floors\": \"\",\n \"bedrooms\": \"\",\n \"receptions\": \"\",\n \"smart_meters\": \"\",\n \"date_available\": \"\",\n \"rental_term\": \"\",\n \"deposit_amount\": \"\",\n \"service_charge\": \"\",\n \"service_charge_amount\": \"\",\n \"council_tax_band\": \"\",\n \"council_account_no\": \"\",\n \"council_id\": \"\",\n \"portal_market_rent\": \"\",\n \"portal_market_rent_frequency\": \"\",\n \"sharing_tenancies\": \"\",\n \"i_manage_this\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"data\": {}\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-b71bf15e-762b-4106-ac93-26f8925f0d31" }, { "id": "f4e1068c-fd38-4de8-911e-491ea4f6d7d1", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"unit_ref\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"postcode\": \"\",\n \"unit_type\": \"\",\n \"unit_status\": \"Available to Let\",\n \"address_line_2\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"area\": \"\",\n \"market_rent\": \"\",\n \"market_rent_frequency\": \"\",\n \"available_from\": \"\",\n \"available_since\": \"\",\n \"unit_owner_id\": \"\",\n \"letting_agent_id\": \"\",\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"\",\n \"bathrooms\": \"\",\n \"floors\": \"\",\n \"bedrooms\": \"\",\n \"receptions\": \"\",\n \"smart_meters\": \"\",\n \"date_available\": \"\",\n \"rental_term\": \"\",\n \"deposit_amount\": \"\",\n \"service_charge\": \"\",\n \"service_charge_amount\": \"\",\n \"council_tax_band\": \"\",\n \"council_account_no\": \"\",\n \"council_id\": \"\",\n \"portal_market_rent\": \"\",\n \"portal_market_rent_frequency\": \"\",\n \"sharing_tenancies\": \"\",\n \"i_manage_this\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-f4e1068c-fd38-4de8-911e-491ea4f6d7d1" }, { "id": "909961f5-90d2-4081-96ad-47f84c036dde", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"unit_ref\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"postcode\": \"\",\n \"unit_type\": \"\",\n \"unit_status\": \"Available to Let\",\n \"address_line_2\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"area\": \"\",\n \"market_rent\": \"\",\n \"market_rent_frequency\": \"\",\n \"available_from\": \"\",\n \"available_since\": \"\",\n \"unit_owner_id\": \"\",\n \"letting_agent_id\": \"\",\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"\",\n \"bathrooms\": \"\",\n \"floors\": \"\",\n \"bedrooms\": \"\",\n \"receptions\": \"\",\n \"smart_meters\": \"\",\n \"date_available\": \"\",\n \"rental_term\": \"\",\n \"deposit_amount\": \"\",\n \"service_charge\": \"\",\n \"service_charge_amount\": \"\",\n \"council_tax_band\": \"\",\n \"council_account_no\": \"\",\n \"council_id\": \"\",\n \"portal_market_rent\": \"\",\n \"portal_market_rent_frequency\": \"\",\n \"sharing_tenancies\": \"\",\n \"i_manage_this\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-909961f5-90d2-4081-96ad-47f84c036dde" }, { "id": "7b9c346a-2fa2-4b27-a45c-3639ad7cc008", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"unit_ref\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"postcode\": \"\",\n \"unit_type\": \"\",\n \"unit_status\": \"Available to Let\",\n \"address_line_2\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"area\": \"\",\n \"market_rent\": \"\",\n \"market_rent_frequency\": \"\",\n \"available_from\": \"\",\n \"available_since\": \"\",\n \"unit_owner_id\": \"\",\n \"letting_agent_id\": \"\",\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"\",\n \"bathrooms\": \"\",\n \"floors\": \"\",\n \"bedrooms\": \"\",\n \"receptions\": \"\",\n \"smart_meters\": \"\",\n \"date_available\": \"\",\n \"rental_term\": \"\",\n \"deposit_amount\": \"\",\n \"service_charge\": \"\",\n \"service_charge_amount\": \"\",\n \"council_tax_band\": \"\",\n \"council_account_no\": \"\",\n \"council_id\": \"\",\n \"portal_market_rent\": \"\",\n \"portal_market_rent_frequency\": \"\",\n \"sharing_tenancies\": \"\",\n \"i_manage_this\": \"\",\n \"features\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/units?strict=", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-7b9c346a-2fa2-4b27-a45c-3639ad7cc008" } ], "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-806719ec-909d-41e2-a96f-1caf3f855543" } ], "id": "65145899-030b-4b77-9198-42be6df0a5d5", "createdAt": "2026-07-28T01:04:59.000Z", "updatedAt": "2026-07-28T01:04:59.000Z", "uid": "35240-65145899-030b-4b77-9198-42be6df0a5d5" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "redirect_uri", "value": "https://auth.arthuronline.co.uk/oauth/token", "type": "string" }, { "key": "accessTokenUrl", "value": "https://auth.arthuronline.co.uk/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://auth.arthuronline.co.uk/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.arthuronline.co.uk/v2" } ] }