{ "info": { "_postman_id": "ce556430-704f-4fa1-8bbb-144a874e70d5", "name": "Arthur Viewings API", "description": "Arthur Viewings API - the viewings 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:05:06.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "lastUpdatedBy": "35240", "uid": "35240-ce556430-704f-4fa1-8bbb-144a874e70d5" }, "item": [ { "name": "viewings", "item": [ { "name": "{viewing_id}", "item": [ { "name": "applicants", "item": [ { "name": "List Applicants on Viewing", "id": "b13454b2-94ef-42d0-9ea8-1b959e76b19c", "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}}/viewings/:viewing_id/applicants?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "applicants" ], "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": "DESC" } ], "variable": [ { "id": "c7d92524-fee9-40c2-a4fb-469d8e71dee8", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This retrieves a list of applicants on a viewing, identified by its unique\u00a0 viewing_id ." }, "response": [ { "id": "d280c827-aeff-4c7c-af2c-8fd118e5863e", "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}}/viewings/:viewing_id/applicants?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "applicants" ], "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": "DESC" } ], "variable": [ { "key": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-d280c827-aeff-4c7c-af2c-8fd118e5863e" }, { "id": "f14a9e5a-8d01-495a-ace9-ed469ec329cf", "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}}/viewings/:viewing_id/applicants?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "applicants" ], "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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-f14a9e5a-8d01-495a-ace9-ed469ec329cf" }, { "id": "0f881f59-9cc4-4557-982c-c09f0fd993ec", "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}}/viewings/:viewing_id/applicants?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "applicants" ], "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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-0f881f59-9cc4-4557-982c-c09f0fd993ec" }, { "id": "71bf218e-36cd-4b4a-a858-13d9bfd108fe", "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}}/viewings/:viewing_id/applicants?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "applicants" ], "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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-71bf218e-36cd-4b4a-a858-13d9bfd108fe" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-b13454b2-94ef-42d0-9ea8-1b959e76b19c" } ], "id": "a759df44-969b-496b-a5d0-824037674d6f", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-a759df44-969b-496b-a5d0-824037674d6f" }, { "name": "managers", "item": [ { "name": "{manager_id}", "item": [ { "name": "View Manager on Viewing", "id": "31a7c75f-902a-4c32-835c-3f2c5654a52e", "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}}/viewings/:viewing_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers", ":manager_id" ], "variable": [ { "id": "7554ff57-03d9-4b35-b66a-b43e3071618f", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." }, { "id": "e68f08b5-5c9a-4f34-b37b-48fe4f8c8908", "key": "manager_id", "value": "", "description": "(Required) Arthur manager id." } ] }, "description": "This API endpoint retrieves the details of a single assigned manager, identified by its unique\u00a0 manager_id .\n\nUse this endpoint to view the specific details of an assigned manager, on a viewing record." }, "response": [ { "id": "a330d3c1-96f9-4c03-ac92-08fe485c2858", "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}}/viewings/:viewing_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers", ":manager_id" ], "variable": [ { "key": "viewing_id" }, { "key": "manager_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"pagination\": {\n \"page\": \"\",\n \"current\": \"\",\n \"count\": \"\",\n \"pageCount\": \"\",\n \"limit\": \"\"\n }\n}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-a330d3c1-96f9-4c03-ac92-08fe485c2858" }, { "id": "0773bd31-6874-4fde-b0dd-5c4717f5b496", "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}}/viewings/:viewing_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers", ":manager_id" ], "variable": [ { "key": "viewing_id" }, { "key": "manager_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-0773bd31-6874-4fde-b0dd-5c4717f5b496" }, { "id": "a866bfb5-a63a-4213-a8a1-cb73ae4ee967", "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}}/viewings/:viewing_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers", ":manager_id" ], "variable": [ { "key": "viewing_id" }, { "key": "manager_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-a866bfb5-a63a-4213-a8a1-cb73ae4ee967" }, { "id": "ca086ee0-e1ea-41fc-b00f-e21fd8dff23a", "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}}/viewings/:viewing_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers", ":manager_id" ], "variable": [ { "key": "viewing_id" }, { "key": "manager_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-ca086ee0-e1ea-41fc-b00f-e21fd8dff23a" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-31a7c75f-902a-4c32-835c-3f2c5654a52e" }, { "name": "Delete Manager on Viewing", "id": "903df2c6-9ef8-43c4-9845-35e1c47c08c7", "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}}/viewings/:viewing_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers", ":manager_id" ], "variable": [ { "id": "04d42867-6efe-4074-aa76-a69b8c96e309", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." }, { "id": "f08a8c70-fbea-4a85-8f1d-dab6f1303abb", "key": "manager_id", "value": "", "description": "(Required) Arthur manager id." } ] }, "description": "This endpoint deletes an existing assignee using the assigned manager\u00a0 id , on a viewing record." }, "response": [ { "id": "d7cb4884-9797-4aac-b9b9-89f3b54b4916", "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}}/viewings/:viewing_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers", ":manager_id" ], "variable": [ { "key": "viewing_id" }, { "key": "manager_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-d7cb4884-9797-4aac-b9b9-89f3b54b4916" }, { "id": "52e3047e-4123-4d15-9bb4-1dd44046b8fb", "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}}/viewings/:viewing_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers", ":manager_id" ], "variable": [ { "key": "viewing_id" }, { "key": "manager_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-52e3047e-4123-4d15-9bb4-1dd44046b8fb" }, { "id": "9ab2a2e7-c21b-4f1f-ade0-d5d75ca0c09a", "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}}/viewings/:viewing_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers", ":manager_id" ], "variable": [ { "key": "viewing_id" }, { "key": "manager_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-9ab2a2e7-c21b-4f1f-ade0-d5d75ca0c09a" }, { "id": "4be0fbb1-7fdd-4fa4-abc1-6da37d29d601", "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}}/viewings/:viewing_id/managers/:manager_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers", ":manager_id" ], "variable": [ { "key": "viewing_id" }, { "key": "manager_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-4be0fbb1-7fdd-4fa4-abc1-6da37d29d601" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-903df2c6-9ef8-43c4-9845-35e1c47c08c7" } ], "id": "3580c64b-cd79-4910-bb2f-4ac6f847aec6", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-3580c64b-cd79-4910-bb2f-4ac6f847aec6" }, { "name": "List Managers on Viewing", "id": "585dab84-4a0b-4f71-92e6-481d515a3c39", "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}}/viewings/:viewing_id/managers?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers" ], "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": "DESC" } ], "variable": [ { "id": "7ff283c2-75ac-4c36-b4b9-4d55d81c979a", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This endpoint retrieves a list of assigned managers associated with the given viewing ID." }, "response": [ { "id": "9790d420-6f32-4c55-8699-8a9ac9b0b917", "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}}/viewings/:viewing_id/managers?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers" ], "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": "DESC" } ], "variable": [ { "key": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"pagination\": {\n \"page\": \"\",\n \"current\": \"\",\n \"count\": \"\",\n \"pageCount\": \"\",\n \"limit\": \"\"\n }\n}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-9790d420-6f32-4c55-8699-8a9ac9b0b917" }, { "id": "98a613b0-372b-477d-b50c-e08d4dac914c", "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}}/viewings/:viewing_id/managers?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers" ], "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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-98a613b0-372b-477d-b50c-e08d4dac914c" }, { "id": "70a7a225-158b-40a5-8e5c-0d9e07776629", "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}}/viewings/:viewing_id/managers?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers" ], "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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-70a7a225-158b-40a5-8e5c-0d9e07776629" }, { "id": "60c3a0b7-140f-4594-9176-870c4cb65962", "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}}/viewings/:viewing_id/managers?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers" ], "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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-60c3a0b7-140f-4594-9176-870c4cb65962" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-585dab84-4a0b-4f71-92e6-481d515a3c39" }, { "name": "Add Manager on Viewing", "id": "6bb58083-7fbe-4840-ba24-f70081394fd3", "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 \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/managers?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "7581fcaa-1f83-476b-9a3c-e49997c22b8a", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "Use this endpoint to assign managers to a viewing. The API will return the saved manager data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nperson_id \n 158674 \n Integer \n Yes" }, "response": [ { "id": "e9fee07c-035c-406d-87e7-d66064813219", "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 \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/managers?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-e9fee07c-035c-406d-87e7-d66064813219" }, { "id": "832b0983-0c80-4882-8258-aab6157a6fac", "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 \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/managers?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-832b0983-0c80-4882-8258-aab6157a6fac" }, { "id": "d7c7e897-b343-4af3-b7b1-907621d160dd", "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 \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/managers?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-d7c7e897-b343-4af3-b7b1-907621d160dd" }, { "id": "5b28d092-bd0d-40ed-b1c7-03d09c97651a", "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 \"person_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/managers?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "managers" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-5b28d092-bd0d-40ed-b1c7-03d09c97651a" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-6bb58083-7fbe-4840-ba24-f70081394fd3" } ], "id": "a2f13972-1bb2-47b6-87e7-a2c0492f5ac6", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-a2f13972-1bb2-47b6-87e7-a2c0492f5ac6" }, { "name": "conversation_recipients", "item": [ { "name": "Get Recipients for Viewing", "id": "7f24b6d4-3331-4e42-bc09-ef8101de1259", "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}}/viewings/:viewing_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "conversation_recipients" ], "variable": [ { "id": "25467936-8475-4cb6-be9d-175cf3a5a07e", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This endpoint retrieves a list of conversation recipients on a viewing record, identified by its unique viewing_id ." }, "response": [ { "id": "0d81b8f5-c6ba-46d6-9223-af6001ee2239", "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}}/viewings/:viewing_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "conversation_recipients" ], "variable": [ { "key": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-0d81b8f5-c6ba-46d6-9223-af6001ee2239" }, { "id": "ce9c67bf-edaa-49d8-a490-54afe31d0df0", "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}}/viewings/:viewing_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "conversation_recipients" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-ce9c67bf-edaa-49d8-a490-54afe31d0df0" }, { "id": "52bf5ff4-55c3-4815-99e4-8a3f2786c9df", "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}}/viewings/:viewing_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "conversation_recipients" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-52bf5ff4-55c3-4815-99e4-8a3f2786c9df" }, { "id": "5bf2b4f6-5b45-46bc-935f-cdec962f6e04", "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}}/viewings/:viewing_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "conversation_recipients" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-5bf2b4f6-5b45-46bc-935f-cdec962f6e04" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-7f24b6d4-3331-4e42-bc09-ef8101de1259" } ], "id": "00d9fd23-95a9-4711-b370-4e033673cfa0", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-00d9fd23-95a9-4711-b370-4e033673cfa0" }, { "name": "conversations", "item": [ { "name": "List Conversations On Viewing", "id": "3070f9cf-0e2d-44cd-9275-9a3a94405f69", "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}}/viewings/:viewing_id/conversations?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "id": "40c58914-7c47-4aea-92bb-4e30f614dfa5", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This endpoint retrieves a list of conversations on a viewing, identified by its unique\u00a0 viewing_id ." }, "response": [ { "id": "396cb992-fee1-41cd-b1db-f261d74533c1", "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}}/viewings/:viewing_id/conversations?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-396cb992-fee1-41cd-b1db-f261d74533c1" }, { "id": "23cade14-6cfe-4cc6-8526-3e55fb7fe3e7", "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}}/viewings/:viewing_id/conversations?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-23cade14-6cfe-4cc6-8526-3e55fb7fe3e7" }, { "id": "f4126675-c1fb-4d5b-b044-e92bc9dc3630", "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}}/viewings/:viewing_id/conversations?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-f4126675-c1fb-4d5b-b044-e92bc9dc3630" }, { "id": "5a3e7282-9937-40c2-9028-921d5f1ca760", "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}}/viewings/:viewing_id/conversations?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-5a3e7282-9937-40c2-9028-921d5f1ca760" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-3070f9cf-0e2d-44cd-9275-9a3a94405f69" }, { "name": "Create Conversation On Viewing", "id": "dccbd497-d599-47b1-a05e-2e31a56ae24d", "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}}/viewings/:viewing_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "8ee08f3e-8bf6-481f-8bce-d7939d25a4a7", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "Use this endpoint to create a new conversation on a viewing record. The API will return the saved data and a unique Conversation ID.\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": "b7a0b1c9-c4e7-4f9a-9644-7560c0c6efb8", "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}}/viewings/:viewing_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-b7a0b1c9-c4e7-4f9a-9644-7560c0c6efb8" }, { "id": "37796787-4c64-444f-a195-623f82d54e58", "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}}/viewings/:viewing_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-37796787-4c64-444f-a195-623f82d54e58" }, { "id": "e6dac74e-6bf0-47e2-905b-4cb4a3e04a80", "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}}/viewings/:viewing_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-e6dac74e-6bf0-47e2-905b-4cb4a3e04a80" }, { "id": "01199135-dda8-4b28-96ef-e3ea70c911d7", "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}}/viewings/:viewing_id/conversations?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-01199135-dda8-4b28-96ef-e3ea70c911d7" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-dccbd497-d599-47b1-a05e-2e31a56ae24d" } ], "id": "275ae8c7-c625-4a96-9ae7-df53322e0ff7", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-275ae8c7-c625-4a96-9ae7-df53322e0ff7" }, { "name": "tags", "item": [ { "name": "List Tags on Viewing", "id": "08feffd9-b818-454b-a8d1-9879fb0f6048", "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}}/viewings/:viewing_id/tags?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "tags" ], "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": "DESC" } ], "variable": [ { "id": "f572c253-7321-4014-9cdc-7534763f1bdc", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This endpoint retrieves a list of tags associated with the given Viewing ID." }, "response": [ { "id": "0cdf183c-e716-44b3-a171-6d1f06cb8c2c", "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}}/viewings/:viewing_id/tags?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "tags" ], "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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-0cdf183c-e716-44b3-a171-6d1f06cb8c2c" }, { "id": "1e7d072e-2810-435f-8174-302c3cc2290d", "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}}/viewings/:viewing_id/tags?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "tags" ], "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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-1e7d072e-2810-435f-8174-302c3cc2290d" }, { "id": "15e013eb-14fa-4357-a24f-26a667d657fe", "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}}/viewings/:viewing_id/tags?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "tags" ], "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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-15e013eb-14fa-4357-a24f-26a667d657fe" }, { "id": "d0506038-859d-4f66-9dea-f7176b4a882a", "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}}/viewings/:viewing_id/tags?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "tags" ], "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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-d0506038-859d-4f66-9dea-f7176b4a882a" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-08feffd9-b818-454b-a8d1-9879fb0f6048" }, { "name": "Tag Viewing", "id": "1af602e1-4803-44ad-8ddd-25f2c56b96cd", "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}}/viewings/:viewing_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "0353c182-fd17-4772-8819-d0cf9c82f6bb", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "Use this endpoint to create a new tag record for the\u00a0 viewing . 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 Required? \n\ntag \n [\"123\"] \n Array(String) \n Yes" }, "response": [ { "id": "cea8f34e-e8cb-4a62-b52b-c65f8de19e9f", "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}}/viewings/:viewing_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-cea8f34e-e8cb-4a62-b52b-c65f8de19e9f" }, { "id": "277f1424-ef75-4737-8504-c62d4a19b0b4", "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}}/viewings/:viewing_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-277f1424-ef75-4737-8504-c62d4a19b0b4" }, { "id": "ea2390e5-41b8-423a-aebc-83eadbd88c0d", "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}}/viewings/:viewing_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-ea2390e5-41b8-423a-aebc-83eadbd88c0d" }, { "id": "2600abc1-20f8-4f72-9b3d-e5a1ce5467bc", "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}}/viewings/:viewing_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-2600abc1-20f8-4f72-9b3d-e5a1ce5467bc" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-1af602e1-4803-44ad-8ddd-25f2c56b96cd" } ], "id": "861a0866-5e08-4a69-a5cb-8068928388ec", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-861a0866-5e08-4a69-a5cb-8068928388ec" }, { "name": "untag", "item": [ { "name": "Untag Viewing", "id": "1a109fb8-3a46-48dd-96a3-b3b93008008c", "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}}/viewings/:viewing_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "926eb448-9c23-495e-9739-b29e8f3c1f1b", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "Use this endpoint to unassign tag record from the viewing . The API will return the saved data. 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": "a82ad6ac-a807-4637-9815-e1a20817b9df", "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}}/viewings/:viewing_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-a82ad6ac-a807-4637-9815-e1a20817b9df" }, { "id": "2f44d446-f46f-4e14-866c-9729070b4a38", "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}}/viewings/:viewing_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-2f44d446-f46f-4e14-866c-9729070b4a38" }, { "id": "b8cc415e-be63-426d-9e8e-308ad27b24cb", "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}}/viewings/:viewing_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-b8cc415e-be63-426d-9e8e-308ad27b24cb" }, { "id": "713bf2fa-238d-47f2-bdc9-05e5c45c178e", "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}}/viewings/:viewing_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-713bf2fa-238d-47f2-bdc9-05e5c45c178e" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-1a109fb8-3a46-48dd-96a3-b3b93008008c" } ], "id": "e64efc1c-98ab-4b80-ad7c-9749041a4644", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-e64efc1c-98ab-4b80-ad7c-9749041a4644" }, { "name": "untag_all", "item": [ { "name": "Untag All Viewing Tags", "id": "1dd5cc88-f81b-45cd-9fdb-455f08b79654", "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}}/viewings/:viewing_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "728dba85-3ff0-4fe2-a82f-9bffe2cd9156", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "Use this endpoint to unassign all tags from the\u00a0 viewing ." }, "response": [ { "id": "486c66c4-71c2-46f9-90cd-714c76a57dd2", "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}}/viewings/:viewing_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-486c66c4-71c2-46f9-90cd-714c76a57dd2" }, { "id": "b7d20ed8-243f-4f36-9ee6-abd292d4f79e", "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}}/viewings/:viewing_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-b7d20ed8-243f-4f36-9ee6-abd292d4f79e" }, { "id": "77111e5e-1800-470a-9904-807e85ede5f2", "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}}/viewings/:viewing_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-77111e5e-1800-470a-9904-807e85ede5f2" }, { "id": "bb34f0f2-ba9e-43ae-b43c-696c424969b6", "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}}/viewings/:viewing_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-bb34f0f2-ba9e-43ae-b43c-696c424969b6" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-1dd5cc88-f81b-45cd-9fdb-455f08b79654" } ], "id": "fccfd5cc-fe96-4455-aebb-c884dac523ed", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-fccfd5cc-fe96-4455-aebb-c884dac523ed" }, { "name": "notes", "item": [ { "name": "{note_id}", "item": [ { "name": "View Note On Viewing", "id": "41f727af-2766-4d39-ab8a-fb04b4439902", "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}}/viewings/:viewing_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "notes", ":note_id" ], "variable": [ { "id": "8932fc88-0d2d-402a-a822-0dfe644d2e6d", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." }, { "id": "3ecdd439-d670-4629-8eeb-a838794c644b", "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": "fe3bc000-99dd-4b52-ac87-8eccc8d3022d", "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}}/viewings/:viewing_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "notes", ":note_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-fe3bc000-99dd-4b52-ac87-8eccc8d3022d" }, { "id": "9e23cf8d-dde0-4103-98cc-bf5ebc5fbb61", "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}}/viewings/:viewing_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "notes", ":note_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-9e23cf8d-dde0-4103-98cc-bf5ebc5fbb61" }, { "id": "9af2401d-d5ae-495f-a125-7c815f5a6179", "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}}/viewings/:viewing_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "notes", ":note_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-9af2401d-d5ae-495f-a125-7c815f5a6179" }, { "id": "a5abb399-20b6-4b05-8037-2f11450aca09", "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}}/viewings/:viewing_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "notes", ":note_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-a5abb399-20b6-4b05-8037-2f11450aca09" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-41f727af-2766-4d39-ab8a-fb04b4439902" }, { "name": "Update Note On Viewing", "id": "3b7b9280-7c0c-4065-88a7-79bd655e5b5e", "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}}/viewings/:viewing_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "3cfd64ba-0747-4699-a89e-83999940eedc", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." }, { "id": "2f6be07f-0258-47f7-b25c-e0cbac9ac81c", "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 note 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": "cb323df5-6331-42b0-b0b0-4cf8ea2bb448", "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}}/viewings/:viewing_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-cb323df5-6331-42b0-b0b0-4cf8ea2bb448" }, { "id": "b779e6d7-d7d7-43ff-a9be-3d9fec4e9f39", "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}}/viewings/:viewing_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-b779e6d7-d7d7-43ff-a9be-3d9fec4e9f39" }, { "id": "f5ce6565-dd2e-43f4-b0aa-3a2e79e41671", "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}}/viewings/:viewing_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-f5ce6565-dd2e-43f4-b0aa-3a2e79e41671" }, { "id": "2a55b71e-8427-4e6f-bb7e-f52900a11e19", "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}}/viewings/:viewing_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-2a55b71e-8427-4e6f-bb7e-f52900a11e19" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-3b7b9280-7c0c-4065-88a7-79bd655e5b5e" }, { "name": "Delete Note On Viewing", "id": "76689b53-ae79-4876-baab-5f8f0de78bea", "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}}/viewings/:viewing_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "notes", ":note_id" ], "variable": [ { "id": "5b7213ef-2f0c-4c14-b2ec-e0750fb2c61a", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." }, { "id": "1d98ce96-36a5-4968-b994-103da22521d5", "key": "note_id", "value": "", "description": "(Required) Arthur note id." } ] }, "description": "This endpoint deletes an existing note using the note\u00a0 id ." }, "response": [ { "id": "d7823215-0d32-4b2f-a27c-ddb49977f111", "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}}/viewings/:viewing_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "notes", ":note_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-d7823215-0d32-4b2f-a27c-ddb49977f111" }, { "id": "1ad29885-7542-49e5-bd27-f261e605f4f4", "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}}/viewings/:viewing_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "notes", ":note_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-1ad29885-7542-49e5-bd27-f261e605f4f4" }, { "id": "654d413a-0f05-423b-8c92-645c98e50ac2", "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}}/viewings/:viewing_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "notes", ":note_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-654d413a-0f05-423b-8c92-645c98e50ac2" }, { "id": "cfce57ee-57f4-4309-ad8c-1b4eac5a7d1b", "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}}/viewings/:viewing_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "notes", ":note_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-cfce57ee-57f4-4309-ad8c-1b4eac5a7d1b" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-76689b53-ae79-4876-baab-5f8f0de78bea" } ], "id": "9e0ecf4e-92a6-4861-8dde-855c1c21b59a", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-9e0ecf4e-92a6-4861-8dde-855c1c21b59a" }, { "name": "List Notes On Viewing", "id": "78dfd579-7157-4cea-9a68-9e8bf3ed81a7", "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}}/viewings/:viewing_id/notes?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "id": "c3f66809-fe9d-410d-a743-fa72c9388fac", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This endpoint retrieves a list of\u00a0 notes \u00a0associated with the given viewing ID." }, "response": [ { "id": "1b49ed7e-c34b-46ba-9c50-7106d3077ee7", "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}}/viewings/:viewing_id/notes?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-1b49ed7e-c34b-46ba-9c50-7106d3077ee7" }, { "id": "fc3230ae-1b66-4d89-9494-1863d312b30d", "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}}/viewings/:viewing_id/notes?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-fc3230ae-1b66-4d89-9494-1863d312b30d" }, { "id": "f61cba25-f2cf-4335-ad44-24299976b2cb", "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}}/viewings/:viewing_id/notes?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-f61cba25-f2cf-4335-ad44-24299976b2cb" }, { "id": "cf52da98-26d6-4cfc-84a0-62ed6c744d0c", "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}}/viewings/:viewing_id/notes?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-cf52da98-26d6-4cfc-84a0-62ed6c744d0c" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-78dfd579-7157-4cea-9a68-9e8bf3ed81a7" }, { "name": "Add Note On Viewing", "id": "02d82c95-1b5a-407f-8934-cf7627fad969", "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 \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "12c8f70e-f635-4f10-b145-be96aa1de5c5", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "Use this endpoint to create a new note record for the\u00a0 viewing . 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 \n\ntags \n ['one','two'] \n Array(String) \n No" }, "response": [ { "id": "61ac9f86-a9e3-48da-93f6-9107c20b39c7", "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 \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-61ac9f86-a9e3-48da-93f6-9107c20b39c7" }, { "id": "5c18da1a-86d3-4134-8d4a-94279d7b4565", "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 \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-5c18da1a-86d3-4134-8d4a-94279d7b4565" }, { "id": "2d1a0569-8d9f-4ffb-bcb6-dcf615ec318e", "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 \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-2d1a0569-8d9f-4ffb-bcb6-dcf615ec318e" }, { "id": "09a6101a-8e9f-4002-810f-d376c4ed81a3", "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 \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-09a6101a-8e9f-4002-810f-d376c4ed81a3" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-02d82c95-1b5a-407f-8934-cf7627fad969" } ], "id": "997e4bd2-724d-4358-a5b2-82425dca5b94", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-997e4bd2-724d-4358-a5b2-82425dca5b94" }, { "name": "tenancies", "item": [ { "name": "List Tenancies On Viewing", "id": "3c2b2f7e-dae3-4125-8b66-ac64d4e76a58", "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}}/viewings/:viewing_id/tenancies?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "id": "3182e370-a432-4a36-b51f-a15dc5a8d074", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This endpoint retrieves a list of tenancies associated with the given viewing ID." }, "response": [ { "id": "9a4eec6d-55da-4e07-a2f7-70cf6114ce33", "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}}/viewings/:viewing_id/tenancies?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-9a4eec6d-55da-4e07-a2f7-70cf6114ce33" }, { "id": "044d682e-c39b-4ab3-bbee-c3e2d0d3448b", "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}}/viewings/:viewing_id/tenancies?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-044d682e-c39b-4ab3-bbee-c3e2d0d3448b" }, { "id": "df1e8314-2139-42c4-9652-f91d692593c6", "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}}/viewings/:viewing_id/tenancies?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-df1e8314-2139-42c4-9652-f91d692593c6" }, { "id": "3cdb3f06-1515-4d6d-9d01-97cf0ea5d650", "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}}/viewings/:viewing_id/tenancies?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "DESC" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-3cdb3f06-1515-4d6d-9d01-97cf0ea5d650" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-3c2b2f7e-dae3-4125-8b66-ac64d4e76a58" }, { "name": "Add Tenancy On Viewing", "id": "f01d0ee1-9280-4e7b-9306-0956b0d8768c", "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}}/viewings/:viewing_id/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "9ecb3e7c-fc73-4c18-969e-05414d15e988", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "Use this endpoint to create a new tenancy from a viewing. 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": "a6949f97-ac64-4fbe-8265-a78c05cdbcca", "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}}/viewings/:viewing_id/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-a6949f97-ac64-4fbe-8265-a78c05cdbcca" }, { "id": "8f755465-97b4-4df6-b8c1-d83df91711bf", "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}}/viewings/:viewing_id/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-8f755465-97b4-4df6-b8c1-d83df91711bf" }, { "id": "743834c8-4df8-4f41-bb13-fa3008fc83ec", "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}}/viewings/:viewing_id/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-743834c8-4df8-4f41-bb13-fa3008fc83ec" }, { "id": "28e06472-3d56-49bf-9a9f-16bc7bf8f560", "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}}/viewings/:viewing_id/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-28e06472-3d56-49bf-9a9f-16bc7bf8f560" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-f01d0ee1-9280-4e7b-9306-0956b0d8768c" } ], "id": "82782492-bc3c-4389-891f-4d3512910ab6", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-82782492-bc3c-4389-891f-4d3512910ab6" }, { "name": "submit_offer", "item": [ { "name": "Submit Offer on Viewing", "id": "2a64b753-918a-45b4-bbfe-e233b411bb42", "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 \"amount\": \"\",\n \"frequency\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/submit_offer?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "submit_offer" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "7b44488b-be23-4460-b7a9-ede780334cbc", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This endpoint submits an offer to an existing viewing. Any fields that are not provided will not be changed. The API will return the updated data for the viewing 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\namount \n 1200 \n String \n Yes \n\nfrequency \n Month \n String \n Yes (Week, Month, or Year)" }, "response": [ { "id": "6eb0ceb2-de3b-4079-9f4f-12993f4b1fce", "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 \"amount\": \"\",\n \"frequency\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/submit_offer?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "submit_offer" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-6eb0ceb2-de3b-4079-9f4f-12993f4b1fce" }, { "id": "dd03c290-e761-47be-8c7b-1736a118d6f5", "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 \"amount\": \"\",\n \"frequency\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/submit_offer?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "submit_offer" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-dd03c290-e761-47be-8c7b-1736a118d6f5" }, { "id": "93d0294c-87a7-4271-a429-5b3d0012d578", "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 \"amount\": \"\",\n \"frequency\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/submit_offer?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "submit_offer" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-93d0294c-87a7-4271-a429-5b3d0012d578" }, { "id": "3ac3f47a-760a-47ba-b5cc-7f40ca515a00", "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 \"amount\": \"\",\n \"frequency\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/submit_offer?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "submit_offer" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-3ac3f47a-760a-47ba-b5cc-7f40ca515a00" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-2a64b753-918a-45b4-bbfe-e233b411bb42" } ], "id": "00c0edd2-04e2-43d8-ac24-32287bfffcb4", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-00c0edd2-04e2-43d8-ac24-32287bfffcb4" }, { "name": "status", "item": [ { "name": "Update Viewing Status", "id": "f355b567-3298-49ee-8f39-5272f3927847", "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 \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/status?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "status" ], "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": "aa537347-895a-4361-839c-6a441b1c87f3", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This endpoint updates an existing viewing status. The API will return the updated data for the viewing 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\nstatus \n \"Confirmed\" \n String \n Yes" }, "response": [ { "id": "2fec2db5-a430-44f2-9e25-e44a0b03b0dc", "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 \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/status?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "status" ], "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": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-2fec2db5-a430-44f2-9e25-e44a0b03b0dc" }, { "id": "b9e170f3-7cc1-4838-8b55-e66d02a7d0ab", "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 \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/status?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "status" ], "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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-b9e170f3-7cc1-4838-8b55-e66d02a7d0ab" }, { "id": "d053c8c4-28e2-4cb5-8e05-9ad4f640600a", "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 \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/status?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "status" ], "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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-d053c8c4-28e2-4cb5-8e05-9ad4f640600a" }, { "id": "e87d7b7a-d650-4102-b9d2-2ba7538db3b8", "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 \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id/status?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id", "status" ], "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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-e87d7b7a-d650-4102-b9d2-2ba7538db3b8" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-f355b567-3298-49ee-8f39-5272f3927847" } ], "id": "b0e6ade1-6213-4a61-b32c-685a33e6672a", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-b0e6ade1-6213-4a61-b32c-685a33e6672a" }, { "name": "View Viewing", "id": "0bf164e6-defc-4e29-b6eb-4524a594ac75", "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}}/viewings/:viewing_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "variable": [ { "id": "40a98b4c-f8f8-436f-a2ab-599840cc7617", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This API endpoint retrieves the details of a single viewing, identified by its unique\u00a0 viewing_id .\n\nUse this endpoint to view the specific details of a viewing." }, "response": [ { "id": "0c73658b-9054-41e9-a12c-47bd81560dce", "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}}/viewings/:viewing_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "variable": [ { "key": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-0c73658b-9054-41e9-a12c-47bd81560dce" }, { "id": "d9cb664e-3139-46fe-8cba-695d9ff5c2a1", "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}}/viewings/:viewing_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-d9cb664e-3139-46fe-8cba-695d9ff5c2a1" }, { "id": "a17069c2-add7-405f-9f37-366a256a2713", "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}}/viewings/:viewing_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-a17069c2-add7-405f-9f37-366a256a2713" }, { "id": "c6863199-dac9-4015-8a53-e1ef06295846", "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}}/viewings/:viewing_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-c6863199-dac9-4015-8a53-e1ef06295846" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-0bf164e6-defc-4e29-b6eb-4524a594ac75" }, { "name": "Update Viewing", "id": "3115d532-9ca8-4da1-b386-a700b64a836a", "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 \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"duration\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"viewing_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "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": "e8eb715d-afe8-4f45-a0bd-cf9487cc17a9", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This endpoint updates an existing viewing using the same fields as the 'Add Viewing' endpoint, excluding unit_id and applicant_id . Any fields that are not provided will not be changed.\n\nThe API will return the updated data for the viewing 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\nviewing_date \n \"2020-10-10\" \n Date \n No \n\nviewing_time \n \"15:30\" \n Time \n No \n\nduration \n 15 \n Integer \n No \n\noffer_amount \n 1050.30 \n float \n No \n\noffer_frequency \n \"per week\" \n string \n No \n\nmove_in_date \n \"2020-10-10\" \n Date \n No \n\nassigned_to_ids \n [\"12\"] \n Array(Strings) \n No \n\ntags \n [\"tag1\"] \n Array(Strings) \n No \n\nsource \n facebook \n String \n No \n\nviewing_notes \n \"lorem ipsum\" \n String \n No \n\nviewing_status \n \"Confirmed\" \n String \n No" }, "response": [ { "id": "de90f252-c02e-4851-a72c-4477c298e69e", "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 \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"duration\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"viewing_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "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": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-de90f252-c02e-4851-a72c-4477c298e69e" }, { "id": "89baff37-822f-4a37-8ff8-afc984d821a0", "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 \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"duration\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"viewing_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-89baff37-822f-4a37-8ff8-afc984d821a0" }, { "id": "aa8b02c1-c606-425d-ab8b-76332c1bb12e", "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 \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"duration\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"viewing_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-aa8b02c1-c606-425d-ab8b-76332c1bb12e" }, { "id": "d3ae2503-3b6f-4e47-9054-9bd858c759d5", "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 \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"duration\": \"\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"viewing_status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings/:viewing_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "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": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-d3ae2503-3b6f-4e47-9054-9bd858c759d5" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-3115d532-9ca8-4da1-b386-a700b64a836a" }, { "name": "Delete Viewing", "id": "7f3576fe-858c-4646-85bd-9fdc6e854f22", "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}}/viewings/:viewing_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "variable": [ { "id": "47b2b607-452e-4b9e-b78a-d80e7685b0c7", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "This endpoint deletes an existing viewing record using the viewing id ." }, "response": [ { "id": "545d07d2-0e1f-46d9-938d-571f741d8a10", "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}}/viewings/:viewing_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "variable": [ { "key": "viewing_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-545d07d2-0e1f-46d9-938d-571f741d8a10" }, { "id": "55e78f08-0a09-490e-8b11-ea35901cb9eb", "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}}/viewings/:viewing_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-55e78f08-0a09-490e-8b11-ea35901cb9eb" }, { "id": "6c5aba3e-6802-42f1-9398-01abbab16107", "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}}/viewings/:viewing_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-6c5aba3e-6802-42f1-9398-01abbab16107" }, { "id": "e45b0638-621b-48d1-bfff-bd194cf74b67", "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}}/viewings/:viewing_id", "host": [ "{{baseUrl}}" ], "path": [ "viewings", ":viewing_id" ], "variable": [ { "key": "viewing_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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-e45b0638-621b-48d1-bfff-bd194cf74b67" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-7f3576fe-858c-4646-85bd-9fdc6e854f22" } ], "id": "7f8239f4-ae1a-4bcd-b3d3-ed10f8ffa8e2", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-7f8239f4-ae1a-4bcd-b3d3-ed10f8ffa8e2" }, { "name": "List Viewings", "id": "bb346288-5af4-46e9-90a5-1dd6c76a3be2", "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}}/viewings?unit_id=&status=&assigned_to=&tags=&assigned_to_me=&date_from=&date_to=&viewing_date=&offer_amount=&offer_frequency=&_q=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings" ], "query": [ { "description": "Filter by assigned unit", "key": "unit_id", "value": "" }, { "description": "Filter viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assigned_to", "value": "" }, { "description": "Filter viewings by tags", "key": "tags", "value": "" }, { "description": "To display only viewings assigned to you, set this to true", "key": "assigned_to_me", "value": "" }, { "description": "Filters viewings by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date", "key": "date_from", "value": "" }, { "description": "Filters viewings by the date, up to the specified date. Use the format yyyy-mm-dd to input the date", "key": "date_to", "value": "" }, { "description": "Filter by a viewing date. Use the format yyyy-mm-dd to input the date", "key": "viewing_date", "value": "" }, { "description": "Filter by the amount offered", "key": "offer_amount", "value": "" }, { "description": "Filter by the amount offered frequency", "key": "offer_frequency", "value": "" }, { "description": "Filter by a 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": "DESC" } ] }, "description": "This endpoint retrieves a list of viewings.\n\nSee available filters below to customize the list of viewings returned." }, "response": [ { "id": "4ee06448-77ea-40c0-9d36-9989a84f13bb", "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}}/viewings?unit_id=&status=&assigned_to=&tags=&assigned_to_me=&date_from=&date_to=&viewing_date=&offer_amount=&offer_frequency=&_q=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings" ], "query": [ { "description": "Filter by assigned unit", "key": "unit_id", "value": "" }, { "description": "Filter viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assigned_to", "value": "" }, { "description": "Filter viewings by tags", "key": "tags", "value": "" }, { "description": "To display only viewings assigned to you, set this to true", "key": "assigned_to_me", "value": "" }, { "description": "Filters viewings by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date", "key": "date_from", "value": "" }, { "description": "Filters viewings by the date, up to the specified date. Use the format yyyy-mm-dd to input the date", "key": "date_to", "value": "" }, { "description": "Filter by a viewing date. Use the format yyyy-mm-dd to input the date", "key": "viewing_date", "value": "" }, { "description": "Filter by the amount offered", "key": "offer_amount", "value": "" }, { "description": "Filter by the amount offered frequency", "key": "offer_frequency", "value": "" }, { "description": "Filter by a 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": "DESC" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-4ee06448-77ea-40c0-9d36-9989a84f13bb" }, { "id": "c13b4979-587b-4e8c-a848-760efede7b06", "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}}/viewings?unit_id=&status=&assigned_to=&tags=&assigned_to_me=&date_from=&date_to=&viewing_date=&offer_amount=&offer_frequency=&_q=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings" ], "query": [ { "description": "Filter by assigned unit", "key": "unit_id", "value": "" }, { "description": "Filter viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assigned_to", "value": "" }, { "description": "Filter viewings by tags", "key": "tags", "value": "" }, { "description": "To display only viewings assigned to you, set this to true", "key": "assigned_to_me", "value": "" }, { "description": "Filters viewings by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date", "key": "date_from", "value": "" }, { "description": "Filters viewings by the date, up to the specified date. Use the format yyyy-mm-dd to input the date", "key": "date_to", "value": "" }, { "description": "Filter by a viewing date. Use the format yyyy-mm-dd to input the date", "key": "viewing_date", "value": "" }, { "description": "Filter by the amount offered", "key": "offer_amount", "value": "" }, { "description": "Filter by the amount offered frequency", "key": "offer_frequency", "value": "" }, { "description": "Filter by a 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": "DESC" } ] } }, "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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-c13b4979-587b-4e8c-a848-760efede7b06" }, { "id": "13d73d78-d463-4b41-b124-857286042f47", "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}}/viewings?unit_id=&status=&assigned_to=&tags=&assigned_to_me=&date_from=&date_to=&viewing_date=&offer_amount=&offer_frequency=&_q=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings" ], "query": [ { "description": "Filter by assigned unit", "key": "unit_id", "value": "" }, { "description": "Filter viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assigned_to", "value": "" }, { "description": "Filter viewings by tags", "key": "tags", "value": "" }, { "description": "To display only viewings assigned to you, set this to true", "key": "assigned_to_me", "value": "" }, { "description": "Filters viewings by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date", "key": "date_from", "value": "" }, { "description": "Filters viewings by the date, up to the specified date. Use the format yyyy-mm-dd to input the date", "key": "date_to", "value": "" }, { "description": "Filter by a viewing date. Use the format yyyy-mm-dd to input the date", "key": "viewing_date", "value": "" }, { "description": "Filter by the amount offered", "key": "offer_amount", "value": "" }, { "description": "Filter by the amount offered frequency", "key": "offer_frequency", "value": "" }, { "description": "Filter by a 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": "DESC" } ] } }, "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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-13d73d78-d463-4b41-b124-857286042f47" }, { "id": "96236fce-26f5-4f06-8b95-e88799d885ee", "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}}/viewings?unit_id=&status=&assigned_to=&tags=&assigned_to_me=&date_from=&date_to=&viewing_date=&offer_amount=&offer_frequency=&_q=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "viewings" ], "query": [ { "description": "Filter by assigned unit", "key": "unit_id", "value": "" }, { "description": "Filter viewings by status.", "key": "status", "value": "" }, { "description": "Filter the viewings by assigned to ID.", "key": "assigned_to", "value": "" }, { "description": "Filter viewings by tags", "key": "tags", "value": "" }, { "description": "To display only viewings assigned to you, set this to true", "key": "assigned_to_me", "value": "" }, { "description": "Filters viewings by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date", "key": "date_from", "value": "" }, { "description": "Filters viewings by the date, up to the specified date. Use the format yyyy-mm-dd to input the date", "key": "date_to", "value": "" }, { "description": "Filter by a viewing date. Use the format yyyy-mm-dd to input the date", "key": "viewing_date", "value": "" }, { "description": "Filter by the amount offered", "key": "offer_amount", "value": "" }, { "description": "Filter by the amount offered frequency", "key": "offer_frequency", "value": "" }, { "description": "Filter by a 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": "DESC" } ] } }, "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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-96236fce-26f5-4f06-8b95-e88799d885ee" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-bb346288-5af4-46e9-90a5-1dd6c76a3be2" }, { "name": "Add Viewing", "id": "2aa0fee5-3f80-43a5-aaec-4eeeb8a6201e", "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 \"unit_id\": \"\",\n \"applicant_id\": \"\",\n \"applicant_ids\": [\n \"\",\n \"\"\n ],\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"duration\": \"\",\n \"offer_amount\": \"\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"viewing_status\": \"Confirmed\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"date_of_birth\": \"\",\n \"mobile\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"has_guarantor\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "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": "" } ] }, "description": "Use this endpoint to create a new viewing record. 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 if applicant_ids not provided. \n\napplicant_ids \n [\"123\"] \n Array(Strings) \n\nYes if applicant_id not provided. \n\nunit_id \n 1234 \n Integer \n\nYes \n\nviewing_date \n \"1999-12-12\" \n Date \n\nNo \n\nviewing_time \n \"14:31\" \n Time \n\nNo \n\nduration \n 15 \n Integer \n\nNo \n\noffer_amount \n 1250.00 \n Float \n\nNo \n\nmove_in_date \n \"1999-12-13\" \n Date \n\nNo \n\nassigned_to_ids \n [\"123\",\"321\"] \n Array(Strings) \n\nNo \n\ntags \n [\"cheap rent\"] \n Array(Strings) \n\nNo \n\nsource \n \"gumtree\" \n String \n\nNo \n\nviewing_notes \n \"3 month contract\" \n String \n\nNo \n\nviewing_status \n \"Confirmed\" \n String \n Confirmed \n No \n\nYou can use the \"new_applicants\" object to simultaneously create or update applicants. This will replace the \"applicant_id\" and \"applicant_ids\" fields. Here's an example of how to use it:\n\nTo create a new applicant, include the following information within the \"new_applicants\" object:\n\n\"new_applicants\": [\n {\n \"first_name\": \"Matej\",\n \"last_name\": \"Cubbit\",\n \"email\": \"matej123@gmail.com\"\n }\n]\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\napplicant_id \n 123 \n Integer \n No \n\nfirst_name \n \"Michael\" \n String \n Yes / if applicant_id not provided \n\nlast_name \n \"Cubitt\" \n String \n Yes / if applicant_id not provided \n\nemail \n \" michael123@gmail.com \n String \n Yes / if applicant_id not provided \n\ndate_of_birth \n \"1999-12-12\" \n Date \n No \n\nmobile \n \"0201230201\" \n String \n No \n\nphone_home \n \"0201230201\" \n String \n No \n\nphone_work \n \"0201230201\" \n String \n No \n\nhas_guarantor \n true \n Boolean \n No \n\nguarantor_first_name \n \"Brian\" \n String \n No \n\nguarantor_last_name \n \"Oneil\" \n String \n No \n\nguarantor_mobile \n \"0201230201\" \n String \n No \n\nguarantor_email \n \" myguarantor@gmail.com \n String \n No" }, "response": [ { "id": "eb10f965-49c6-4926-bf01-c76afd4a8f54", "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 \"unit_id\": \"\",\n \"applicant_id\": \"\",\n \"applicant_ids\": [\n \"\",\n \"\"\n ],\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"duration\": \"\",\n \"offer_amount\": \"\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"viewing_status\": \"Confirmed\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"date_of_birth\": \"\",\n \"mobile\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"has_guarantor\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "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": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-eb10f965-49c6-4926-bf01-c76afd4a8f54" }, { "id": "80d6b793-0c89-464e-ba63-5a0a73127c15", "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 \"unit_id\": \"\",\n \"applicant_id\": \"\",\n \"applicant_ids\": [\n \"\",\n \"\"\n ],\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"duration\": \"\",\n \"offer_amount\": \"\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"viewing_status\": \"Confirmed\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"date_of_birth\": \"\",\n \"mobile\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"has_guarantor\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "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": "" } ] } }, "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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-80d6b793-0c89-464e-ba63-5a0a73127c15" }, { "id": "daff18e8-2cb3-4ca1-a327-145cfd9f1619", "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 \"unit_id\": \"\",\n \"applicant_id\": \"\",\n \"applicant_ids\": [\n \"\",\n \"\"\n ],\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"duration\": \"\",\n \"offer_amount\": \"\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"viewing_status\": \"Confirmed\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"date_of_birth\": \"\",\n \"mobile\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"has_guarantor\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "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": "" } ] } }, "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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-daff18e8-2cb3-4ca1-a327-145cfd9f1619" }, { "id": "6d66ba71-16bb-4b1d-b8d9-a095782296b4", "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 \"unit_id\": \"\",\n \"applicant_id\": \"\",\n \"applicant_ids\": [\n \"\",\n \"\"\n ],\n \"viewing_date\": \"\",\n \"viewing_time\": \"\",\n \"duration\": \"\",\n \"offer_amount\": \"\",\n \"move_in_date\": \"\",\n \"assigned_to_ids\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"viewing_status\": \"Confirmed\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"date_of_birth\": \"\",\n \"mobile\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"has_guarantor\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/viewings?strict=", "host": [ "{{baseUrl}}" ], "path": [ "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": "" } ] } }, "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:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-6d66ba71-16bb-4b1d-b8d9-a095782296b4" } ], "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-2aa0fee5-3f80-43a5-aaec-4eeeb8a6201e" } ], "id": "55b36065-e402-4a35-bb7a-3bf0378d2f71", "createdAt": "2026-07-28T01:05:07.000Z", "updatedAt": "2026-07-28T01:05:07.000Z", "uid": "35240-55b36065-e402-4a35-bb7a-3bf0378d2f71" } ], "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" } ] }