{ "info": { "_postman_id": "adbd70a9-af9e-49a9-94f4-ee9003387d60", "name": "Arthur Tenancies API", "description": "Arthur Tenancies API - the tenancies 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:00.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "lastUpdatedBy": "35240", "uid": "35240-adbd70a9-af9e-49a9-94f4-ee9003387d60" }, "item": [ { "name": "tenancies", "item": [ { "name": "{tenancy_id}", "item": [ { "name": "tenants", "item": [ { "name": "List Tenants On Tenancy", "id": "accf3d65-0048-4bb0-aeb5-e443e6ab0908", "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}}/tenancies/:tenancy_id/tenants?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tenants" ], "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": "2f3e9ea9-99d6-46fc-a28e-3f6aea7b3066", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This retrieves a list of tenants related to a tenancy" }, "response": [ { "id": "6b10014e-8eef-466c-bb5c-3aa7d0ecedad", "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}}/tenancies/:tenancy_id/tenants?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tenants" ], "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": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-6b10014e-8eef-466c-bb5c-3aa7d0ecedad" }, { "id": "3e8ed6e8-6dc7-4c94-a051-bdb63cbbce92", "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}}/tenancies/:tenancy_id/tenants?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tenants" ], "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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-3e8ed6e8-6dc7-4c94-a051-bdb63cbbce92" }, { "id": "11f20df7-487a-4c8f-a3d7-c1a9fff5a3a5", "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}}/tenancies/:tenancy_id/tenants?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tenants" ], "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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-11f20df7-487a-4c8f-a3d7-c1a9fff5a3a5" }, { "id": "fd95a1b9-ebe5-4030-8ac7-bef813e9b38c", "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}}/tenancies/:tenancy_id/tenants?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tenants" ], "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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-fd95a1b9-ebe5-4030-8ac7-bef813e9b38c" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-accf3d65-0048-4bb0-aeb5-e443e6ab0908" }, { "name": "Add Tenant On Tenancy", "id": "78cb6a9c-37fc-42a5-a4e5-28fa5730b556", "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 \"main_tenant\": \"\",\n \"move_in_date\": \"\",\n \"move_out_date\": \"\",\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"compant_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_mobile\": \"\",\n \"kin_last_name\": \"\",\n \"kin_first_name\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": \"\",\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_home_owner\": \"\",\n \"guarantor_profession\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_county\": \"\",\n \"ref_city\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"applicant_note\": \"\",\n \"manager_note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tenants?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tenants" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "47c68b4f-cd38-4d62-ad81-bf4146acd827", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "Use this endpoint to create a new tenant on a tenancy. The API will return the saved data and a unique tenant ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nmain_tenant \n True \n Boolean \n No \n\nmove_in_date \n 2019-05-28 \n Date \n No \n\nmove_out_date \n 2019-06-28 \n Time \n No \n\ntitle \n Mr \n Enum \n No \n\nfirst_name \n Ryan \n String \n No \n\nlast_name \n Cullen \n String \n No \n\ndate_of_birth \n 1995-01-21 \n Date \n No \n\ngender \n Male \n Enum \n No \n\ncitizen_type \n 1 \n Enum \n No \n\nemail \n email@gmail.com \n String \n No \n\ncompany_name \n MyCompany \n Strong \n No \n\ncompant_address_name \n Address \n String \n No \n\ncompany_address1 \n Boundry Road \n String \n No \n\ncompany_address2 \n Wren Court \n String \n No \n\ncompany_city \n London \n String \n No \n\ncompany_postcode \n SW94DA \n String \n No \n\ncompany_county \n City of London \n String \n No \n\ncompany_country \n England \n String \n No \n\nphone_home \n 029302932 \n String \n No \n\nphone_work \n 029382928 \n String \n No \n\nmobile \n 020192029 \n String \n No \n\nresidential_number \n 201 \n String \n No \n\nvisa_number \n 120-123 \n String \n No \n\nvisa_years \n 3 \n String \n No \n\nvisa_type \n Tier 2 \n Enum \n No \n\ncountry_of_origin \n Wales \n String \n No \n\nni_number \n KS 01 AK 11 F \n String \n No \n\nkin_mobile \n 029302991 \n String \n No \n\nkin_last_name \n Cullen \n String \n No \n\nkin_first_name \n Monica \n String \n No \n\nkin_phone_work \n 029320191 \n String \n No \n\nstudent_status \n Full-time \n String \n No \n\nuniversity \n Oxford \n String \n No \n\ncourse_name \n Doe Studies \n String \n No \n\ncourse_id \n 1 \n String \n No \n\ncourse_year \n 2 \n String \n No \n\nemployment_company_name \n Lorem \n String \n No \n\nemployment_address1 \n Address First Line \n String \n No \n\nemployment_address2 \n Address Second Line \n String \n No \n\nemployment_city \n Liverpool \n String \n No \n\nemployment_postcode \n LN91LS \n String \n No \n\nemployment_county \n Norfolk \n String \n No \n\nemployment_contact_name \n Grace \n String \n No \n\nemployment_contact_number \n 0239203900 \n String \n No \n\nemployment_salary \n 90000 \n String \n No \n\nemployment_length \n 5 years \n String \n No \n\nhousing_benefit_council \n Borought \n String \n No \n\nhousing_benefit_number \n 19203 \n String \n No \n\nguarantor_first_name \n Nicolas \n String \n No \n\nguarantor_last_name \n Cage \n String \n No \n\nguarantor_date_of_birth \n 1911-02-12 \n String \n No \n\nguarantor_address1 \n Address first line \n String \n No \n\nguarantor_address2 \n Address second line \n String \n No \n\nguarantor_city \n London \n String \n No \n\nguarantor_postcode \n XP91AP \n String \n No \n\nguarantor_county \n Suffolk \n String \n No \n\nguarantor_country \n England \n String \n No \n\nguarantor_phone_home \n 028392871 \n String \n No \n\nguarantor_phone_work \n 028191282 \n String \n No \n\nguarantor_mobile \n 029384383 \n String \n No \n\nguarantor_email \n guarantor@email.com \n String \n No \n\nguarantor_relation \n Brother \n String \n No \n\nguarantor_home_owner \n Yes \n String \n No \n\nguarantor_profession \n Teacher \n String \n No \n\nbank_name \n Barclays \n String \n No \n\nbank_address1 \n Address first line \n String \n No \n\nbank_address2 \n Address second line \n String \n No \n\nbank_city \n Romford \n String \n No \n\nbank_county \n Essex \n String \n No \n\nbank_postcode \n FS18LA \n String \n No \n\nref_name \n Ref Name \n String \n No \n\nref_address1 \n Ref First Line \n String \n No \n\nref_address2 \n Ref Second Line \n String \n No \n\nref_county \n Ref Hertfordshire \n String \n No \n\nref_city \n Ref City \n String \n No \n\nref_postcode \n Ref Postcode \n String \n No \n\nref_contact_number \n 029392832 \n String \n No \n\nref_relation \n Mother \n String \n No \n\napplicant_note \n Note to remember \n String \n No \n\nmanager_note \n Manager note \n String \n No" }, "response": [ { "id": "024e8ada-35e0-442e-9144-6f9d30066241", "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 \"main_tenant\": \"\",\n \"move_in_date\": \"\",\n \"move_out_date\": \"\",\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"compant_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_mobile\": \"\",\n \"kin_last_name\": \"\",\n \"kin_first_name\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": \"\",\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_home_owner\": \"\",\n \"guarantor_profession\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_county\": \"\",\n \"ref_city\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"applicant_note\": \"\",\n \"manager_note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tenants?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tenants" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-024e8ada-35e0-442e-9144-6f9d30066241" }, { "id": "a58e4ba0-3bc3-4c55-9b28-22d4ca864b65", "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 \"main_tenant\": \"\",\n \"move_in_date\": \"\",\n \"move_out_date\": \"\",\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"compant_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_mobile\": \"\",\n \"kin_last_name\": \"\",\n \"kin_first_name\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": \"\",\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_home_owner\": \"\",\n \"guarantor_profession\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_county\": \"\",\n \"ref_city\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"applicant_note\": \"\",\n \"manager_note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tenants?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tenants" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a58e4ba0-3bc3-4c55-9b28-22d4ca864b65" }, { "id": "3166585e-aefe-4b19-af55-4121bfd90b11", "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 \"main_tenant\": \"\",\n \"move_in_date\": \"\",\n \"move_out_date\": \"\",\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"compant_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_mobile\": \"\",\n \"kin_last_name\": \"\",\n \"kin_first_name\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": \"\",\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_home_owner\": \"\",\n \"guarantor_profession\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_county\": \"\",\n \"ref_city\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"applicant_note\": \"\",\n \"manager_note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tenants?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tenants" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-3166585e-aefe-4b19-af55-4121bfd90b11" }, { "id": "75c38a87-8e32-40a0-aedf-50670cb33ed9", "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 \"main_tenant\": \"\",\n \"move_in_date\": \"\",\n \"move_out_date\": \"\",\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"compant_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_postcode\": \"\",\n \"company_county\": \"\",\n \"company_country\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_mobile\": \"\",\n \"kin_last_name\": \"\",\n \"kin_first_name\": \"\",\n \"kin_phone_work\": \"\",\n \"student_status\": \"\",\n \"university\": \"\",\n \"course_name\": \"\",\n \"course_id\": \"\",\n \"course_year\": \"\",\n \"employment_company_name\": \"\",\n \"employment_address1\": \"\",\n \"employment_address2\": \"\",\n \"employment_city\": \"\",\n \"employment_postcode\": \"\",\n \"employment_county\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": \"\",\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_home_owner\": \"\",\n \"guarantor_profession\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_county\": \"\",\n \"ref_city\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"applicant_note\": \"\",\n \"manager_note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tenants?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tenants" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-75c38a87-8e32-40a0-aedf-50670cb33ed9" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-78cb6a9c-37fc-42a5-a4e5-28fa5730b556" } ], "id": "22021925-9324-4afe-b65b-2c47fe4cfca5", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-22021925-9324-4afe-b65b-2c47fe4cfca5" }, { "name": "assets", "item": [ { "name": "List Assets On Tenancy", "id": "5f15e96c-fa5f-4b92-bd9f-ff7fa545faee", "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}}/tenancies/:tenancy_id/assets?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "id": "1f876e26-2308-4602-8bad-0988d5e491ff", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This endpoint retrieves a list of assets associated with the given tenancy ID." }, "response": [ { "id": "8bd7f7ba-775f-46c1-95dc-6e49f8869ef5", "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}}/tenancies/:tenancy_id/assets?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-8bd7f7ba-775f-46c1-95dc-6e49f8869ef5" }, { "id": "94b60dcb-f72c-47a3-aacf-335eb9c343f3", "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}}/tenancies/:tenancy_id/assets?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-94b60dcb-f72c-47a3-aacf-335eb9c343f3" }, { "id": "78b84015-9c5b-41f7-8b8d-aef6869af4a8", "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}}/tenancies/:tenancy_id/assets?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-78b84015-9c5b-41f7-8b8d-aef6869af4a8" }, { "id": "873d223a-be5d-4aa0-8472-70205f12480b", "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}}/tenancies/:tenancy_id/assets?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "assets" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-873d223a-be5d-4aa0-8472-70205f12480b" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-5f15e96c-fa5f-4b92-bd9f-ff7fa545faee" }, { "name": "Create Asset On Tenancy", "id": "982e6c70-62b5-4dfb-b6f7-d13038e492d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "0ab52c6d-0f16-4639-9288-ebb2d22355cd", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "Use this endpoint to create a new asset related to an\u00a0 tenancy . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nasset_type \n image \n String \n No \n\nname \n inventory \n String \n No \n\nshare_manager \n true \n Boolean \n No \n\nshare_tenant \n false \n Boolean \n No \n\nshare_contractor \n true \n Boolean \n No \n\nshare_owner \n true \n Boolean \n No \n\nfile \n base64 \n String \n Yes \n\nmime_type \n application/pdf \n String \n Yes \n\nfile_name \n inventory \n String \n Yes" }, "response": [ { "id": "d1794f16-5c4f-4bc1-be2e-b67310ad9049", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-d1794f16-5c4f-4bc1-be2e-b67310ad9049" }, { "id": "987d2a49-067c-4069-bb98-a73632f7e217", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-987d2a49-067c-4069-bb98-a73632f7e217" }, { "id": "92369530-3354-47a4-b333-ef3662c39b75", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-92369530-3354-47a4-b333-ef3662c39b75" }, { "id": "c99fc766-efc8-4641-bc7f-001cd0ab1993", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"asset_type\": \"\",\n \"name\": \"\",\n \"share_manager\": \"\",\n \"share_tenant\": \"\",\n \"share_contractor\": \"\",\n \"share_owner\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/assets?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "assets" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c99fc766-efc8-4641-bc7f-001cd0ab1993" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-982e6c70-62b5-4dfb-b6f7-d13038e492d1" } ], "id": "ef0c3c4d-d859-4e52-a7ef-eca1f3d5b20c", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-ef0c3c4d-d859-4e52-a7ef-eca1f3d5b20c" }, { "name": "certificates", "item": [ { "name": "List Certificates On Tenancy", "id": "50362e61-35a7-4c01-b479-b6e4d4e3f7ab", "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}}/tenancies/:tenancy_id/certificates?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "certificates" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "id": "d72d66ad-c54f-4638-9ce4-0d23449697e8", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This endpoint retrieves a list of certificates associated with the given tenancy ID." }, "response": [ { "id": "eb08a7e4-d9f1-4c8b-bb53-7a69c0a81a1c", "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}}/tenancies/:tenancy_id/certificates?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "certificates" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-eb08a7e4-d9f1-4c8b-bb53-7a69c0a81a1c" }, { "id": "8c940ca2-307b-48b6-b31f-2c1d61cfc261", "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}}/tenancies/:tenancy_id/certificates?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "certificates" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-8c940ca2-307b-48b6-b31f-2c1d61cfc261" }, { "id": "1502c96c-38e1-4a7a-bdf4-8a618a5ae689", "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}}/tenancies/:tenancy_id/certificates?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "certificates" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-1502c96c-38e1-4a7a-bdf4-8a618a5ae689" }, { "id": "cca6c9dc-a30a-4d9a-804d-738cf9b56de7", "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}}/tenancies/:tenancy_id/certificates?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "certificates" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-cca6c9dc-a30a-4d9a-804d-738cf9b56de7" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-50362e61-35a7-4c01-b479-b6e4d4e3f7ab" }, { "name": "Add Certificate on Tenancy", "id": "fb542a0e-cfda-4387-b386-c8add560bc88", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"expiry_date\": \"\",\n \"notes\": \"\",\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/certificates?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "certificates" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "33223659-c5f0-46d4-a2eb-7dfc490e643a", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "Use this endpoint to create a new certificate related to a\u00a0 tenancy . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntype \n Boiler Service \n String \n Yes \n\nexpiry_date \n 2023-12-05 \n String \n No \n\nnotes \n Fully assessed \n String \n No \n\nfile \n Base64 \n String \n No \n\nmime_type \n application/pdf \n String \n No (Required if File field is present) \n\nfile_name \n Certificate Document \n string \n No (Required if File field is present)" }, "response": [ { "id": "fe6bf8de-b0c6-4ea4-985b-f280b08080d9", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"expiry_date\": \"\",\n \"notes\": \"\",\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/certificates?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "certificates" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-fe6bf8de-b0c6-4ea4-985b-f280b08080d9" }, { "id": "4606c2e8-fa0d-4706-84f7-436adf690156", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"expiry_date\": \"\",\n \"notes\": \"\",\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/certificates?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "certificates" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-4606c2e8-fa0d-4706-84f7-436adf690156" }, { "id": "28f04f7a-1e9a-4628-977d-ae2836517c38", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"expiry_date\": \"\",\n \"notes\": \"\",\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/certificates?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "certificates" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-28f04f7a-1e9a-4628-977d-ae2836517c38" }, { "id": "bc24ad9c-bc16-4dcd-8043-88a4df894bd9", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"expiry_date\": \"\",\n \"notes\": \"\",\n \"file\": \"\",\n \"mime_type\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/certificates?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "certificates" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-bc24ad9c-bc16-4dcd-8043-88a4df894bd9" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-fb542a0e-cfda-4387-b386-c8add560bc88" } ], "id": "816531b6-83ea-4d87-8f97-c98b452b8d4c", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-816531b6-83ea-4d87-8f97-c98b452b8d4c" }, { "name": "tasks", "item": [ { "name": "{task_id}", "item": [ { "name": "View Task On Tenancy", "id": "1c247977-fbfc-4e59-8cc5-f9612331fe69", "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}}/tenancies/:tenancy_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks", ":task_id" ], "variable": [ { "id": "e232f0d9-7618-43dc-8643-63f8d1508587", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." }, { "id": "bf1073bc-be62-4934-91c2-990ad343e0db", "key": "task_id", "value": "", "description": "(Required) Arthur task id." } ] }, "description": "This API endpoint retrieves the details of a single tenancy\u00a0 task , identified by its unique\u00a0 id ." }, "response": [ { "id": "7175a818-baee-4a0d-afb9-3349395c6861", "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}}/tenancies/:tenancy_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks", ":task_id" ], "variable": [ { "key": "tenancy_id" }, { "key": "task_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-7175a818-baee-4a0d-afb9-3349395c6861" }, { "id": "9ab96f2f-b736-481b-820f-16fbdbe8bbce", "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}}/tenancies/:tenancy_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks", ":task_id" ], "variable": [ { "key": "tenancy_id" }, { "key": "task_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-9ab96f2f-b736-481b-820f-16fbdbe8bbce" }, { "id": "49e9759c-2975-4ee0-92d5-eaa34524076b", "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}}/tenancies/:tenancy_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks", ":task_id" ], "variable": [ { "key": "tenancy_id" }, { "key": "task_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-49e9759c-2975-4ee0-92d5-eaa34524076b" }, { "id": "09a45e24-9776-4715-ab23-af393f13307a", "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}}/tenancies/:tenancy_id/tasks/:task_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks", ":task_id" ], "variable": [ { "key": "tenancy_id" }, { "key": "task_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-09a45e24-9776-4715-ab23-af393f13307a" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-1c247977-fbfc-4e59-8cc5-f9612331fe69" }, { "name": "Update Task On Tenancy", "id": "9adbfed4-0d21-4e1d-a2cd-a6d860494b59", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"task_type\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tasks/:task_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks", ":task_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "43563451-5353-4e9d-b108-3ec97d0f64ae", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." }, { "id": "8e934d01-5ece-4ce7-a322-d3870e285691", "key": "task_id", "value": "", "description": "(Required) Arthur task id." } ] }, "description": "This endpoint updates an existing task using the same fields as the 'Add Task' endpoint. The API will return the updated data for the tenancy in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntask_type \n Inspection \n String \n No \n\ndescription \n Radiator not working \n String \n No \n\ntags \n ['one','two'] \n Array(String) \n No \n\ndue_date \n 2020-10-11 \n Date \n No \n\ndue_time \n 15:32 \n Time \n No \n\nassigned_managers \n [123,1234] \n Array(Integer) \n No \n\nemergency \n True \n Boolean \n No \n\nprivate \n True \n Boolean \n No \n\napi_notes \n Landlord will be present \n String \n No" }, "response": [ { "id": "42d16d70-b67f-4558-b872-14a2d7ad4d2b", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"task_type\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tasks/:task_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks", ":task_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" }, { "key": "task_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-42d16d70-b67f-4558-b872-14a2d7ad4d2b" }, { "id": "dfff1508-c246-404c-80d3-69e95d5fad5a", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"task_type\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tasks/:task_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks", ":task_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" }, { "key": "task_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-dfff1508-c246-404c-80d3-69e95d5fad5a" }, { "id": "e0672a1f-6b1c-483b-9afd-ae4bfd189f99", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"task_type\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tasks/:task_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks", ":task_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" }, { "key": "task_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-e0672a1f-6b1c-483b-9afd-ae4bfd189f99" }, { "id": "99970971-7d1a-4f4c-b296-2be1f29aa3c9", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"task_type\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tasks/:task_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks", ":task_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" }, { "key": "task_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-99970971-7d1a-4f4c-b296-2be1f29aa3c9" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-9adbfed4-0d21-4e1d-a2cd-a6d860494b59" } ], "id": "e81fd7b3-ae1c-41f9-b1d6-a911a802e950", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-e81fd7b3-ae1c-41f9-b1d6-a911a802e950" }, { "name": "List Tasks On Tenancy", "id": "b7e29ed9-8be2-4927-ad18-0a3f207dbb65", "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}}/tenancies/:tenancy_id/tasks?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "id": "a3c00a67-39d1-4d2b-a5ff-36fbadd39f4a", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This endpoint retrieves a list of tasks associated with the given tenancy ID." }, "response": [ { "id": "7557d3b7-d8b0-4635-9766-d45a23527447", "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}}/tenancies/:tenancy_id/tasks?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-7557d3b7-d8b0-4635-9766-d45a23527447" }, { "id": "5078481c-53ed-45db-877b-47b35490b86c", "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}}/tenancies/:tenancy_id/tasks?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-5078481c-53ed-45db-877b-47b35490b86c" }, { "id": "6267e36a-c4ae-429e-acca-5e4a9c4628a5", "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}}/tenancies/:tenancy_id/tasks?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-6267e36a-c4ae-429e-acca-5e4a9c4628a5" }, { "id": "3acd0a6b-4e7b-44fa-a114-cb624e67ff9e", "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}}/tenancies/:tenancy_id/tasks?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-3acd0a6b-4e7b-44fa-a114-cb624e67ff9e" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-b7e29ed9-8be2-4927-ad18-0a3f207dbb65" }, { "name": "Add Task On Tenancy", "id": "54771870-d407-45ef-8ecb-7e450817d801", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"task_type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tasks?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "4f4e79d5-5dc8-4708-a0e9-6f8a1281e137", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "Use this endpoint to create a new task record for a tenancy . The API will return the saved data and a unique task ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntask_type \n Inspection \n String \n No \n\ndescription \n Radiator not working \n String \n Yes \n\ntags \n ['one','two'] \n Array(String) \n No \n\ndue_date \n 2020-10-11 \n Date \n No \n\ndue_time \n 15:32 \n Time \n No \n\nassigned_managers \n [123,1234] \n Array(Integer) \n No \n\nemergency \n True \n Boolean \n No \n\nprivate \n True \n Boolean \n No \n\napi_notes \n Landlord will be present \n String \n No \n\nfiles \n\n(each object must contain \"file_type\", \"file_name\", and \"file\") \n { \n\"file_type\":\"application/pdf\", \n\"file_name\":\"testing\", \n\"file\":\"(base 64)\" \n} \n\n[Array {Objects}] \n No" }, "response": [ { "id": "d0664120-9c8c-47e6-8323-24585b5d1a1a", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"task_type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tasks?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-d0664120-9c8c-47e6-8323-24585b5d1a1a" }, { "id": "de27c3ca-65bf-48ab-ac2a-13236560feb7", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"task_type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tasks?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-de27c3ca-65bf-48ab-ac2a-13236560feb7" }, { "id": "72d9a628-41c4-42a9-9068-b72e109de4fb", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"task_type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tasks?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-72d9a628-41c4-42a9-9068-b72e109de4fb" }, { "id": "d0df8d84-7a96-46fa-a637-8eca590d2f28", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"task_type\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"due_date\": \"\",\n \"due_time\": \"\",\n \"assigned_managers\": [\n \"\",\n \"\"\n ],\n \"emergency\": \"\",\n \"private\": \"\",\n \"api_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/tasks?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "tasks" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-d0df8d84-7a96-46fa-a637-8eca590d2f28" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-54771870-d407-45ef-8ecb-7e450817d801" } ], "id": "c8a23bff-ef54-4f3d-8072-fd92dc51f328", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c8a23bff-ef54-4f3d-8072-fd92dc51f328" }, { "name": "workorders", "item": [ { "name": "{workorder_id}", "item": [ { "name": "View Workorder On Tenancy", "id": "05e35518-624d-4436-9d99-468f84b41cdb", "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}}/tenancies/:tenancy_id/workorders/:workorder_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders", ":workorder_id" ], "variable": [ { "id": "0d5abfb4-806f-40f7-9784-ea8fe8f25fa3", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." }, { "id": "467355e6-8fc5-4c5e-b1ee-33e80921b854", "key": "workorder_id", "value": "", "description": "(Required) Arthur workorder id." } ] }, "description": "This API endpoint retrieves the details of a single tenancy\u00a0 workorder , identified by its unique\u00a0 id ." }, "response": [ { "id": "cd178221-f44c-4bc8-b589-3abd30b714f2", "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}}/tenancies/:tenancy_id/workorders/:workorder_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders", ":workorder_id" ], "variable": [ { "key": "tenancy_id" }, { "key": "workorder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-cd178221-f44c-4bc8-b589-3abd30b714f2" }, { "id": "6aad9272-a5eb-4c95-86e1-6d97a77fdf50", "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}}/tenancies/:tenancy_id/workorders/:workorder_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders", ":workorder_id" ], "variable": [ { "key": "tenancy_id" }, { "key": "workorder_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-6aad9272-a5eb-4c95-86e1-6d97a77fdf50" }, { "id": "e679cde3-e202-4775-ba2f-85333d957242", "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}}/tenancies/:tenancy_id/workorders/:workorder_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders", ":workorder_id" ], "variable": [ { "key": "tenancy_id" }, { "key": "workorder_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-e679cde3-e202-4775-ba2f-85333d957242" }, { "id": "6f574f12-8263-477b-ad87-ab87998b0c88", "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}}/tenancies/:tenancy_id/workorders/:workorder_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders", ":workorder_id" ], "variable": [ { "key": "tenancy_id" }, { "key": "workorder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-6f574f12-8263-477b-ad87-ab87998b0c88" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-05e35518-624d-4436-9d99-468f84b41cdb" } ], "id": "c0f431a6-e768-4114-9e37-5761404f4e51", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c0f431a6-e768-4114-9e37-5761404f4e51" }, { "name": "List Workorders On Tenancy", "id": "24d52b34-ceed-4804-b229-4cc3a1944e1a", "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}}/tenancies/:tenancy_id/workorders?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "id": "051e313c-0ebf-4ce5-8fa9-d9bab6a80ae8", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This endpoint retrieves a list of workorders associated with the given tenancy ID." }, "response": [ { "id": "cacb6727-cc98-4a1a-bfd2-b455380ab31c", "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}}/tenancies/:tenancy_id/workorders?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-cacb6727-cc98-4a1a-bfd2-b455380ab31c" }, { "id": "c8dc2afa-b537-4d70-899c-5243f6a76d46", "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}}/tenancies/:tenancy_id/workorders?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c8dc2afa-b537-4d70-899c-5243f6a76d46" }, { "id": "490b6385-73f4-436e-a4b2-fd5d5909bf4c", "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}}/tenancies/:tenancy_id/workorders?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-490b6385-73f4-436e-a4b2-fd5d5909bf4c" }, { "id": "0edd5b64-3b59-475e-b78b-fcdf4c5a65a8", "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}}/tenancies/:tenancy_id/workorders?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders" ], "query": [ { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-0edd5b64-3b59-475e-b78b-fcdf4c5a65a8" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-24d52b34-ceed-4804-b229-4cc3a1944e1a" }, { "name": "Create Workorder On Tenancy", "id": "e31791de-6121-45d1-b997-4e2230a98487", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/workorders?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "8cfd6368-9a6d-40d0-a37d-67a5d3fb54c0", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "Use this endpoint to create a new workorder record for a\u00a0 tenancy . The API will return the saved data and a unique workorder ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n Yes \n\nstart_date \n 2020-02-20 \n Date \n No \n\ndue_date \n 2020-02-20 \n Date \n No \n\nbudget \n 1000,00 \n Float \n No \n\nallocated_time_hours \n 20 \n Float \n No \n\nactual_time_hours \n 20 \n Float \n No \n\nprice_per_hour \n 7,90 \n Float \n No \n\nemergency \n true \n Boolean \n No \n\nquote_required \n true \n Boolean \n No \n\nshare_assets \n false \n Boolean \n No \n\nhide_tenant_details \n true \n Boolean \n No" }, "response": [ { "id": "4327614a-ee0f-4df4-bbd5-b7bafc788bdf", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/workorders?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-4327614a-ee0f-4df4-bbd5-b7bafc788bdf" }, { "id": "5536cdb8-b728-4cab-8002-349799a04673", "name": "The request was invalid or malformed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/workorders?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-5536cdb8-b728-4cab-8002-349799a04673" }, { "id": "0338b233-0ec0-4407-a7c4-e50c3e380a1e", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/workorders?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-0338b233-0ec0-4407-a7c4-e50c3e380a1e" }, { "id": "16c7cdee-7681-4cc0-b6a8-397162a75758", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_type\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:tenancy_id/workorders?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "workorders" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-16c7cdee-7681-4cc0-b6a8-397162a75758" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-e31791de-6121-45d1-b997-4e2230a98487" } ], "id": "89e8ac3a-59bd-40d3-bf2b-1a25ec4b40cd", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-89e8ac3a-59bd-40d3-bf2b-1a25ec4b40cd" }, { "name": "conversation_recipients", "item": [ { "name": "Get Recipients for Tenancy", "id": "4c70899d-2888-49b0-af5a-33781f84f938", "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}}/tenancies/:tenancy_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "conversation_recipients" ], "variable": [ { "id": "1ff8f119-98c8-4b8c-b652-5baed3f12a2d", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This endpoint retrieves a list of conversation recipients on a tenancy record, identified by its unique\u00a0 tenancy_id ." }, "response": [ { "id": "c0e092a2-a151-40f3-b59d-fbc44c9d5cab", "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}}/tenancies/:tenancy_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "conversation_recipients" ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c0e092a2-a151-40f3-b59d-fbc44c9d5cab" }, { "id": "6fca128e-d14c-4859-8085-a5c05d5691bc", "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}}/tenancies/:tenancy_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "conversation_recipients" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-6fca128e-d14c-4859-8085-a5c05d5691bc" }, { "id": "8d663828-ca47-4523-8e84-bb27ab4bccfc", "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}}/tenancies/:tenancy_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "conversation_recipients" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-8d663828-ca47-4523-8e84-bb27ab4bccfc" }, { "id": "ec4c7c75-451a-442e-ba99-b140d2a37ee8", "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}}/tenancies/:tenancy_id/conversation_recipients", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "conversation_recipients" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-ec4c7c75-451a-442e-ba99-b140d2a37ee8" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-4c70899d-2888-49b0-af5a-33781f84f938" } ], "id": "4386e7e3-78a7-4322-9da1-536db1d471c1", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-4386e7e3-78a7-4322-9da1-536db1d471c1" }, { "name": "conversations", "item": [ { "name": "List Conversation On Tenancy", "id": "c5cc5cc9-781f-4963-b035-3cd64488ae19", "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}}/tenancies/:tenancy_id/conversations?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "bea52a5f-5b17-446e-b79d-8605415676c9", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This endpoint retrieves a list of conversations on a tenancy, identified by its unique\u00a0 tenancy_id ." }, "response": [ { "id": "1e78eae3-2344-4935-8dad-4e9ca561006c", "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}}/tenancies/:tenancy_id/conversations?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-1e78eae3-2344-4935-8dad-4e9ca561006c" }, { "id": "82d7f055-3e80-4b59-b7c4-85826aeb39c5", "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}}/tenancies/:tenancy_id/conversations?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-82d7f055-3e80-4b59-b7c4-85826aeb39c5" }, { "id": "9baf20e7-1656-46eb-a50c-f3cfe030d4bd", "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}}/tenancies/:tenancy_id/conversations?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-9baf20e7-1656-46eb-a50c-f3cfe030d4bd" }, { "id": "9a08d8a8-6b23-42b2-88b9-8461ad1a9dd4", "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}}/tenancies/:tenancy_id/conversations?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-9a08d8a8-6b23-42b2-88b9-8461ad1a9dd4" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c5cc5cc9-781f-4963-b035-3cd64488ae19" } ], "id": "85b6f63d-6d43-4c31-b725-128345f1a326", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-85b6f63d-6d43-4c31-b725-128345f1a326" }, { "name": "transactions", "item": [ { "name": "List Transactions On Tenancy", "id": "8f2a37c3-fdbc-42d8-a3ef-08be2234ff46", "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}}/tenancies/:tenancy_id/transactions?statement=&status=&date_from=&date_to=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "transactions" ], "query": [ { "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices", "key": "statement", "value": "" }, { "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status.", "key": "status", "value": "" }, { "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_from", "value": "" }, { "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_to", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "id": "036a3c69-8a9a-414a-aeab-5d14cb9ae82e", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This retrieves a list of transactions for a Tenancy \n\nSee available filters below to customize the list of transactions returned." }, "response": [ { "id": "ad1d7015-8d6c-46a7-ac9d-571282d57782", "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}}/tenancies/:tenancy_id/transactions?statement=&status=&date_from=&date_to=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "transactions" ], "query": [ { "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices", "key": "statement", "value": "" }, { "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status.", "key": "status", "value": "" }, { "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_from", "value": "" }, { "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_to", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-ad1d7015-8d6c-46a7-ac9d-571282d57782" }, { "id": "3994ba81-1772-4e52-b811-543978e9e035", "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}}/tenancies/:tenancy_id/transactions?statement=&status=&date_from=&date_to=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "transactions" ], "query": [ { "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices", "key": "statement", "value": "" }, { "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status.", "key": "status", "value": "" }, { "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_from", "value": "" }, { "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_to", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-3994ba81-1772-4e52-b811-543978e9e035" }, { "id": "8654ad7a-8b3c-430f-b347-4d1367f5ac6e", "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}}/tenancies/:tenancy_id/transactions?statement=&status=&date_from=&date_to=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "transactions" ], "query": [ { "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices", "key": "statement", "value": "" }, { "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status.", "key": "status", "value": "" }, { "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_from", "value": "" }, { "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_to", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-8654ad7a-8b3c-430f-b347-4d1367f5ac6e" }, { "id": "3cc57acc-96c4-4567-b624-c2bbbe093b19", "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}}/tenancies/:tenancy_id/transactions?statement=&status=&date_from=&date_to=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "transactions" ], "query": [ { "description": "Filters the transactions by statement. The available options are tenant , tenant-deposit , property-owner , \n property-owner-consolidated , contractor , tenancy-closing-statement , late-rents , contingency-statement , invoices", "key": "statement", "value": "" }, { "description": "The status of the transaction. The available options are paid , unpaid , partpaid , outstanding , or overdue . Use this parameter to filter transactions based on their payment status.", "key": "status", "value": "" }, { "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_from", "value": "" }, { "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "date_to", "value": "" }, { "description": "Page number, between 1 and the total number of pages.", "key": "page", "value": "" }, { "description": "Items per page, between 1 and 100.", "key": "limit", "value": "" }, { "description": "Field to sort the collection by.", "key": "sort", "value": "" }, { "description": "Sort direction.", "key": "direction", "value": "DESC" } ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-3cc57acc-96c4-4567-b624-c2bbbe093b19" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-8f2a37c3-fdbc-42d8-a3ef-08be2234ff46" } ], "id": "1b7a2fec-154b-45dc-b78a-15ba74acd4a0", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-1b7a2fec-154b-45dc-b78a-15ba74acd4a0" }, { "name": "notes", "item": [ { "name": "{note_id}", "item": [ { "name": "View Note On Tenancy", "id": "2a1cd0d2-ce1e-42c5-afcb-79e26e8b550c", "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}}/tenancies/:tenancy_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "notes", ":note_id" ], "variable": [ { "id": "bc776cf8-3f7b-49c2-be7b-934cbc242337", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." }, { "id": "f7984d8b-558f-46d0-adaa-64eec24417ce", "key": "note_id", "value": "", "description": "(Required) Arthur note id." } ] }, "description": "This API endpoint retrieves the details of a single tenancy\u00a0 note , identified by its unique\u00a0 id" }, "response": [ { "id": "8e23010f-6145-45d6-9379-92565fdd2029", "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}}/tenancies/:tenancy_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "notes", ":note_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-8e23010f-6145-45d6-9379-92565fdd2029" }, { "id": "b03d356a-cae8-44f6-a14b-21225cd58ed4", "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}}/tenancies/:tenancy_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "notes", ":note_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-b03d356a-cae8-44f6-a14b-21225cd58ed4" }, { "id": "aafb53bf-c68c-4bfa-92f1-79d7599fe38e", "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}}/tenancies/:tenancy_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "notes", ":note_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-aafb53bf-c68c-4bfa-92f1-79d7599fe38e" }, { "id": "b40d46d2-1741-4df7-bc52-bc2529032da9", "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}}/tenancies/:tenancy_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "notes", ":note_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-b40d46d2-1741-4df7-bc52-bc2529032da9" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-2a1cd0d2-ce1e-42c5-afcb-79e26e8b550c" }, { "name": "Update Note On Tenancy", "id": "cbc702a3-de57-48a9-bc28-0ef4c15c747b", "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}}/tenancies/:tenancy_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "e22788ab-c7b6-488d-a27e-378c1c684ca3", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." }, { "id": "c5248751-0091-4420-b102-7aeeb91eadf7", "key": "note_id", "value": "", "description": "(Required) Arthur note id." } ] }, "description": "This endpoint updates an existing note on a tenancy 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": "d9eaa2ef-9907-4df6-b545-f2d3722f6398", "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}}/tenancies/:tenancy_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-d9eaa2ef-9907-4df6-b545-f2d3722f6398" }, { "id": "ec77500c-6d39-4531-ae35-6dd2c2fbb40d", "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}}/tenancies/:tenancy_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-ec77500c-6d39-4531-ae35-6dd2c2fbb40d" }, { "id": "6be3e4a9-a1b3-46bd-a822-6b48df7f6449", "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}}/tenancies/:tenancy_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-6be3e4a9-a1b3-46bd-a822-6b48df7f6449" }, { "id": "c7bf79de-0464-4aba-a21f-aea134f82627", "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}}/tenancies/:tenancy_id/notes/:note_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c7bf79de-0464-4aba-a21f-aea134f82627" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-cbc702a3-de57-48a9-bc28-0ef4c15c747b" }, { "name": "Delete Note On Tenancy", "id": "3731c289-a69d-4378-b929-edfb13d2a64c", "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}}/tenancies/:tenancy_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "notes", ":note_id" ], "variable": [ { "id": "6190863c-9bbe-4dd6-a507-7ff462b7cb07", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." }, { "id": "2bac9487-2991-43a7-8995-b4a9eb2f5f66", "key": "note_id", "value": "", "description": "(Required) Arthur note id." } ] }, "description": "This endpoint deletes an existing tenancy note using the note\u00a0 id ." }, "response": [ { "id": "e1f889f1-12cb-4a67-9fb2-8d42022c5487", "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}}/tenancies/:tenancy_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "notes", ":note_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-e1f889f1-12cb-4a67-9fb2-8d42022c5487" }, { "id": "9dc36c13-cadd-497e-b181-66b510c2ca92", "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}}/tenancies/:tenancy_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "notes", ":note_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-9dc36c13-cadd-497e-b181-66b510c2ca92" }, { "id": "f75c78fc-8335-486e-a687-a4597ebd0a96", "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}}/tenancies/:tenancy_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "notes", ":note_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-f75c78fc-8335-486e-a687-a4597ebd0a96" }, { "id": "dc06a5bc-7fb1-4778-94f4-351ff292133f", "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}}/tenancies/:tenancy_id/notes/:note_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id", "notes", ":note_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-dc06a5bc-7fb1-4778-94f4-351ff292133f" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-3731c289-a69d-4378-b929-edfb13d2a64c" } ], "id": "bda2d62b-695b-4aa5-93a1-10d356b3a1e9", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-bda2d62b-695b-4aa5-93a1-10d356b3a1e9" }, { "name": "List Notes On Tenancy", "id": "07032173-84ac-4106-8a0b-99a12617c8ed", "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}}/tenancies/:tenancy_id/notes?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "93e12ecf-d9d2-4133-98da-95367e74ab5b", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This endpoint retrieves a list of\u00a0 notes \u00a0associated with the given tenancy ID." }, "response": [ { "id": "c02b534f-abc0-456b-8f56-929fae80548c", "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}}/tenancies/:tenancy_id/notes?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c02b534f-abc0-456b-8f56-929fae80548c" }, { "id": "76374bd8-b999-4e8c-bb2b-af2d8c223d9e", "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}}/tenancies/:tenancy_id/notes?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-76374bd8-b999-4e8c-bb2b-af2d8c223d9e" }, { "id": "19e2998f-9852-4df6-94ac-363e57b8bfd7", "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}}/tenancies/:tenancy_id/notes?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-19e2998f-9852-4df6-94ac-363e57b8bfd7" }, { "id": "c7c6e9e2-85a8-4684-8d20-49ca3dbf4af9", "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}}/tenancies/:tenancy_id/notes?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c7c6e9e2-85a8-4684-8d20-49ca3dbf4af9" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-07032173-84ac-4106-8a0b-99a12617c8ed" }, { "name": "Add Note On Tenancy", "id": "14faee77-5775-464e-b6aa-8bdaf06f78b4", "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}}/tenancies/:tenancy_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "36ebdbea-e2e1-43d6-9bb4-4f8edd935f57", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "Use this endpoint to create a new note record for a\u00a0 tenancy . 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": "86dfe00c-126f-4638-b8d6-deebc56f8d60", "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}}/tenancies/:tenancy_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-86dfe00c-126f-4638-b8d6-deebc56f8d60" }, { "id": "29225ff4-1e98-434d-a090-fa90ed7d5685", "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}}/tenancies/:tenancy_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-29225ff4-1e98-434d-a090-fa90ed7d5685" }, { "id": "5ae72249-0c2a-46d6-9dd0-81da0a067f1c", "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}}/tenancies/:tenancy_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-5ae72249-0c2a-46d6-9dd0-81da0a067f1c" }, { "id": "6abde2ae-0c53-4058-8b72-4bf275e4498a", "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}}/tenancies/:tenancy_id/notes?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-6abde2ae-0c53-4058-8b72-4bf275e4498a" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-14faee77-5775-464e-b6aa-8bdaf06f78b4" } ], "id": "96d0939d-d806-473a-bb34-8470f80d035f", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-96d0939d-d806-473a-bb34-8470f80d035f" }, { "name": "tags", "item": [ { "name": "List Tags on Tenancy", "id": "87e74a8b-3da3-421a-9c07-1c0c0da485b4", "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}}/tenancies/:tenancy_id/tags?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "7624fdbc-f937-44dd-beef-99850a5f87f5", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This endpoint retrieves a list of tags associated with the given Tenancy ID." }, "response": [ { "id": "cb36ace5-ec36-4675-a50e-f87de1822247", "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}}/tenancies/:tenancy_id/tags?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-cb36ace5-ec36-4675-a50e-f87de1822247" }, { "id": "bee43709-8e14-426e-8dba-b0538475a965", "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}}/tenancies/:tenancy_id/tags?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-bee43709-8e14-426e-8dba-b0538475a965" }, { "id": "a1063c88-e911-4146-9126-b9f4e8e497fc", "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}}/tenancies/:tenancy_id/tags?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a1063c88-e911-4146-9126-b9f4e8e497fc" }, { "id": "94743e23-c756-49bc-815d-a9845da29123", "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}}/tenancies/:tenancy_id/tags?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-94743e23-c756-49bc-815d-a9845da29123" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-87e74a8b-3da3-421a-9c07-1c0c0da485b4" }, { "name": "Tag Tenancy", "id": "4338dc30-0d10-4182-b889-131c3b8d91ed", "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}}/tenancies/:tenancy_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "95064e34-c763-474c-ab04-e8a860204f30", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "Use this endpoint to create a new tag record for a\u00a0 tenancy . 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": "cea8cf6e-ccf1-4bf0-a6d4-69ea2a8aa030", "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}}/tenancies/:tenancy_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-cea8cf6e-ccf1-4bf0-a6d4-69ea2a8aa030" }, { "id": "665a95de-e304-46a1-9b1c-f3b4281a4b44", "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}}/tenancies/:tenancy_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-665a95de-e304-46a1-9b1c-f3b4281a4b44" }, { "id": "da4cd48f-83c6-4a2f-9bc2-d14908395255", "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}}/tenancies/:tenancy_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-da4cd48f-83c6-4a2f-9bc2-d14908395255" }, { "id": "a3eea8d0-4115-4e78-90dc-e8e450cbad8d", "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}}/tenancies/:tenancy_id/tags?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a3eea8d0-4115-4e78-90dc-e8e450cbad8d" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-4338dc30-0d10-4182-b889-131c3b8d91ed" } ], "id": "19f780c9-c61d-47e8-bb57-d5e92f8ab175", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-19f780c9-c61d-47e8-bb57-d5e92f8ab175" }, { "name": "untag", "item": [ { "name": "Untag Tenancy", "id": "54d2da8d-f6a5-431c-9b1d-c2060559a350", "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}}/tenancies/:tenancy_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "692d6a69-68da-4fa2-8b08-4af80cdf4c3c", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "Use this endpoint to unassign tag record from a\u00a0 tenancy . 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 \"1234\" \n String \n Yes" }, "response": [ { "id": "a535f33c-5fac-45f9-add9-dd22c8e54504", "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}}/tenancies/:tenancy_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a535f33c-5fac-45f9-add9-dd22c8e54504" }, { "id": "e615edf3-a20b-48bc-b218-2aaaa5ad3c2c", "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}}/tenancies/:tenancy_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-e615edf3-a20b-48bc-b218-2aaaa5ad3c2c" }, { "id": "6b086a90-23de-4bb4-ade0-ef26cf3d18b8", "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}}/tenancies/:tenancy_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-6b086a90-23de-4bb4-ade0-ef26cf3d18b8" }, { "id": "a482bc0b-0db3-4d32-b3fb-256f87175c26", "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}}/tenancies/:tenancy_id/untag?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a482bc0b-0db3-4d32-b3fb-256f87175c26" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-54d2da8d-f6a5-431c-9b1d-c2060559a350" } ], "id": "a9146c32-2f50-4e57-a285-5e61ba688d80", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a9146c32-2f50-4e57-a285-5e61ba688d80" }, { "name": "untag_all", "item": [ { "name": "Untag All Tenancy Tags", "id": "2712067f-ccd4-4365-a8f7-3a3927f451ac", "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}}/tenancies/:tenancy_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "07c280f7-d4c4-45ba-ae24-681791cbc3c5", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "Use this endpoint to unassign all tags from the\u00a0 tenancy ." }, "response": [ { "id": "fe3385c2-2374-41af-8f45-876e4b5827a5", "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}}/tenancies/:tenancy_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-fe3385c2-2374-41af-8f45-876e4b5827a5" }, { "id": "771e6028-d889-41d0-a9c0-b3c937cff960", "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}}/tenancies/:tenancy_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-771e6028-d889-41d0-a9c0-b3c937cff960" }, { "id": "095e8588-cba2-4776-bae6-add608909eef", "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}}/tenancies/:tenancy_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-095e8588-cba2-4776-bae6-add608909eef" }, { "id": "bb61869f-585f-4a4b-93b5-a2a476a795a9", "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}}/tenancies/:tenancy_id/untag_all?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-bb61869f-585f-4a4b-93b5-a2a476a795a9" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-2712067f-ccd4-4365-a8f7-3a3927f451ac" } ], "id": "a0f7049f-387b-4a91-ae27-19658be19e8c", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a0f7049f-387b-4a91-ae27-19658be19e8c" }, { "name": "Delete Task On Tenancy", "id": "b9f178bd-e045-4d92-a3ca-b1d0734e7079", "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}}/tenancies/:tenancy_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id" ], "variable": [ { "id": "51c1c8d9-9936-4e88-82a0-2e4fc50a49bd", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This endpoint deletes an existing asset record using the task\u00a0 id , under a tenancy ID" }, "response": [ { "id": "c4d27991-02ed-4614-9e39-d0d13dcf0f46", "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}}/tenancies/:tenancy_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id" ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c4d27991-02ed-4614-9e39-d0d13dcf0f46" }, { "id": "da067eb7-910b-4d40-9b2b-18ef1c481d07", "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}}/tenancies/:tenancy_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-da067eb7-910b-4d40-9b2b-18ef1c481d07" }, { "id": "bfe35333-2007-4f54-ae3b-e901ec9654f8", "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}}/tenancies/:tenancy_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-bfe35333-2007-4f54-ae3b-e901ec9654f8" }, { "id": "37ec112b-7527-4b51-a83b-9116c3e4b570", "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}}/tenancies/:tenancy_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-37ec112b-7527-4b51-a83b-9116c3e4b570" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-b9f178bd-e045-4d92-a3ca-b1d0734e7079" }, { "name": "View Tenancy", "id": "1ce3c659-259a-480a-a73e-c42773feca2d", "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}}/tenancies/:tenancy_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id" ], "variable": [ { "id": "aa89f17a-314d-4eec-9f51-07889fd9307a", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This API endpoint retrieves the details of a single tenancy, identified by its unique\u00a0 tenancy_id .\n\nUse this endpoint to view the specific details of a tenancy." }, "response": [ { "id": "807231be-6149-42a2-bbc0-f28303bb8007", "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}}/tenancies/:tenancy_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id" ], "variable": [ { "key": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-807231be-6149-42a2-bbc0-f28303bb8007" }, { "id": "780277e1-a9c3-4638-b7d4-139e06761312", "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}}/tenancies/:tenancy_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-780277e1-a9c3-4638-b7d4-139e06761312" }, { "id": "00043f83-d7cb-42c7-aba5-1ea8d249a7fa", "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}}/tenancies/:tenancy_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-00043f83-d7cb-42c7-aba5-1ea8d249a7fa" }, { "id": "8773ec78-1ff6-4edf-aa7b-d50b9aecdc9a", "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}}/tenancies/:tenancy_id", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_id" ], "variable": [ { "key": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-8773ec78-1ff6-4edf-aa7b-d50b9aecdc9a" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-1ce3c659-259a-480a-a73e-c42773feca2d" }, { "name": "Update Tenancy", "id": "ab9f0057-6a7d-4334-ac0b-8e9fa88984d4", "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 \"tenancy_type\": \"\",\n \"letting_agent_id\": \"\",\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"break_clause_date\": \"\",\n \"fixed_break_date\": \"\",\n \"rolling_break_date\": \"\",\n \"notice_period\": \"\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"\",\n \"move_in_time\": \"\",\n \"move_out_date\": \"\",\n \"move_out_time\": \"\",\n \"rent_amount\": \"\",\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}}/tenancies/:tenancy_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "0161dac8-7e93-4aa0-a540-770c06ba9cf6", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." } ] }, "description": "This endpoint updates an existing tenancy using the same fields as the 'Add Tenancy' endpoint excluding the\u00a0 unit_id . Any fields that are not provided will not be changed. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nstatus \n Current \n Integer \n No \n\ntenancy_type \n Commercial \n Integer \n No \n\nletting_agent_id \n 90909 \n Integer \n No \n\ncontract_type \n Company \n String \n No \n\nrenter_company \n Renter Ltd. \n String \n No \n\nstart_date \n 2019-01-01 \n Date \n No \n\nend_date \n 2020-01-01 \n Date \n No \n\nbreak_clause_date \n 2019-06-01 \n Date \n No \n\nfixed_break_date \n 2019-06-01 \n Date \n No \n\nrolling_break_date \n 2019-09-18 \n Date \n No \n\nnotice_period \n 2 months \n String \n No \n\nissue_break_clause_to \n landlord \n String \n No \n\nmove_in_date \n 2019-01-01 \n Date \n No \n\nmove_in_time \n 12:00 \n Time \n No \n\nmove_out_date \n 2020-01-01 \n Date \n No \n\nmove_out_time \n 12:00 \n Time \n No \n\nrent_amount \n 875 \n Float \n No \n\nrent_frequency \n Monthly \n String \n No \n\ndeposit_held_by \n DPS \n String \n No \n\nrent_payment_bank_id \n 1423 \n Integer \n No \n\ndeposit_payment_bank_id \n 4132 \n Integer \n No \n\ndefault_rent_payment_method \n Bank Transfer \n String \n No \n\nrent_insured \n false \n Boolean \n No \n\ntags \n [\"12 month contract\"] \n Array (String) \n No" }, "response": [ { "id": "56c876dd-a66b-4284-9d72-68c63ef64565", "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 \"tenancy_type\": \"\",\n \"letting_agent_id\": \"\",\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"break_clause_date\": \"\",\n \"fixed_break_date\": \"\",\n \"rolling_break_date\": \"\",\n \"notice_period\": \"\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"\",\n \"move_in_time\": \"\",\n \"move_out_date\": \"\",\n \"move_out_time\": \"\",\n \"rent_amount\": \"\",\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}}/tenancies/:tenancy_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-56c876dd-a66b-4284-9d72-68c63ef64565" }, { "id": "50e48b49-7614-4a83-a392-c5234a40a3ed", "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 \"tenancy_type\": \"\",\n \"letting_agent_id\": \"\",\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"break_clause_date\": \"\",\n \"fixed_break_date\": \"\",\n \"rolling_break_date\": \"\",\n \"notice_period\": \"\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"\",\n \"move_in_time\": \"\",\n \"move_out_date\": \"\",\n \"move_out_time\": \"\",\n \"rent_amount\": \"\",\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}}/tenancies/:tenancy_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-50e48b49-7614-4a83-a392-c5234a40a3ed" }, { "id": "f6556331-1c62-42ca-94a8-8e08d0b60989", "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 \"tenancy_type\": \"\",\n \"letting_agent_id\": \"\",\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"break_clause_date\": \"\",\n \"fixed_break_date\": \"\",\n \"rolling_break_date\": \"\",\n \"notice_period\": \"\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"\",\n \"move_in_time\": \"\",\n \"move_out_date\": \"\",\n \"move_out_time\": \"\",\n \"rent_amount\": \"\",\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}}/tenancies/:tenancy_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-f6556331-1c62-42ca-94a8-8e08d0b60989" }, { "id": "cd33f5e2-051f-49a9-930f-057c4fe019e5", "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 \"tenancy_type\": \"\",\n \"letting_agent_id\": \"\",\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"break_clause_date\": \"\",\n \"fixed_break_date\": \"\",\n \"rolling_break_date\": \"\",\n \"notice_period\": \"\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"\",\n \"move_in_time\": \"\",\n \"move_out_date\": \"\",\n \"move_out_time\": \"\",\n \"rent_amount\": \"\",\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}}/tenancies/:tenancy_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancy_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": "tenancy_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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-cd33f5e2-051f-49a9-930f-057c4fe019e5" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-ab9f0057-6a7d-4334-ac0b-8e9fa88984d4" } ], "id": "e1197450-8dc8-43a1-bb24-f4d96355ff88", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-e1197450-8dc8-43a1-bb24-f4d96355ff88" }, { "name": "{id}", "item": [ { "name": "register_deposit", "item": [ { "name": "Register Deposit on Tenancy", "id": "92e1af63-9800-4fb6-926f-5bc682cb950e", "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}}/tenancies/:id/register_deposit", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":id", "register_deposit" ], "variable": [ { "id": "d9772733-a236-4200-9782-ba419ddb6fe5", "key": "id" } ] }, "description": "This endpoint retrieves the registered deposit associated with the given tenancy ID." }, "response": [ { "id": "8352403b-aacb-4f11-b8eb-cf3cbfe9c032", "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}}/tenancies/:id/register_deposit", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":id", "register_deposit" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"data\": {}\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-8352403b-aacb-4f11-b8eb-cf3cbfe9c032" }, { "id": "a52f2405-e296-465a-a321-c972add00e16", "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}}/tenancies/:id/register_deposit", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":id", "register_deposit" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a52f2405-e296-465a-a321-c972add00e16" }, { "id": "68446e44-c210-4585-9357-b2df32654615", "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}}/tenancies/:id/register_deposit", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":id", "register_deposit" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-68446e44-c210-4585-9357-b2df32654615" }, { "id": "54b93025-f74d-4368-89e6-4356e5c181ed", "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}}/tenancies/:id/register_deposit", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":id", "register_deposit" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-54b93025-f74d-4368-89e6-4356e5c181ed" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-92e1af63-9800-4fb6-926f-5bc682cb950e" }, { "name": "Update Deposit on Tenancy", "id": "d590250e-9f42-4d7a-ba6d-915cba1f8732", "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 \"deposit_registered_not_needed\": \"\",\n \"date_registered\": \"\",\n \"certificate_no\": \"\",\n \"deposit_scheme\": \"\",\n \"deposit_held_by\": \"\",\n \"deposit_required\": \"\",\n \"deposit_registered\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:id/register_deposit?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":id", "register_deposit" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "916475ec-12dc-40fc-8260-2e7acf954b56", "key": "id" } ] }, "description": "Use this endpoint to update the registered deposit related to a tenancy . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ndeposit_registered_not_needed \n true \n Boolean \n No \n\ndate_registered \n 2023-12-05 \n String \n No \n\ncertificate_no \n ABC \n String \n No \n\ndeposit_scheme \n Base64 \n String \n No \n\ndeposit_held_by \n TDS \n String \n No \n\ndeposit_required \n 1200 \n string \n No \n\ndeposit_registered \n true \n Boolean \n No \n\nThe \"deposit_scheme\" field is required to have one of the following values:\n\nTenancy Deposit Scheme (TDS) \n Deposit Protection Service (DPS) \n MyDeposits \n Letting Protection Scotland \n Safe Deposits Scotland \n My Deposits Scotland \n Reposit \n N/A" }, "response": [ { "id": "b1434a67-1d82-4fba-b35c-ac0e51449d8f", "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 \"deposit_registered_not_needed\": \"\",\n \"date_registered\": \"\",\n \"certificate_no\": \"\",\n \"deposit_scheme\": \"\",\n \"deposit_held_by\": \"\",\n \"deposit_required\": \"\",\n \"deposit_registered\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:id/register_deposit?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":id", "register_deposit" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"data\": {}\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-b1434a67-1d82-4fba-b35c-ac0e51449d8f" }, { "id": "e7fdc43b-78eb-44dd-8017-8cb3e0d664b1", "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 \"deposit_registered_not_needed\": \"\",\n \"date_registered\": \"\",\n \"certificate_no\": \"\",\n \"deposit_scheme\": \"\",\n \"deposit_held_by\": \"\",\n \"deposit_required\": \"\",\n \"deposit_registered\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:id/register_deposit?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":id", "register_deposit" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-e7fdc43b-78eb-44dd-8017-8cb3e0d664b1" }, { "id": "752a90c6-3236-4836-b8dc-63f2ecf780bc", "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 \"deposit_registered_not_needed\": \"\",\n \"date_registered\": \"\",\n \"certificate_no\": \"\",\n \"deposit_scheme\": \"\",\n \"deposit_held_by\": \"\",\n \"deposit_required\": \"\",\n \"deposit_registered\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:id/register_deposit?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":id", "register_deposit" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-752a90c6-3236-4836-b8dc-63f2ecf780bc" }, { "id": "55bd5748-61b5-4d68-80b7-78e91ae86107", "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 \"deposit_registered_not_needed\": \"\",\n \"date_registered\": \"\",\n \"certificate_no\": \"\",\n \"deposit_scheme\": \"\",\n \"deposit_held_by\": \"\",\n \"deposit_required\": \"\",\n \"deposit_registered\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancies/:id/register_deposit?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":id", "register_deposit" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-55bd5748-61b5-4d68-80b7-78e91ae86107" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-d590250e-9f42-4d7a-ba6d-915cba1f8732" } ], "id": "1f69fb0d-337e-49cb-8218-25ecb65e1d6a", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-1f69fb0d-337e-49cb-8218-25ecb65e1d6a" } ], "id": "f8f2741e-4177-426e-8afe-00fa0851ec3d", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-f8f2741e-4177-426e-8afe-00fa0851ec3d" }, { "name": "{tenancyId}", "item": [ { "name": "recurrings", "item": [ { "name": "List Recurrings", "id": "665748de-0bd0-4808-9877-d10e87321341", "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}}/tenancies/:tenancyId/recurrings?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancyId", "recurrings" ], "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": "bcdd9daf-a6d5-4f37-b97a-e48f244ab661", "key": "tenancyId", "value": "", "description": "(Required) Arthur tenancyId." } ] }, "description": "This endpoint retrieves a list of recurrings associated to a specific tenancy" }, "response": [ { "id": "a6ee114f-1e4b-4b6e-9a69-bebddb25443e", "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}}/tenancies/:tenancyId/recurrings?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancyId", "recurrings" ], "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": "tenancyId" } ] } }, "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a6ee114f-1e4b-4b6e-9a69-bebddb25443e" }, { "id": "fa32499e-e28b-41b7-afad-8fc14ec0f3a6", "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}}/tenancies/:tenancyId/recurrings?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancyId", "recurrings" ], "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": "tenancyId" } ] } }, "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-fa32499e-e28b-41b7-afad-8fc14ec0f3a6" }, { "id": "6a314580-e157-4a3f-8114-717d39bc01ac", "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}}/tenancies/:tenancyId/recurrings?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancyId", "recurrings" ], "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": "tenancyId" } ] } }, "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-6a314580-e157-4a3f-8114-717d39bc01ac" }, { "id": "5af14566-c7f7-4f57-b12f-62bd75161ce7", "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}}/tenancies/:tenancyId/recurrings?page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies", ":tenancyId", "recurrings" ], "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": "tenancyId" } ] } }, "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-5af14566-c7f7-4f57-b12f-62bd75161ce7" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-665748de-0bd0-4808-9877-d10e87321341" } ], "id": "72ede5cd-b419-4f14-8d4f-a7a1279c3511", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-72ede5cd-b419-4f14-8d4f-a7a1279c3511" } ], "id": "4aeb399a-8735-4af1-971d-891b4f609722", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-4aeb399a-8735-4af1-971d-891b4f609722" }, { "name": "List Tenancies", "id": "d2dce576-e2a8-4c02-8c21-2652f51ba5c2", "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}}/tenancies?assigned_to=&tags=&moveInDate=&moveOutDate=&modified=&modifiedFrom=&modifiedTo=&status=&full_address=&tenancy_type=&tenancy_sub_type=&unit_owner_id=&letting_agent_id=&start_date=&end_date=&_q=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies" ], "query": [ { "description": "Filter by unit manager ID", "key": "assigned_to", "value": "" }, { "description": "Filter by tags associated with the tenancy, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filter by tenancies move in date. Use the format yyyy-mm-dd to input the date", "key": "moveInDate", "value": "" }, { "description": "Filter by tenancy move out date. Use the format yyyy-mm-dd to input the date", "key": "moveOutDate", "value": "" }, { "description": "Filter by the last modified date. Use the format yyyy-mm-dd to input the date", "key": "modified", "value": "" }, { "description": "Filters tenancies by the modified date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "modifiedFrom", "value": "" }, { "description": "Filters tenancies by the modified date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "modifiedTo", "value": "" }, { "description": "Filter by the tenancy status", "key": "status", "value": "" }, { "description": "Filter by the full address of the property", "key": "full_address", "value": "" }, { "description": "Filter by the tenancy type", "key": "tenancy_type", "value": "" }, { "description": "Filter by the tenancy sub type", "key": "tenancy_sub_type", "value": "" }, { "description": "Filer by the landlord ID", "key": "unit_owner_id", "value": "" }, { "description": "Filter by the letting agent ID", "key": "letting_agent_id", "value": "" }, { "description": "Filter by start date", "key": "start_date", "value": "" }, { "description": "Filter by end date", "key": "end_date", "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 retrieves a list of tenancies.\n\nSee available filters below to customize the list of tenants returned." }, "response": [ { "id": "38e97ec6-6ce7-429b-a036-deee232f3a9d", "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}}/tenancies?assigned_to=&tags=&moveInDate=&moveOutDate=&modified=&modifiedFrom=&modifiedTo=&status=&full_address=&tenancy_type=&tenancy_sub_type=&unit_owner_id=&letting_agent_id=&start_date=&end_date=&_q=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies" ], "query": [ { "description": "Filter by unit manager ID", "key": "assigned_to", "value": "" }, { "description": "Filter by tags associated with the tenancy, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filter by tenancies move in date. Use the format yyyy-mm-dd to input the date", "key": "moveInDate", "value": "" }, { "description": "Filter by tenancy move out date. Use the format yyyy-mm-dd to input the date", "key": "moveOutDate", "value": "" }, { "description": "Filter by the last modified date. Use the format yyyy-mm-dd to input the date", "key": "modified", "value": "" }, { "description": "Filters tenancies by the modified date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "modifiedFrom", "value": "" }, { "description": "Filters tenancies by the modified date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "modifiedTo", "value": "" }, { "description": "Filter by the tenancy status", "key": "status", "value": "" }, { "description": "Filter by the full address of the property", "key": "full_address", "value": "" }, { "description": "Filter by the tenancy type", "key": "tenancy_type", "value": "" }, { "description": "Filter by the tenancy sub type", "key": "tenancy_sub_type", "value": "" }, { "description": "Filer by the landlord ID", "key": "unit_owner_id", "value": "" }, { "description": "Filter by the letting agent ID", "key": "letting_agent_id", "value": "" }, { "description": "Filter by start date", "key": "start_date", "value": "" }, { "description": "Filter by end date", "key": "end_date", "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-38e97ec6-6ce7-429b-a036-deee232f3a9d" }, { "id": "13a34502-6789-47d4-8e50-f54c448f6268", "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}}/tenancies?assigned_to=&tags=&moveInDate=&moveOutDate=&modified=&modifiedFrom=&modifiedTo=&status=&full_address=&tenancy_type=&tenancy_sub_type=&unit_owner_id=&letting_agent_id=&start_date=&end_date=&_q=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies" ], "query": [ { "description": "Filter by unit manager ID", "key": "assigned_to", "value": "" }, { "description": "Filter by tags associated with the tenancy, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filter by tenancies move in date. Use the format yyyy-mm-dd to input the date", "key": "moveInDate", "value": "" }, { "description": "Filter by tenancy move out date. Use the format yyyy-mm-dd to input the date", "key": "moveOutDate", "value": "" }, { "description": "Filter by the last modified date. Use the format yyyy-mm-dd to input the date", "key": "modified", "value": "" }, { "description": "Filters tenancies by the modified date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "modifiedFrom", "value": "" }, { "description": "Filters tenancies by the modified date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "modifiedTo", "value": "" }, { "description": "Filter by the tenancy status", "key": "status", "value": "" }, { "description": "Filter by the full address of the property", "key": "full_address", "value": "" }, { "description": "Filter by the tenancy type", "key": "tenancy_type", "value": "" }, { "description": "Filter by the tenancy sub type", "key": "tenancy_sub_type", "value": "" }, { "description": "Filer by the landlord ID", "key": "unit_owner_id", "value": "" }, { "description": "Filter by the letting agent ID", "key": "letting_agent_id", "value": "" }, { "description": "Filter by start date", "key": "start_date", "value": "" }, { "description": "Filter by end date", "key": "end_date", "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-13a34502-6789-47d4-8e50-f54c448f6268" }, { "id": "fae5ddcc-dba6-49d7-9cd2-aef1bfea5f77", "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}}/tenancies?assigned_to=&tags=&moveInDate=&moveOutDate=&modified=&modifiedFrom=&modifiedTo=&status=&full_address=&tenancy_type=&tenancy_sub_type=&unit_owner_id=&letting_agent_id=&start_date=&end_date=&_q=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies" ], "query": [ { "description": "Filter by unit manager ID", "key": "assigned_to", "value": "" }, { "description": "Filter by tags associated with the tenancy, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filter by tenancies move in date. Use the format yyyy-mm-dd to input the date", "key": "moveInDate", "value": "" }, { "description": "Filter by tenancy move out date. Use the format yyyy-mm-dd to input the date", "key": "moveOutDate", "value": "" }, { "description": "Filter by the last modified date. Use the format yyyy-mm-dd to input the date", "key": "modified", "value": "" }, { "description": "Filters tenancies by the modified date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "modifiedFrom", "value": "" }, { "description": "Filters tenancies by the modified date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "modifiedTo", "value": "" }, { "description": "Filter by the tenancy status", "key": "status", "value": "" }, { "description": "Filter by the full address of the property", "key": "full_address", "value": "" }, { "description": "Filter by the tenancy type", "key": "tenancy_type", "value": "" }, { "description": "Filter by the tenancy sub type", "key": "tenancy_sub_type", "value": "" }, { "description": "Filer by the landlord ID", "key": "unit_owner_id", "value": "" }, { "description": "Filter by the letting agent ID", "key": "letting_agent_id", "value": "" }, { "description": "Filter by start date", "key": "start_date", "value": "" }, { "description": "Filter by end date", "key": "end_date", "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-fae5ddcc-dba6-49d7-9cd2-aef1bfea5f77" }, { "id": "2869aeeb-402b-4485-abcc-f79797a85f3c", "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}}/tenancies?assigned_to=&tags=&moveInDate=&moveOutDate=&modified=&modifiedFrom=&modifiedTo=&status=&full_address=&tenancy_type=&tenancy_sub_type=&unit_owner_id=&letting_agent_id=&start_date=&end_date=&_q=&page=&limit=&sort=&direction=DESC", "host": [ "{{baseUrl}}" ], "path": [ "tenancies" ], "query": [ { "description": "Filter by unit manager ID", "key": "assigned_to", "value": "" }, { "description": "Filter by tags associated with the tenancy, which should be provided as a comma-separated list", "key": "tags", "value": "" }, { "description": "Filter by tenancies move in date. Use the format yyyy-mm-dd to input the date", "key": "moveInDate", "value": "" }, { "description": "Filter by tenancy move out date. Use the format yyyy-mm-dd to input the date", "key": "moveOutDate", "value": "" }, { "description": "Filter by the last modified date. Use the format yyyy-mm-dd to input the date", "key": "modified", "value": "" }, { "description": "Filters tenancies by the modified date, starting from the specified date. Use the format yyyy-mm-dd to input the date.", "key": "modifiedFrom", "value": "" }, { "description": "Filters tenancies by the modified date, up to the specified date. Use the format yyyy-mm-dd to input the date.", "key": "modifiedTo", "value": "" }, { "description": "Filter by the tenancy status", "key": "status", "value": "" }, { "description": "Filter by the full address of the property", "key": "full_address", "value": "" }, { "description": "Filter by the tenancy type", "key": "tenancy_type", "value": "" }, { "description": "Filter by the tenancy sub type", "key": "tenancy_sub_type", "value": "" }, { "description": "Filer by the landlord ID", "key": "unit_owner_id", "value": "" }, { "description": "Filter by the letting agent ID", "key": "letting_agent_id", "value": "" }, { "description": "Filter by start date", "key": "start_date", "value": "" }, { "description": "Filter by end date", "key": "end_date", "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-2869aeeb-402b-4485-abcc-f79797a85f3c" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-d2dce576-e2a8-4c02-8c21-2652f51ba5c2" }, { "name": "Add Tenancy", "id": "85052c51-e068-4feb-bb85-4e31915f14aa", "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 \"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}}/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ] }, "description": "Use this endpoint to create a new tenancy record. 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\nunit_id \n 12345 \n Integer \n\nYes \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": "ef4223c2-3cb9-4634-88bd-4e0a5f340044", "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 \"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}}/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-ef4223c2-3cb9-4634-88bd-4e0a5f340044" }, { "id": "a58a2ef2-ae1d-49e6-b88d-7ea6c601d24c", "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 \"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}}/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a58a2ef2-ae1d-49e6-b88d-7ea6c601d24c" }, { "id": "de7add2b-81aa-4f80-b75b-2d7a5b6b33df", "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 \"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}}/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-de7add2b-81aa-4f80-b75b-2d7a5b6b33df" }, { "id": "fb1a05e8-4af1-4718-9ea7-db6c2a203ff8", "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 \"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}}/tenancies?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancies" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-fb1a05e8-4af1-4718-9ea7-db6c2a203ff8" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-85052c51-e068-4feb-bb85-4e31915f14aa" } ], "id": "258c6764-f102-400e-925d-78afdb7a3ab2", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-258c6764-f102-400e-925d-78afdb7a3ab2" }, { "name": "tenancy", "item": [ { "name": "{tenancy_id}", "item": [ { "name": "workorders", "item": [ { "name": "{workorder_id}", "item": [ { "name": "Update Workorder On Tenancy", "id": "f65f29be-3a0c-4470-95c6-5da9c656d27d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"service_type\": \"\",\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancy/:tenancy_id/workorders/:workorder_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancy", ":tenancy_id", "workorders", ":workorder_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "id": "4166ef0f-912c-457b-b05a-638381dcf544", "key": "tenancy_id", "value": "", "description": "(Required) Arthur tenancy id." }, { "id": "5007b885-7ed3-4826-8527-11782945071d", "key": "workorder_id", "value": "", "description": "(Required) Arthur workorder id." } ] }, "description": "This endpoint updates an existing workorder using the same fields as the 'Add Workorder' endpoint. The API will return the updated data for the tenancy in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n No \n\nstart_date \n 2020-02-20 \n Date \n No \n\ndue_date \n 2020-02-20 \n Date \n No \n\nbudget \n 1000,00 \n Float \n No \n\nallocated_time_hours \n 20 \n Float \n No \n\nactual_time_hours \n 20 \n Float \n No \n\nprice_per_hour \n 7,90 \n Float \n No \n\nemergency \n true \n Boolean \n No \n\nquote_required \n true \n Boolean \n No \n\nshare_assets \n false \n Boolean \n No \n\nhide_tenant_details \n true \n Boolean \n No" }, "response": [ { "id": "80425be5-2d39-4565-90a4-16824fcdb931", "name": "The request was completed successfully without errors.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"service_type\": \"\",\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancy/:tenancy_id/workorders/:workorder_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancy", ":tenancy_id", "workorders", ":workorder_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" }, { "key": "workorder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-80425be5-2d39-4565-90a4-16824fcdb931" }, { "id": "996236b8-ac31-4a48-a8eb-7f85a912dbe4", "name": "The request was invalid or malformed.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"service_type\": \"\",\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancy/:tenancy_id/workorders/:workorder_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancy", ":tenancy_id", "workorders", ":workorder_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" }, { "key": "workorder_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-996236b8-ac31-4a48-a8eb-7f85a912dbe4" }, { "id": "3f2ce58c-236a-46a5-8d05-479d3ea60b3b", "name": "Missing, invalid or expired access token.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"service_type\": \"\",\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancy/:tenancy_id/workorders/:workorder_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancy", ":tenancy_id", "workorders", ":workorder_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" }, { "key": "workorder_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-3f2ce58c-236a-46a5-8d05-479d3ea60b3b" }, { "id": "1c70e041-60c8-47bf-b88b-684dd31ea5b1", "name": "The request was sent to a location that does not exist in the API.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Arthur entity (account) the request is scoped to. Mandatory on every API call.", "key": "X-EntityID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"invite_contractors\": [\n \"\",\n \"\"\n ],\n \"service_type\": \"\",\n \"start_date\": \"\",\n \"due_date\": \"\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"\",\n \"emergency\": \"\",\n \"quote_required\": \"\",\n \"share_assets\": \"\",\n \"hide_tenant_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tenancy/:tenancy_id/workorders/:workorder_id?strict=", "host": [ "{{baseUrl}}" ], "path": [ "tenancy", ":tenancy_id", "workorders", ":workorder_id" ], "query": [ { "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only.", "key": "strict", "value": "" } ], "variable": [ { "key": "tenancy_id" }, { "key": "workorder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-1c70e041-60c8-47bf-b88b-684dd31ea5b1" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-f65f29be-3a0c-4470-95c6-5da9c656d27d" } ], "id": "fdd501a0-23b9-4fe4-b682-1fa4260bfe5e", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-fdd501a0-23b9-4fe4-b682-1fa4260bfe5e" } ], "id": "aaffbb2d-b278-47ca-b8f1-afce6c87cbd0", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-aaffbb2d-b278-47ca-b8f1-afce6c87cbd0" } ], "id": "a2b10a34-29d7-4689-85b4-606988f09eaa", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a2b10a34-29d7-4689-85b4-606988f09eaa" } ], "id": "a9a1919f-d96d-4849-a070-bc2876c0a94d", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a9a1919f-d96d-4849-a070-bc2876c0a94d" }, { "name": "viewings", "item": [ { "name": "{viewing_id}", "item": [ { "name": "conversations", "item": [ { "name": "Create Conversation On Tenancy", "id": "7aaaab62-596d-4ac0-ad39-1fa5ddc94b33", "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": "9ec33b39-6b52-4d51-be7f-c568fc679a86", "key": "viewing_id", "value": "", "description": "(Required) Arthur viewing id." } ] }, "description": "Use this endpoint to create a new conversation on a tenancy 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": "a226d72e-622f-4752-adcd-0b1af6f215d5", "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-a226d72e-622f-4752-adcd-0b1af6f215d5" }, { "id": "c1501906-7c7f-4f16-a5d1-9941a3d85914", "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-c1501906-7c7f-4f16-a5d1-9941a3d85914" }, { "id": "1d2d78c3-74fd-4159-b997-efdb11fad891", "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-1d2d78c3-74fd-4159-b997-efdb11fad891" }, { "id": "f289f90a-7663-4c56-a77b-b9a625731884", "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:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-f289f90a-7663-4c56-a77b-b9a625731884" } ], "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-7aaaab62-596d-4ac0-ad39-1fa5ddc94b33" } ], "id": "887629a3-bce7-45f2-86a0-6b67b572a32d", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-887629a3-bce7-45f2-86a0-6b67b572a32d" } ], "id": "b4a697a7-395f-458e-b67e-ee4f1844b09d", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-b4a697a7-395f-458e-b67e-ee4f1844b09d" } ], "id": "4e0fa222-6902-4935-a829-8335b2d735eb", "createdAt": "2026-07-28T01:05:01.000Z", "updatedAt": "2026-07-28T01:05:01.000Z", "uid": "35240-4e0fa222-6902-4935-a829-8335b2d735eb" } ], "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" } ] }