{ "opencollection": "1.0.0", "info": { "name": "Arthur Units API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.arthuronline.co.uk/oauth/authorize", "accessTokenUrl": "https://auth.arthuronline.co.uk/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Property", "type": "folder" }, "items": [ { "info": { "name": "View parent Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/property", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." } ] }, "docs": "This endpoint retrieves the property associated with the given unit ID." } ] }, { "info": { "name": "Assets", "type": "folder" }, "items": [ { "info": { "name": "List Assets On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/assets", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of assets associated with the given unit ID." }, { "info": { "name": "Create Asset On Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/assets", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new asset related to a unit . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nasset_type \n image \n String \n No \n\nname \n inventory \n String \n No \n\nshare_manager \n true \n Boolean \n No \n\nshare_tenant \n false \n Boolean \n No \n\nshare_contractor \n true \n Boolean \n No \n\nshare_owner \n true \n Boolean \n No \n\nfile \n base64 \n String \n Yes \n\nmime_type \n application/pdf \n String \n" } ] }, { "info": { "name": "Certificates", "type": "folder" }, "items": [ { "info": { "name": "List Certificates On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/certificates", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of certificates associated with the given unit ID." }, { "info": { "name": "Add Certificate on Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/certificates", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new certificate related to a  property . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntype \n Boiler Service \n String \n Yes \n\nexpiry_date \n 2023-12-05 \n String \n No \n\nnotes \n Fully assessed \n String \n No \n\nfile \n Base64 \n String \n No \n\nmime_type \n application/pdf \n String \n No (Required if File field is present) \n\nfile_name \n Certificate Document \n string \n No (Re" } ] }, { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "Get Recipients for Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/conversation_recipients", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." } ] }, "docs": "This endpoint retrieves a list of conversation recipients on a unit record, identified by its unique  unit_id ." }, { "info": { "name": "List Conversation On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/conversations", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of conversations associated with the given unit ID." }, { "info": { "name": "Create Conversation On Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/conversations", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new conversation related to a unit . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nmessage \n It's done \n String \n Yes \n\nsubject \n Meeting tomorrow \n String \n Yes \n\nperson_ids \n ['1','2'] \n Array(String) \n Yes" } ] }, { "info": { "name": "General Information", "type": "folder" }, "items": [ { "info": { "name": "List General Info for Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/faqs", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of general information records associated with the given unit ID." }, { "info": { "name": "Add General Info for Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/faqs", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new general information record for the unit . The API will return the saved data and a unique general information ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n\ntitle \n Maintenance \n String \n\ndescription \n Weekly clean \n String \n\nfaq_type \n General \n String \n\nshare_owner \n true \n Boolean \n\nshare_tenant \n true \n Boolean \n\nshare_contractor \n false \n Boolean" } ] }, { "info": { "name": "Notes", "type": "folder" }, "items": [ { "info": { "name": "List Notes On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/notes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of  notes  associated with the given unit ID." }, { "info": { "name": "Add Note On Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/notes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new note record for the unit . The API will return the saved data and a unique note ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n Yes" }, { "info": { "name": "View Note On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." } ] }, "docs": "This API endpoint retrieves the details of a single  note , identified by its unique  id ." }, { "info": { "name": "Update Note On Unit", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing note using the same fields as the 'Add Note' endpoint. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ncontent \n Moving away \n String \n No \n\ntags \n ['one','two'] \n Array(String) \n No" }, { "info": { "name": "Delete Note On Unit", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." } ] }, "docs": "This endpoint deletes an existing note using the note  id ." } ] }, { "info": { "name": "Viewings", "type": "folder" }, "items": [ { "info": { "name": "List Viewings on Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/viewings", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "status", "value": "", "type": "query", "description": "Filter the viewings by status." }, { "name": "assignedTo", "value": "", "type": "query", "description": "Filter the viewings by assigned to ID." }, { "name": "viewingDate", "value": "", "type": "query", "description": "Filter the viewings by the date." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of viewings associated with the given unit ID." }, { "info": { "name": "Add Viewing on Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/viewings", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "true", "type": "query", "description": "Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new viewing record for the  unit . The API will return the saved data and a unique viewing ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Default \n Required? \n\napplicant_id \n 123 \n Integer \n\nYes \n\nviewing_date \n 2019-05-28 \n Date \n\nNo \n\nviewing_time \n 00:00 \n Time \n\nNo \n\noffer_amount \n 250.00 \n Float \n\nNo \n\noffer_frequency \n Week \n Enum \n Month \n No \n\nmove_in_date \n 2019-07-01 \n Date \n\nNo \n\nassigned_to_ids \n" } ] }, { "info": { "name": "Tenancies", "type": "folder" }, "items": [ { "info": { "name": "List Tenancies on Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/tenancies", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of tenancies associated with the given unit ID." }, { "info": { "name": "Add Tenancy On Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/tenancies", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new tenancy record for the  unit . The API will return the saved data and a unique tenancy ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Default \n Required? \n\nstatus \n Current \n Integer \n Prospective \n No \n\ntenancy_type \n Commercial \n Integer \n Residential \n No \n\nletting_agent_id \n 90909 \n Integer \n\nNo \n\ncontract_type \n Company \n String \n\nNo \n\nrenter_company \n Renter Ltd. \n String \n\nNo \n\nstart_date \n 2019-0" } ] }, { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "List Tasks On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/tasks", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of tasks associated with the given unit ID." }, { "info": { "name": "Add Task On Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/tasks", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new task record for the unit . The API will return the saved data and a unique task ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntask_type \n Inspection \n String \n No \n\ndescription \n Radiator not working \n String \n Yes \n\ntags \n ['one','two'] \n Array(String) \n No \n\ndue_date \n 2020-10-11 \n Date \n No \n\ndue_time \n 15:32 \n Time \n No \n\nassigned_managers \n [123,1234] \n Array(Integer) \n No \n\nemergency \n" }, { "info": { "name": "View Task On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." } ] }, "docs": "This API endpoint retrieves the details of a single unit  task , identified by its unique  id ." }, { "info": { "name": "Update Task On Unit", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing task using the same fields as the 'Add Task' endpoint. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntask_type \n Inspection \n String \n No \n\ndescription \n Radiator not working \n String \n No \n\ntags \n ['one','two'] \n Array(String) \n No \n\ndue_date \n 2020-10-11 \n Date \n No \n\ndue_time \n 15:32 \n Time \n No \n\nassigned_managers \n [123,1234" }, { "info": { "name": "Delete Task On Unit", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." } ] }, "docs": "This endpoint deletes an existing asset record using the task  id , under a unit ID" } ] }, { "info": { "name": "Workorders", "type": "folder" }, "items": [ { "info": { "name": "List Workorders On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/workorders", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of workorders associated with the given unit ID." }, { "info": { "name": "Create Workorders On Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/workorders", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new workorder record for the unit . The API will return the saved data and a unique workorder ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n Yes \n\nstart_date \n 2020-02-20 \n Date \n No \n\ndue_date \n 2020-02-20 \n Dat" }, { "info": { "name": "View Workorders On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/workorders/:workorder_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." } ] }, "docs": "This API endpoint retrieves the details of a single unit  workorder , identified by its unique  id ." }, { "info": { "name": "Update Workorders On Unit", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/workorders/:workorder_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing workorder using the same fields as the 'Add Workorder' endpoint. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntitle \n workorder title \n String \n No \n\ndescription \n workorder description \n String \n No \n\ninvite_contractors \n [123,1234] \n Array(integer) \n No \n\nservice_type \n Carpet Layer \n String \n No \n\nstart_date \n 2020-02-20 \n Da" } ] }, { "info": { "name": "Utilities", "type": "folder" }, "items": [ { "info": { "name": "List Utilities On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/utilities", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of utilities associated with the given unit ID." }, { "info": { "name": "Create Utility On Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/utilities", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new utility record for the unit . The API will return the saved data and a unique utility ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntype \n gas \n String \n Yes \n\nnotes \n behind back doors \n String \n No \n\nserial_number \n GA212FP21 \n String \n No \n\naccount_number \n 12344321 \n string \n No \n\nprovider \n company_name \n string \n No" } ] }, { "info": { "name": "Transactions", "type": "folder" }, "items": [ { "info": { "name": "List Transactions On Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/transactions", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "statement", "value": "", "type": "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" }, { "name": "status", "value": "", "type": "query", "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." }, { "name": "date_from", "value": "", "type": "query", "description": "Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date." }, { "name": "date_to", "value": "", "type": "query", "description": "Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of transactions for a Unit \n\nSee available filters below to customize the list of transactions returned." } ] }, { "info": { "name": "Tags", "type": "folder" }, "items": [ { "info": { "name": "Get Tags on Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:id/tags", "headers": [ { "name": "X-EntityID", "value": "" } ] }, "docs": "This endpoint retrieves a list of tags associated with the given unit ID." }, { "info": { "name": "Tag Unit", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/tags", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new tag record for the unit . The API will return the saved data and a unique tag ID.\n\nSupported Fields \n The following fields are supported for the request body\nTag field should be a valid tag ID or name.\n\nField \n Example \n Type \n Default \n Required? \n\ntag \n [\"123\"] \n Array(String) \n\nYes" }, { "info": { "name": "Untag Unit", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/untag", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to unassign tag record from the  unit . The API will return the saved data and a unique workorder ID. Tag field should be a valid tag ID or name.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntag \n 123 \n String \n Yes" }, { "info": { "name": "Untag All Unit Tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id/untag_all", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ] }, "docs": "Use this endpoint to unassign all tags from the  unit ." } ] }, { "info": { "name": "Units", "type": "folder" }, "items": [ { "info": { "name": "List Units", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_ref", "value": "", "type": "query", "description": "Filter by the address name of the unit" }, { "name": "address_line_1", "value": "", "type": "query", "description": "Filter by the address 1 field of the unit" }, { "name": "address_line_2", "value": "", "type": "query", "description": "Filter by the address 2 field of the unit" }, { "name": "city", "value": "", "type": "query", "description": "Filter by the city of the unit" }, { "name": "county", "value": "", "type": "query", "description": "Filter by the county of the unit" }, { "name": "area_id", "value": "", "type": "query", "description": "Filter by the area ID of the unit" }, { "name": "area", "value": "", "type": "query", "description": "Filter by the area name of the unit" }, { "name": "postcode", "value": "", "type": "query", "description": "Filter by the postcode of the unit" }, { "name": "portal", "value": "", "type": "query", "description": "Filter units by portal" }, { "name": "unit_vacant", "value": "", "type": "query", "description": "Filter units by unit vacancy (boolean)" }, { "name": "available_move_in_date", "value": "", "type": "query", "description": "Filter by unit availability date range. Use the format yyyy-mm-dd to input the date" }, { "name": "available_move_out_date", "value": "", "type": "query", "description": "Filter by unit avaiability date range. Use the format yyyy-mm-dd to input the date" }, { "name": "unit_type", "value": "", "type": "query", "description": "Filter units by unit type" }, { "name": "unit_status", "value": "", "type": "query", "description": "Filter based on the current status of units, including Available To Let, Under Offer, Let, and Unavailable to Let" }, { "name": "market_rent", "value": "", "type": "query", "description": "Filter units by market rent amount" }, { "name": "bedrooms", "value": "", "type": "query", "description": "Filter units by bedroom count" }, { "name": "floors", "value": "", "type": "query", "description": "Filter units by floor count" }, { "name": "tags", "value": "", "type": "query", "description": "Filter by tags associated with the units, which should be provided as a comma-separated list" }, { "name": "i_manage_this", "value": "", "type": "query", "description": "Filter based on the management status of the property (boolean)" }, { "name": "unit_owner_id", "value": "", "type": "query", "description": "Filter by the ID of the owner of the unit" }, { "name": "max_occupancy", "value": "", "type": "query", "description": "Filter by the max occupancy on a unit" }, { "name": "_q", "value": "", "type": "query", "description": "Filter by keyword" }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of units.\n\nSee available filters below to customize the list of units returned." }, { "info": { "name": "Add Unit", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/units", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create a new unit. The API will return the saved data and a unique Unit ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Default \n Required? \n\nproperty_id \n 12345 \n Integer \n\nYes \n\nunit_type \n Residential \n String \n\nNo \n\nunit_status \n Available to Let \n String \n Available to Let \n No \n\nunit_ref \n Unit 1 \n String \n\nYes \n\naddress_line_1 \n Arthur House \n String \n\nYes \n\naddress_line_2 \n 123 Property Street \n String \n\nNo \n\n" }, { "info": { "name": "View Unit", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." } ] }, "docs": "This API endpoint retrieves the details of a single unit, identified by its unique  unit_id .\n\nUse this endpoint to view the specific details of a unit." }, { "info": { "name": "Update Unit", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/units/:unit_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "unit_id", "value": "", "type": "path", "description": "Arthur unit id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing unit using the same fields as the 'Add Unit' endpoint excluding the property_id . Any fields that are not provided will not be changed. The API will return the updated data for the unit in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nunit_type \n Residential \n String \n No \n\nunit_status \n Available to Let \n String \n No \n\nunit_ref \n Unit 1 \n String \n No \n\naddress_line_1 \n Arthur Hous" } ] } ], "bundled": true }