{ "opencollection": "1.0.0", "info": { "name": "Arthur Properties 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": "Assets", "type": "folder" }, "items": [ { "info": { "name": "List Assets On Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/assets", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property ID." }, { "info": { "name": "Create Asset On Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/assets", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 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\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 (base64) \n Yes \n\nmime_type \n application/p" } ] }, { "info": { "name": "Certificates", "type": "folder" }, "items": [ { "info": { "name": "List Certificates On Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/certificates", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property ID." }, { "info": { "name": "Add Certificate on Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/certificates", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/conversation_recipients", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property id." } ] }, "docs": "This endpoint retrieves a list of conversation recipients on a property record, identified by its unique property_id ." }, { "info": { "name": "List Conversations On Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/conversations", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property ID." }, { "info": { "name": "Create Conversation On Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/conversations", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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  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\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 Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/faqs", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property ID." }, { "info": { "name": "Add General Info for Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/faqs", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property . 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 Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/notes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property ID." }, { "info": { "name": "Add Note On Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/notes", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property . 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 Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property 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" }, { "info": { "name": "Delete Note On Property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/notes/:note_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property id." }, { "name": "note_id", "value": "", "type": "path", "description": "Arthur note id." } ] }, "docs": "This endpoint deletes an existing note using the note id ." } ] }, { "info": { "name": "Units", "type": "folder" }, "items": [ { "info": { "name": "List Units on Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/units", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property id." }, { "name": "status", "value": "", "type": "query", "description": "Filter the units by unit status." }, { "name": "type", "value": "", "type": "query", "description": "Filter the units by unit type." }, { "name": "tags", "value": "", "type": "query", "description": "Filter the units by a comma separated value of tags." }, { "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 units associated with the given property ID." } ] }, { "info": { "name": "Tenancies", "type": "folder" }, "items": [ { "info": { "name": "List Tenancies on Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/tenancies", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property ID." } ] }, { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "List Tasks On Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/tasks", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property ID." }, { "info": { "name": "Add Task On Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/tasks", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property . 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\nemergen" }, { "info": { "name": "View Task On Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property id." }, { "name": "task_id", "value": "", "type": "path", "description": "Arthur task id." } ] }, "docs": "This API endpoint retrieves the details of a single property  task , identified by its unique  id ." }, { "info": { "name": "Update Task On Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property 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," }, { "info": { "name": "Delete Task On Property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/tasks/:task_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property ID" } ] }, { "info": { "name": "Workorders", "type": "folder" }, "items": [ { "info": { "name": "List Workorders On Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/workorders", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property ID." }, { "info": { "name": "Create Workorders On Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/workorders", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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  property . 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 " }, { "info": { "name": "View Workorders On Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/workorders/:workorder_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property id." }, { "name": "workorder_id", "value": "", "type": "path", "description": "Arthur workorder id." } ] }, "docs": "This API endpoint retrieves the details of a single property  workorder , identified by its unique  id ." }, { "info": { "name": "Update Workorders On Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/workorders/:workorder_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property 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 " } ] }, { "info": { "name": "Utilities", "type": "folder" }, "items": [ { "info": { "name": "List Utilities On Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/utilities", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property ID." }, { "info": { "name": "Create Utility On Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/utilities", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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  property . 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 Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/transactions", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 Property \n\nSee available filters below to customize the list of transactions returned." } ] }, { "info": { "name": "Tags", "type": "folder" }, "items": [ { "info": { "name": "List Tags on Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/tags", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 tags associated with the given property ID." }, { "info": { "name": "Tag Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/tags", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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  property . 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\n\nField \n Example \n Type \n Required? \n\ntag \n [\"123\"] \n Array(String) \n Yes" }, { "info": { "name": "Untag Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/untag", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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  property . 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 \"1234\" \n String \n Yes" }, { "info": { "name": "Untag All Property Tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id/untag_all", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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  property ." } ] }, { "info": { "name": "Properties", "type": "folder" }, "items": [ { "info": { "name": "List Properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "full_address", "value": "", "type": "query", "description": "Filter by the full address of the property" }, { "name": "address_1", "value": "", "type": "query", "description": "Filter by the address 1 field of the property" }, { "name": "address_2", "value": "", "type": "query", "description": "Filter by the address 2 field of the property" }, { "name": "city", "value": "", "type": "query", "description": "Filter by the city of the property" }, { "name": "county", "value": "", "type": "query", "description": "Filter by the county of the property" }, { "name": "area_id", "value": "", "type": "query", "description": "Filter by the area ID of the property" }, { "name": "postcode", "value": "", "type": "query", "description": "Filter by the postcode of the property" }, { "name": "property_type", "value": "", "type": "query", "description": "Use this parameter to filter by the type of property" }, { "name": "rentable_units", "value": "", "type": "query", "description": "Filter based on the number of units available for rent" }, { "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": "tags", "value": "", "type": "query", "description": "Filter by tags associated with the property, 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": "letting_agent_id", "value": "", "type": "query", "description": "Filter by the ID of the letting agent associated with the property" }, { "name": "property_owner_id", "value": "", "type": "query", "description": "Filter by the ID of the owner of the property" }, { "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 properties.\n\nSee available filters below to customize the list of properties returned." }, { "info": { "name": "Add Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/properties", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "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 property. The API will return the saved data and a unique Property ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nproperty_type \n Residential \n String \n No \n\nref \n My big property \n String \n Yes \n\naddress_line_1 \n Arthur House \n String \n Yes \n\naddress_line_2 \n 123 Property Street \n String \n No \n\ncity \n Stevenage \n String \n No \n\ncounty \n Hertfordshire \n String \n No \n\ncountry \n United Kingdom \n" }, { "info": { "name": "View Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property id." } ] }, "docs": "This API endpoint retrieves the details of a single property, identified by its unique property_id .\n\nUse this endpoint to view the specific details of a property." }, { "info": { "name": "Update Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/properties/:property_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "property_id", "value": "", "type": "path", "description": "Arthur property 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 property using the same fields as the 'Add Property' endpoint. Any fields that are not provided will not be changed. The API will return the updated data for the property in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n\nproperty_type \n Residential \n String \n\nref \n My big property \n String \n\naddress_line_1 \n Arthur House \n String \n\naddress_line_2 \n 123 Property Street \n String \n\ncity \n Stevenag" } ] } ], "bundled": true }