{"info":{"_postman_id":"ca339827-50b5-4e48-b67a-fd294312ba96","name":"Public Property Manager","description":"

This collection encompasses a comprehensive guide for the Arthur API, along with additional information on webhooks. It comprises detailed documentation on the usage and functionality of the API, including available endpoints, supported HTTP methods, and data formats.

The webhooks section covers how to set up and use webhooks with Arthur API, providing real-time event notifications and enhancing integration with external systems.

By utilising this collection, users can obtain an in-depth understanding of the Arthur API and leverage its capabilities to optimize their workflows.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"22554870","collectionId":"ca339827-50b5-4e48-b67a-fd294312ba96","publishedId":"2s93sZ5YeM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0072ce"},"publishDate":"2023-06-06T14:27:47.000Z"},"item":[{"name":"🎯 API","item":[{"name":"🚀 Getting Started","item":[{"name":"👉 1. Create Application","item":[],"id":"b9e9a01c-7493-41de-aa9e-83cad78d2863","description":"

To use OAuth, developers are required to register their application. This involves receiving a client ID and client secret for their application.

It's important to keep the client secret confidential and only use it for communication between the application and the authorization server.

To register your application, follow these steps:

Navigate to the OAuth Applications section under the Your Account section in the Arthur Settings menu.
Click on the Add Application button to provide the necessary information.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
Name	This is the display name of your application and is a required field
Description	Please provide a brief description of what your application does
Website	This field requires the URL of your application's website where users can learn more about it
Callback URL	This is the URL that your application will be redirected to after a successful authentication. Please note that the URL must use secure HTTP (HTTPS)

\n\n

3. Once you have provided the required information for your application, click on the \"Save\" button. The system will then generate a unique client ID and client secret for your application.

\n\n

With these details, you can proceed to the user authorization step to start using the Arthur API.

\n","_postman_id":"b9e9a01c-7493-41de-aa9e-83cad78d2863"},{"name":"👉 2. Authentication","item":[{"name":"I. Request User Authorisation","id":"0d12010b-4ed0-4f51-bc97-0dabf38922ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://auth.arthuronline.co.uk/oauth/authorize?client_id={{your_client_id}}&redirect_uri={{your_redirect_uri}}","description":"

To begin using the API, the first step is to obtain user authorization by accessing the following Auth URL in a web browser.

Once the user authorizes your application, Arthur will redirect them to the redirect_uri that you specified. This will include a temporary authorization code in the code parameter.

\n
It's important to note that this authorization code will expire in 15 minutes.
\n

\n","urlObject":{"protocol":"https","path":["oauth","authorize"],"host":["auth","arthuronline","co","uk"],"query":[{"description":{"content":"

Unique identifier for your third-party application, which is received after registration. This parameter is mandatory and is used to authorize your application

\n","type":"text/plain"},"key":"client_id","value":"{{your_client_id}}"},{"description":{"content":"

The callback URL registered during application registration. After a user has authorized your application, they will be redirected to this URL. This parameter is mandatory and should match the URL you registered during application registration

\n","type":"text/plain"},"key":"redirect_uri","value":"{{your_redirect_uri}}"}],"variable":[]}},"response":[],"_postman_id":"0d12010b-4ed0-4f51-bc97-0dabf38922ef"},{"name":"II. Request Access Token","id":"b86973ba-1d44-4ad9-a531-2fb94d9333c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","description":"

This parameter indicates the type of grant requested. Parameter must have the value \"authorization_code\"

\n","type":"text"},{"key":"code","value":"","description":"

Temporary authorization code obtained during the user authorization step 1

\n","type":"text"},{"key":"client_id","value":"","description":"

This is the unique identifier for your third-party application, which was received after registration

\n","type":"text"},{"key":"client_secret","value":"","description":"

This is the secret key that identifies your third-party application and authenticates the application. It was also received after registration

\n","type":"text"},{"key":"redirect_uri","value":"","description":"

This is the URL to which the user will be redirected after the user authorization step. It must match the redirect URI specified during application registration

\n","type":"text"},{"key":"state","value":"","description":"

To maintain state between the request and the callback

\n","type":"text"}]},"url":"https://auth.arthuronline.co.uk/oauth/token","description":"

To obtain an access token, you need to use the authorization code obtained in the previous step.

You can make a POST request to the token endpoint with the following parameters, using the application/x-www-form-urlencoded format.

\n","urlObject":{"protocol":"https","path":["oauth","token"],"host":["auth","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ffef2b56-d95f-4253-b56b-0bacb0c5c35f","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","description":"This parameter indicates the type of grant requested. Parameter must have the value \"authorization_code\"","type":"text"},{"key":"code","value":"{{your_authorisation_code}}","description":"Temporary authorization code obtained during the user authorization step","type":"text"},{"key":"client_id","value":"{{your_client_id}}","description":"This is the unique identifier for your third-party application, which was received after registration","type":"text"},{"key":"client_secret","value":"{{your_client_secret}}","description":"This is the secret key that identifies your third-party application and authenticates the application. It was also received after registration","type":"text"},{"key":"redirect_uri","value":"{{your_redirect_uri}}","description":"This is the URL to which the user will be redirected after the user authorization step. It must match the redirect URI specified during application registration","type":"text"},{"key":"state","value":"{{your_state_string}}","description":"To maintain state between the request and the callback","type":"text"}]},"url":"https://auth.arthuronline.co.uk/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"c3a27902fb66891\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 1209599,\n \"refresh_token\": \"72b06203bcd7d3a\",\n \"info\": {\n \"user_id\": 1,\n \"email\": \"john@example.com\"\n }\n}"}],"_postman_id":"b86973ba-1d44-4ad9-a531-2fb94d9333c2"},{"name":"III. Using your Access Token","id":"f3cc110e-9bf1-4d9a-a640-ff72c09defcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"

This header includes the access token required to authenticate and authorize the request

\n","type":"text"},{"key":"X-EntityID","value":"","description":"

This header is used to identify the entity for which the request is being made

\n","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties","description":"

After obtaining an access token using the authorization code, you can use it to access the Arthur API on behalf of the user.

\n
It's important to keep in mind that the access token will only be valid for a period of 14 days, after which it will expire.
\n
You can use the refresh token flow to obtain a new access token without requiring the user to re-authenticate. This can help you manage the token effectively and ensure seamless user experience.
\n

\n","urlObject":{"protocol":"https","path":["v2","properties"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b3660878-1e96-4820-b468-080def66901a","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"This header is used to identify the entity for which the request is being made","type":"text"},{"key":"X-EntityID","value":"","description":"This header includes the access token required to authenticate and authorize the request","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 135732,\n \"property_type\": \"Student Accommodation\",\n \"property_description\": \"apartment\",\n \"ref\": \"oxford street flat\",\n \"full_address\": \"Oxford Street Flat, London, W1D 2BL, United Kingdom (West End)\",\n \"address_line_1\": \"Oxford Street Flat\",\n \"address_line_2\": \"\",\n \"city\": \"London\",\n \"county\": \"\",\n \"country\": \"United Kingdom\",\n \"area\": \"West End\",\n \"postcode\": \"W1D 2BL\",\n \"lat\": 51.5138875,\n \"lng\": -0.1388107,\n \"total_units\": 10,\n \"rentable_units\": 8,\n \"letting_agent_id\": null,\n \"property_owner_id\": 98765,\n \"property_owner_full_name\": \"Smith Properties\",\n \"max_occupancy\": \"2\",\n \"bathrooms\": \"2\",\n \"floors\": \"5\",\n \"bedrooms\": \"4\",\n \"receptions\": \"1\",\n \"smart_meters\": \"Electricity, Water\",\n \"council_tax_band\": \"D\",\n \"council_account_no\": \"1234567890\",\n \"council_id\": null,\n \"portal_market_rent\": 3000,\n \"portal_market_rent_frequency\": \"Monthly\",\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [\"Balcony\", \"Furnished\"],\n \"property_features\": [\"Gym\", \"Swimming pool\"],\n \"additional_features\": [\"Central heating\"],\n \"tags\": [\"Luxury\"],\n \"notes\": [\"No pets allowed\"],\n \"i_manage_this\": true,\n \"latitude\": 51.5138875,\n \"longitude\": -0.1388107,\n \"custom_fields\": [],\n \"modified\": \"2023-02-21T09:26:14\",\n \"created\": \"2023-02-21T08:52:09\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 20,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"f3cc110e-9bf1-4d9a-a640-ff72c09defcf"}],"id":"5660e301-3755-43f7-ac37-7cc62eedd39f","description":"

Arthur API makes use of the Authorization Code flow in OAuth 2, which defines the procedure for third-party applications.

Additional information regarding this flow can be accessed at https://www.rfc-editor.org/rfc/rfc6749#section-4.1

\n","_postman_id":"5660e301-3755-43f7-ac37-7cc62eedd39f"},{"name":"👉 3. Refresh Token","item":[{"name":"Refresh Token Flow","id":"619667e8-091d-42c0-9201-316db965c56c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"content-type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"refresh_token","value":"","description":"

This is the refresh token that you have previously obtained and want to use to request a new access token

\n","type":"text"},{"key":"client_id","value":"","description":"

This is the client ID that you obtained when you registered your application

\n","type":"text"},{"key":"client_secret","value":"","description":"

This is the client secret that you obtained when you registered your application with the API provider

\n","type":"text"},{"key":"grant_type","value":"refresh_token","description":"

This is the type of grant being requested

\n","type":"text"}]},"url":"https://auth.arthuronline.co.uk/oauth/token","description":"

This request will return a new access token that can be used to access protected resources within the API.

You can use this curl command as a reference when setting up your own refresh token request using Postman or other HTTP client libraries.

\n","urlObject":{"protocol":"https","path":["oauth","token"],"host":["auth","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"adbcde19-e40b-4a33-a6c6-40cb3e4ce306","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"content-type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"refresh_token","value":"eyJhbGciOiJIUzI1NiIsInR","description":"This is the refresh token that you have previously obtained and want to use to request a new access token","type":"text"},{"key":"client_id","value":"abc123def456","description":"This is the client ID that you obtained when you registered your application","type":"text"},{"key":"client_secret","value":"789ghi012jkl345mno678pqr","description":"This is the client secret that you obtained when you registered your application with the API provider","type":"text"},{"key":"grant_type","value":"refresh_token","description":"This is the type of grant being requested","type":"text"}]},"url":"https://auth.arthuronline.co.uk/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"c3a27902fb66891\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 1209599,\n \"refresh_token\": \"72b06203bcd7d3a\",\n \"info\": {\n \"user_id\": 1,\n \"email\": \"john@example.com\"\n }\n}"}],"_postman_id":"619667e8-091d-42c0-9201-316db965c56c"}],"id":"994e54d5-f2cd-46cc-aa49-b17d35a5bdda","description":"

When making requests to the API, it is important to ensure that the provided token is valid and has not expired. If an expired token is used in a request, the API will respond with a 401 Unauthorized error and a JSON body containing an error code and message, like below:

{\n    \"error\": \"expired_token\",\n    \"message\": \"This token has expired.\"\n}\n\n

Users should ensure that they obtain a new token before attempting to make any further requests to the API to avoid encountering this error.

To obtain a new access token, send a POST request to the token endpoint using the application/x-www-form-urlencoded format and provide the following parameters. The request must be authenticated using the refresh token.

\n
Refresh tokens are valid for a period of 21 days.
\n

\n","_postman_id":"994e54d5-f2cd-46cc-aa49-b17d35a5bdda"}],"id":"64364432-c8c3-4048-9103-81e560f1905f","description":"

Arthur API makes use of the Authorization Code flow in OAuth 2, which defines the procedure for third-party applications.

Additional information regarding this flow can be accessed at https://www.rfc-editor.org/rfc/rfc6749#section-4.1

\n","_postman_id":"64364432-c8c3-4048-9103-81e560f1905f"},{"name":"📋 Useful Information","item":[{"name":"📩 Request Structure","item":[],"id":"212d1edf-154b-4135-9f30-89f99c045805","description":"

The Arthur API follows conventional RESTful HTTP methods. API request headers are a crucial part of any API request as they provide additional information to the server about the request being made. These headers are sent along with the request and can include information such as authentication tokens, entity IDs, and content types. In order to ensure secure and authorized access to the API, it is mandatory to include certain headers, such as an authorisation header with a bearer access token and X-EntityID containing your client entity_id.

When making a POST or PUT request, it is also important to include an application/json content type header in order to indicate to the server that the payload being sent is in JSON format.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Method	Description	Required Headers
GET	Retrieve data	Authorization: Bearer token X-EntityID: entity_id
POST	Create a new record	Authorization: Bearer token X-EntityID: entity_id Content-Type: application/json
PUT	Update an existing record	Authorization: Bearer {{token}} X-EntityID: entity_id Content-Type: application/json
DELETE	Remove a record	Authorization: Bearer token X-EntityID: entity_id

\n
Failure to include the required headers in your API requests can result in failed requests.
\n

\n","_postman_id":"212d1edf-154b-4135-9f30-89f99c045805"},{"name":"📨 Response Structure","item":[{"name":"Status","item":[],"id":"577547b1-2ef2-49f1-92eb-6ebae4326cad","description":"

The status simply returns the HTTP status code for your request. Below are the codes you may receive in the response and their corresponding reasons:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Reason
`200 OK`	The request was completed successfully without errors
`400 ERROR`	The request was invalid or malformed
`404 ERROR`	The request was sent to a location that does not exist in our API

","_postman_id":"577547b1-2ef2-49f1-92eb-6ebae4326cad"},{"name":"Body","item":[],"id":"9e3eb15e-a354-4189-b86a-dfa3765b5ef4","description":"

The request body will include information that is relevant to the request you have made. This could include details about the outcome of an action or the data returned from read requests.

\n
For specific requests, please refer to the documentation to learn more about the expected data that will be returned.
\n

\n","_postman_id":"9e3eb15e-a354-4189-b86a-dfa3765b5ef4"},{"name":"Pagination","item":[],"id":"4296808f-1edb-416b-bd8c-3749affd63c5","description":"

You can modify the page, limit, and sorting order by using the following query parameters:

To specify the current page, use ?page=[between 1 and the total number of pages]
To set the limit of items per page, use ?limit=[between 1 and 100]
To sort the items, use ?sort=[Field]&direction=[ASC|DESC]

\n","_postman_id":"4296808f-1edb-416b-bd8c-3749affd63c5"}],"id":"54c8694b-09a4-46d5-986a-f3337d459cce","description":"

Each response in the API will have a body that contains three primary objects:

Status
Body
Pagination

These objects are used to provide information about the status of the request, the data that was returned, and pagination details.

\n
Arthur API uses JSON exclusively for POST and PUT methods, while GET methods return JSON-formatted data.
\n

\n","_postman_id":"54c8694b-09a4-46d5-986a-f3337d459cce"},{"name":"🔍 Filters","item":[],"id":"ab9afedb-13a7-413f-9c29-da1eda3d6124","description":"

API V2 allows for the use of all filters currently supported by the browser version. These filters are passed into the request as query parameters and are only used in list requests.

Please refer to specific requests for more information on the filters that are supported.

\n","_postman_id":"ab9afedb-13a7-413f-9c29-da1eda3d6124"},{"name":"📁 Data Types","item":[],"id":"066b1b41-ec1a-4370-8dee-4ae49dcfa5a2","description":"

Below are the available data types:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Description
String	This is a text field without any restrictions. It can also be used as a simple type
Enum	This data type contains a predefined set of values defined by the system. Please check the Types section to view the available values
Simple	This data type is a combination of an id and a name that the user can add to. More details can be found below
Integer	This data type only accepts positive whole numbers
Float	This data type accepts numerical values rounded to the nearest two decimal places
DateTime	This data type is a date/time field in ISO 8601 format - `yyyy-MM-ddTHH:mm:ssZ`
Date	This data type is a date field in ISO 8601 format - `yyyy-MM-dd`
Time	This data type is a time field in ISO 8601 format - `HH:mm`
Array (type)	This data type is an array of values, where each value must conform to the given type
Email	This data type is a text field that requires email format validation, for example: myemail@example.com.

","_postman_id":"066b1b41-ec1a-4370-8dee-4ae49dcfa5a2"},{"name":"🔧 Simple Types","item":[],"id":"f83d710c-c34c-4aa2-9f27-5774544df941","description":"

We classify certain fields as Simple types. These types consist of an ID/Name pair only and can be created by the user. One such example is 'source', but 'analysis code' is not a simple type.

If a simple type cannot be found with the given name, the system will create it by default and assign it to the object you are creating/updating. To prevent this behavior and abort the request instead of creating the simple type, use the Strict query parameter as follows:

?strict=[true|false]

\n
Note that this parameter is only available for POST and PUT requests.
\n

\n","_postman_id":"f83d710c-c34c-4aa2-9f27-5774544df941"},{"name":"🛠️ Custom Fields","item":[],"id":"d385e2f5-7682-41e2-8c5c-31fab8290674","description":"

We have introduced a new \"custom_fields\" field that can be used in GET, POST, and PUT requests in the following resources:

Properties
Units
Tenancies
Applicants
Tenants

For instance, when making a GET request to 'https://api.arthuronline.co.uk/v2/properties', the custom_fields field will be displayed together with other fields:

{\n    \"custom_fields\": \n        [\n           {\n            \"name\": \"custom field 1\",\n            \"api_name\": \"custom_field_1\",\n            \"value\": \"10\"\n            }\n        ]\n}\n\n

To update the custom_fields field, you should add an object that contains a list of fields with their corresponding API names and values. The value should be of the same type as that set for the custom field.

For example, when making a PUT request to 'https://api.arthuronline.co.uk/v2/properties/{property_id}', you can update the custom field as follows:

{ \n    ... ,\n    \"custom_fields\": { \n        \"custom_field_1\":\"new value\" \n        }   \n}\n\n

\n","_postman_id":"d385e2f5-7682-41e2-8c5c-31fab8290674"},{"name":"🐢 Throttling","item":[],"id":"b45c16bc-8d44-4060-82f4-d57dd62947ad","description":"

In order to avoid misuse of the API, we have established a worldwide rate limit of 5,000 requests per hour. If you need a higher limit for your account, kindly reach out to Arthur technical support.

\n","_postman_id":"b45c16bc-8d44-4060-82f4-d57dd62947ad"},{"name":"🔒 Security","item":[{"name":"Security by Design","item":[],"id":"851d4dd9-be50-4d66-8a0c-d48bea073507","description":"

To ensure secure application development, please consider the following guidelines:

Keep code in a secure repository.
Conduct risk analysis during the Systems Development Life Cycle (SDLC) process.
Identify and address security concerns throughout SDLC.
Implement environment segregation throughout SDLC.
Address and resolve all testing defects before closing them out.

These guidelines emphasize the significance of secure building practices to prevent potential security breaches and ensure the privacy of both your app users and your own data.

\n","_postman_id":"851d4dd9-be50-4d66-8a0c-d48bea073507"},{"name":"Securing API Tokens","item":[],"id":"d19de364-7a26-45b7-ba80-7a46479bbbac","description":"

If you are a developer using the Arthur platform, you will have programmatic access to both your own and your users' data stored by Arthur, assuming they have authorized your developer app.

Authentication of all API requests must be done using OAuth with your developer app's key and secret, and in some cases, the access tokens of authorized users. It is your responsibility to keep your credentials secure.

Below are some recommended best practices to follow:

Establish a system for rotating passwords and tokens.
Encrypt sensitive data whenever necessary and avoid decrypting it too early in the process.
Store your users' access tokens in a secure, encrypted location.
Regenerate keys and tokens if you suspect that they have been compromised.

\n","_postman_id":"d19de364-7a26-45b7-ba80-7a46479bbbac"},{"name":"Monitoring","item":[],"id":"bf988a6d-a07f-4d37-b56a-c3e51f06e691","description":"

If you suspect that there is an issue with your web application, it's important to ensure that you keep detailed logs and receive notifications for critical exceptions and errors. You might want to create a dashboard displaying critical statistics so that you can easily detect any problems.

\n","_postman_id":"bf988a6d-a07f-4d37-b56a-c3e51f06e691"},{"name":"Restrictions","item":[],"id":"fd28930e-e149-4139-afe7-102dd50cc53b","description":"

When collaborating with third-party developers, it is advisable to create separate Manager accounts during the login and authentication process at the initial stages. This will allow developers to access the API and perform required tasks without having complete control over your Arthur account.

By creating a Manager Account, you can grant developers access to specific areas of your account while still retaining control over the level of access provided. This approach provides a more secure and controlled environment for working with third-party developers.

For users on the Enterprise package, the main contact can set permissions on the Manager Account. This means that you can have greater control over which data the developer can access through the API. With this level of control, you can ensure that your user data is not compromised in any way while still allowing third-party developers to work with your Arthur account.

For more information on how to set up Manager Accounts and permissions, we recommend checking out our knowledgebase article.

\n","_postman_id":"fd28930e-e149-4139-afe7-102dd50cc53b"},{"name":"Debug Information","item":[],"id":"4470f7d9-e0c9-43d2-9bec-48565305f01a","description":"

To avoid exposing sensitive data or credentials, prevent unauthorized access to debugging information through screens or logs. Check that debugging flags or symbols are disabled before deploying or building, especially for desktop and mobile development.

\n","_postman_id":"4470f7d9-e0c9-43d2-9bec-48565305f01a"}],"id":"b9900479-589a-4144-985b-436964de6203","description":"

We must stress the importance of secure building to safeguard both your users' data and your own. While it's your responsibility to protect against security breaches, we share a duty to protect Arthur users.

This page outlines the expectations for secure application development.

\n","_postman_id":"b9900479-589a-4144-985b-436964de6203"}],"id":"2a916451-7156-456c-8181-cb6241f215db","_postman_id":"2a916451-7156-456c-8181-cb6241f215db","description":""},{"name":"🧪 Testing","item":[{"name":"Postman","item":[],"id":"ae73ed57-caab-4830-9673-a6e4eb4c0b0d","description":"

Postman is a popular API development tool that allows you to make HTTP requests and test API endpoints. To use Postman to obtain an access token for the Arthur API, follow the steps below.

1. Create Application

It is necessary to configure your OAuth application by setting your client_id and client_secret. You can do this by following the instructions provided in the Create Application section.

Additionally, you should use the Postman Callback URL (https://www.getpostman.com/oauth2/callback) as your Callback URL.

2. Obtain Access Token

Click on the Authorization tab and select OAuth 2.0 from the Type\"dropdown menu. Then click on the Get New Access Token button.

\n\n

In the dialog box, enter the following details:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
Token Name	Choose a name for your token
Auth URL	https://auth.arthuronline.co.uk/oauth/authorize
Access Token URL	https://auth.arthuronline.co.uk/oauth/token
Client ID	The Client ID obtained from step 1
Client Secret	The Client Secret obtained from step 1
Scope	Leave this field blank
Grant Type	Authorization Code

Click on the Request Token button.

\n\n

In the next dialog box, enter your Arthur email and password. You will then be prompted to allow or deny the application access to your account. Click on the \"Allow\" button.

\n\n

You will receive an access token from the Arthur API. Click on your token name to view the details, and then click on the Use Token button to utilize this access token.

3. Header Configuration

In the Headerstab of the request, enter the following details:

Cache-Control: no-cache
Content-Type: application/json
X-EntityID:

To obtain your Entity ID value:

From the Settings menu in Arthur, select OAuth Applications under the Your Account section.
Your ENTITY_ID will be displayed above the list of applications.

\n\n

Once you have obtained your access token and configured your headers, you can use Postman to make API requests to the Arthur API.

\n","_postman_id":"ae73ed57-caab-4830-9673-a6e4eb4c0b0d"}],"id":"4fed0e52-a23e-49e7-9ddd-99861fe0838b","description":"

Here are some commonly recommended API test applications that can be used when getting started with the API.

\n","_postman_id":"4fed0e52-a23e-49e7-9ddd-99861fe0838b"},{"name":"🧩 Endpoints","item":[{"name":"Properties","item":[{"name":"Assets","item":[{"name":"List Assets On Property","id":"f376cc55-f460-4d52-98bf-e048408bb13b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/assets","description":"

This endpoint retrieves a list of assets associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"0d7c8d68-b30f-40b0-b279-c3164309ce8c","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/conversations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \" Inventory\",\n \"description\": \" Inventory\",\n \"created_by\": {\n \"full_name\": \"Brian Williams\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Inventory\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Inventory\",\n \"model_id\": 123\n },\n {\n \"id\": 123,\n \"model\": \"Property\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-06-23T11:13:02+01:00\",\n \"modified\": \"2020-06-23T11:13:02+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"f376cc55-f460-4d52-98bf-e048408bb13b"},{"name":"Create Asset On Property","id":"4544cde3-60a2-494f-8c45-3753693ace4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/assets","description":"

Use this endpoint to create a new asset related to a property. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
asset_type	image	String	No
name	inventory	String	No
share_manager	true	Boolean	No
share_tenant	false	Boolean	No
share_contractor	true	Boolean	No
share_owner	true	Boolean	No
file	base64	String (base64)	Yes
mime_type	application/pdf	String	Yes
file_name	inventory	String	Yes

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"66462a60-5dce-47b4-9396-8e246a09b066","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset_type\":\"image\",\n\t\"name\":\"name of asset\",\n\t\"share_manager\":true,\n\t\"share_tenant\":true,\n\t\"share_owner\":true,\n\t\"share_contractor\":true,\n\t\"file\":\"pdf file converted to base64 string\",\n\t\"mime_type\":\"application/pdf\",\n\t\"file_name\":\"inventory\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/assets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"name of asset\",\n \"description\": null,\n \"created_by\": {\n \"full_name\": \"API Documentation\",\n \"company\": \"API\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Image\",\n \"share_manager\": true,\n \"share_owner\": true,\n \"share_tenant\": true,\n \"share_contractor\": true,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Property\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-07-03T09:25:52+01:00\",\n \"modified\": \"2020-07-03T09:25:52+01:00\"\n }\n}"}],"_postman_id":"4544cde3-60a2-494f-8c45-3753693ace4d"}],"id":"0cd4d271-6c26-4d6e-be0d-c2e7a18b811a","description":"

This section provides resources for dealing with assets related to a property.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e832eb2f-4db5-4f21-abeb-081b52a90a15"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4cf657aa-7a2e-4021-9cba-51d128ccb33b"}}],"_postman_id":"0cd4d271-6c26-4d6e-be0d-c2e7a18b811a"},{"name":"Certificates","item":[{"name":"List Certificates On Property","id":"327793a5-163d-4483-baa2-2d675b98be77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/certificates","description":"

This endpoint retrieves a list of certificates associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","certificates"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"496c4160-9e00-4062-83f1-220ac7f16d3d","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/certificates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 12345,\n \"type\": \"Gas Safety\",\n \"expiry_date\": \"2021-06-06\",\n \"status\": \"Expired\",\n \"missing\": false,\n \"file\": {\n \"id\": 12345,\n \"download_url\": \"https://asset.arthuronline.co.uk/download/{uuid}\",\n \"mime_type\": \"image/jpeg\"\n },\n \"property\": {\n \"id\": 1234,\n \"address\": \"Multiple Unit Property, test, ABC 123\"\n },\n \"unit\": {\n \"id\": 123,\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"tenancy\": {\n \"id\": 123456,\n \"ref\": \"TE1000\",\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"notes\": \"My Certificate Notes\",\n \"share_manager\": true,\n \"share_tenant\": false,\n \"share_contractor\": true,\n \"share_owner\": false,\n \"created\": \"2021-01-01T12:00:00\",\n \"modified\": \"2021-01-01T12:00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"327793a5-163d-4483-baa2-2d675b98be77"},{"name":"Add Certificate on Property","id":"744e7502-25df-49d9-9109-a122c25f6473","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/certificates","description":"

Use this endpoint to create a new certificate related to a property. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
type	Boiler Service	String	Yes
expiry_date	2023-12-05	String	No
notes	Fully assessed	String	No
file	Base64	String	No
mime_type	application/pdf	String	No (Required if File field is present)
file_name	Certificate Document	string	No (Required if File field is present)

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","certificates"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"7546b6aa-f1be-47b9-ab73-821b9d2a9353","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"x-entityid","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"Boiler Service\",\n \"expiry_date\" : \"2022-02-28\",\n \"notes\" : \"Fully assessed\",\n \"file\" : \"JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjE2Ljg5NjAgVGQNCiggdGV4dC4gQW5kIG1vcmUgdGV4dC4gQm9yaW5nLCB6enp6ei4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjA0Ljk0NDAgVGQNCiggbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDU5Mi45OTIwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTY5LjA4ODAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NTcuMTM2MCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBFdmVuIG1vcmUuIENvbnRpbnVlZCBvbiBwYWdlIDIgLi4uKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjYgMCBvYmoNCjw8DQovVHlwZSAvUGFnZQ0KL1BhcmVudCAzIDAgUg0KL1Jlc291cmNlcyA8PA0KL0ZvbnQgPDwNCi9GMSA5IDAgUiANCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBTaW1wbGUgUERGIEZpbGUgMiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIC4uLmNvbnRpbnVlZCBmcm9tIHBhZ2UgMS4gWWV0IG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NzYuNjU2MCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY2NC43MDQwIFRkDQooIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiBCdXQgbm90IGFzIGJvcmluZyBhcyB3YXRjaGluZyApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY1Mi43NTIwIFRkDQooIHBhaW50IGRyeS4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NDAuODAwMCBUZA0KKCBCb3JpbmcuICBNb3JlLCBhIGxpdHRsZSBtb3JlIHRleHQuIFRoZSBlbmQsIGFuZCBqdXN0IGFzIHdlbGwuICkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo4IDAgb2JqDQpbL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZVwpKQ0KL1Byb2R1Y2VyIChOZXZyb25hIERlc2lnbnMpDQovQ3JlYXRpb25EYXRlIChEOjIwMDYwMzAxMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQowIDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgbg0KMDAwMDAwMDA5MyAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg==\",\n \"mime_type\" : \"application/pdf\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/certificates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 875729,\n \"type\": \"Boiler Service \",\n \"expiry_date\": \"2022-02-28\",\n \"status\": \"Expired\",\n \"missing\": false,\n \"file\": {\n \"id\": 5740763,\n \"download_url\": \"https://asset.arthuronline.co.uk/download/e62146f5-53a0-41df-a31b-b0f7b99644b9\",\n \"mime_type\": \"application/pdf\"\n },\n \"property\": {\n \"id\": 282789,\n \"address\": \"My big property, Arthur House, 123 Property Street, Stevenage, Hertfordshire, AB1 2CD\"\n },\n \"unit\": {\n \"id\": 0,\n \"address\": \"\"\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null,\n \"address\": null\n },\n \"notes\": \"Fully assessed\",\n \"share_manager\": true,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"share_owner\": false,\n \"created\": \"2023-02-28T14:50:47\",\n \"modified\": \"2023-02-28T14:50:47\"\n }\n}"}],"_postman_id":"744e7502-25df-49d9-9109-a122c25f6473"}],"id":"4936a730-5bea-4724-a081-6ee0ceb0f01c","description":"

This section provides resources for dealing with certificates related to a property.

\n","_postman_id":"4936a730-5bea-4724-a081-6ee0ceb0f01c"},{"name":"Conversations","item":[{"name":"Conversation Recipients","item":[{"name":"Get Recipients for Property","id":"9cb40fdc-2287-4f31-be82-f14f1d9e3e1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/conversation_recipients","description":"

This endpoint retrieves a list of conversation recipients on a property record, identified by its unique property_id.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","conversation_recipients"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"673a7511-85b6-41ed-b97c-9898b8dfd440","name":"Get Recipients for Property","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/conversation_recipients"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Henry\",\n \"last_name\": \"Williams\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 2,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Mike\",\n \"last_name\": \"Marky\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 3,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Josh\",\n \"last_name\": \"Jackson\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 4,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Brian\",\n \"last_name\": \"Shaw\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n }\n ]\n}"}],"_postman_id":"9cb40fdc-2287-4f31-be82-f14f1d9e3e1b"}],"id":"62a0374d-ff3a-4a13-adab-55738fb2806f","description":"

Here you can find the full list of endpoints for the Conversation Receipients area of the system, related to a Task record.

\n","_postman_id":"62a0374d-ff3a-4a13-adab-55738fb2806f"},{"name":"List Conversations On Property","id":"17d37cd5-8d08-4a84-8abc-2c36608e8ea1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/conversations","description":"

This endpoint retrieves a list of conversations associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"cb62412c-01c3-414e-b8e2-ffef864c6730","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"title\": \"Subject 1\",\n \"message_count\": 1,\n \"model\": \"Property\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Sure!\",\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"modified\": \"2020-04-22T12:03:28+01:00\"\n },\n {\n \"id\": 123,\n \"title\": \"Subject 2\",\n \"message_count\": 1,\n \"model\": \"Property\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Remember to clean on friday.\",\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"modified\": \"2020-04-30T11:49:54+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"17d37cd5-8d08-4a84-8abc-2c36608e8ea1"},{"name":"Create Conversation On Property","id":"dd4477fe-1300-4a6e-b4ac-cbf21d3ae96f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/conversations","description":"

Use this endpoint to create a new conversation related to a property. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
message	It's done	String	Yes
subject	Meeting tomorrow	String	Yes
person_ids	['1','2']	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"bf7dc21f-6f5f-4310-9bd2-8d3bde38f357","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"message\":\"Please clean the house on friday.\",\n\t\"subject\":\"House duties\",\n\t\"person_ids\":[\"21\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"House duties\",\n \"message_count\": 1,\n \"model\": \"Property\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 2,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 21,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Please clean the house on friday.\",\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"modified\": \"2020-06-05T15:06:26+01:00\"\n }\n}"}],"_postman_id":"dd4477fe-1300-4a6e-b4ac-cbf21d3ae96f"}],"id":"175c78ef-3dec-414d-9f1d-0603f33180c5","description":"

This section provides resources for dealing with conversations related to a property.

\n","_postman_id":"175c78ef-3dec-414d-9f1d-0603f33180c5"},{"name":"General Information","item":[{"name":"List General Info for Property","id":"4d2134dd-2382-4960-abc8-69f691a85a9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/faqs","description":"

This endpoint retrieves a list of general information records associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","faqs"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ab289662-ec0f-45ff-9537-55feefa5cc31","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/faqs"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 35764,\n \"property_id\": 282789,\n \"unit_id\": null,\n \"title\": \"Maintenance - Weekly Clean\",\n \"faq_type\": \"General\",\n \"description\": \"Once a week the main hall will be cleaned\",\n \"created_by\": {\n \"id\": 1817080,\n \"full_name\": \"API Documentation\"\n },\n \"share_owner\": false,\n \"share_contractor\": false,\n \"share_tenant\": false,\n \"modified\": \"2023-02-28T13:30:49\",\n \"created\": \"2023-02-28T13:30:49\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"4d2134dd-2382-4960-abc8-69f691a85a9f"},{"name":"🆕 Add General Info for Property","id":"1a318291-f81a-4550-b3c6-bcd8dc5429b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/faqs","description":"

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.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type
title	Maintenance	String
description	Weekly clean	String
faq_type	General	String
share_owner	true	Boolean
share_tenant	true	Boolean
share_contractor	false	Boolean

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","faqs"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"4a11f8a8-fba0-4384-b073-d87f72f6e326","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\" : \"Maintenance - Weekly Clean\",\n \"description\" : \"Once a week the main hall will be cleaned\",\n \"faq_type\": \"General\",\n \"share_owner\": true,\n \"share_tenant\": true,\n \"share_contractor\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/faqs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Feb 2023 13:33:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"13b-zobeyQfSuTE39r6FBLg9R1GHe/g\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=YP4ULcsIqigIj6hjYecs7njwnKd2ISSW2%2B6hK8DyZh5jObyC0aX0zsfELXP8RjKZDtQP8OpdGqk5A02akpCb2WoF9rCUI1uvOb4dsnlS9WWWeXdGm%2FK5pTIOyqrIZqccwGAPaCQ%2Bytw%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7a0987e678f9416b-LHR"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 35767,\n \"property_id\": 282789,\n \"unit_id\": null,\n \"title\": \"Maintenance - Weekly Clean\",\n \"faq_type\": \"General\",\n \"description\": \"Once a week the main hall will be cleaned\",\n \"created_by\": {\n \"id\": 1817080,\n \"full_name\": \"API Documentation\"\n },\n \"share_owner\": true,\n \"share_contractor\": true,\n \"share_tenant\": true,\n \"modified\": \"2023-02-28T13:33:14\",\n \"created\": \"2023-02-28T13:33:14\"\n }\n}"}],"_postman_id":"1a318291-f81a-4550-b3c6-bcd8dc5429b2"}],"id":"156d6721-73fd-484c-8c56-44b3453d3108","description":"

This section provides resources for dealing with general information related to a property.

\n","_postman_id":"156d6721-73fd-484c-8c56-44b3453d3108"},{"name":"Notes","item":[{"name":"List Notes On Property","id":"068d6d6d-410c-424a-86b3-7e7a9af55be9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/notes","description":"

This endpoint retrieves a list of notes associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"aa0c1864-15c7-4243-a1bc-636c581b66de","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/notes"},"status":"List Notes On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [\n \t\t\t\"one\",\n \t\t\t\"two\"\n ],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-03-04T15:12:33+00:00\",\n \"modified\": \"2020-03-11T09:27:04+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n\n"}],"_postman_id":"068d6d6d-410c-424a-86b3-7e7a9af55be9"},{"name":"View Note On Property","id":"c369c476-fc38-401d-b23e-626ba493ae78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/notes/{{note_id}}","description":"

This API endpoint retrieves the details of a single note, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"2218c401-d32b-4a4d-91b9-cb462f5fa4ab","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/notes/{{note_id}}"},"status":"View Note On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Interesting\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": null,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T12:02:34+01:00\"\n }\n}\n"}],"_postman_id":"c369c476-fc38-401d-b23e-626ba493ae78"},{"name":"Add Note On Property","id":"528136e8-a753-4e88-93df-67cb456a8634","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/notes","description":"

Use this endpoint to create a new note record for the property. The API will return the saved data and a unique note ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	Yes

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"967140aa-7607-421f-8cea-fbac0de6895e","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\":\"Remember this note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/notes"},"status":"Add Note On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": null,\n \"full_name\": null\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": null,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"528136e8-a753-4e88-93df-67cb456a8634"},{"name":"Update Note On Property","id":"07dfa231-4852-423e-9de9-26e4274a3718","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/notes/{{note_id}}","description":"

This endpoint updates an existing note using the same fields as the 'Add Note' endpoint. The API will return the updated data for the property in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	No

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"045720f4-0daf-4d8d-ac9e-948b59c7ef7e","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\":\"Updated Note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/notes/{{note_id}}"},"status":"Update Note On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Updated Note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": null,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T12:02:34+01:00\"\n }\n}"}],"_postman_id":"07dfa231-4852-423e-9de9-26e4274a3718"},{"name":"Delete Note On Property","id":"f2300ec6-4ce4-412e-aba4-459d054a8cdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/notes/{{note_id}}","description":"

This endpoint deletes an existing note using the note id.

This section provides resources for dealing with notes related to a property.

\n","_postman_id":"902239ac-5c08-4d90-a829-e610da470213"},{"name":"Units","item":[{"name":"List Units on Property","id":"8e32c51e-5024-47d9-9938-ccb62c282145","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/units","description":"

This endpoint retrieves a list of units associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","units"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter the units by unit status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter the units by unit type.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Filter the units by a comma separated value of tags.

\n","type":"text/plain"},"key":"tags","value":""}],"variable":[]}},"response":[{"id":"a91e0a66-0aac-4ac1-9adc-9a051794b438","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/units"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"property_id\": 1,\n \"unit_type\": \"Flat\",\n \"unit_status\": \"Under Offer\",\n \"unit_ref\": \"Unit 3 - C\",\n \"unit_vacant\": true,\n \"available_from\": null,\n \"owner\": {\n \"id\": 1,\n \"full_name\": \"New Company\"\n },\n \"assigned_managers\": \"\",\n \"full_address\": \"full address\",\n \"address_line_1\": \"address line 1\",\n \"address_line_2\": \"address line 2\",\n \"city\": \"london\",\n \"county\": \"\",\n \"country\": \"United Kingdom\",\n \"area\": \"\",\n \"postcode\": \"123456\",\n \"market_rent\": 0,\n \"market_rent_frequency\": \"Not provided\",\n \"available_since\": null,\n \"letting_agent_id\": null,\n \"letting_agent\": {\n \"id\": null,\n \"full_name\": null\n },\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"N/A\",\n \"bathrooms\": \"N/A\",\n \"floors\": \"\",\n \"bedrooms\": \"N/A\",\n \"receptions\": \"N/A\",\n \"smart_meters\": \"\",\n \"date_available\": null,\n \"rental_term\": \"\",\n \"deposit_amount\": 0,\n \"service_charge\": false,\n \"service_charge_amount\": 0,\n \"council_tax_band\": \"N/A\",\n \"council_account_no\": \"\",\n \"council_id\": null,\n \"portal_market_rent\": 0,\n \"portal_market_rent_frequency\": \"Not provided\",\n \"sharing_tenancies\": \"N/A\",\n \"virtual_tour_url\": \"\",\n \"i_manage_this\": true,\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [],\n \"unit_features\": [],\n \"additional_features\": [],\n \"notes\": [],\n \"tags\": [],\n \"custom_fields\": [],\n \"days_vacant\": \"\",\n \"days_vacant_total\": 0,\n \"modified\": \"2021-01-09T12:53:18+00:00\",\n \"created\": \"2021-01-09T12:52:11+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"8e32c51e-5024-47d9-9938-ccb62c282145"}],"id":"5c98ad40-00ff-410b-9433-6d01abfff695","description":"

This section provides resources for dealing with Units related to a property.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e27ad313-305f-409e-bfd4-c296c1060ed5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"cb6dc2b3-6152-4471-bf61-753ffa374ed0"}}],"_postman_id":"5c98ad40-00ff-410b-9433-6d01abfff695"},{"name":"Tenancies","item":[{"name":"List Tenancies on Property","id":"807f4e0f-30de-4bf5-aa21-0c1c54a1625e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tenancies","description":"

This endpoint retrieves a list of tenancies associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","tenancies"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"15c97a0d-cb34-4b71-a1c6-1c150bd66028","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tenancies"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 12345,\n \"property_id\": 11223,\n \"unit_id\": 22334,\n \"ref\": \"TE1001\",\n \"status\": \"Current\",\n \"tenancy_type\": \"Commercial\",\n \"tenants\": [\n {\n \"id\": 226495,\n \"first_name\": \"tenant\",\n \"last_name\": \"one\",\n \"date_of_birth\": \"1980-05-06\",\n \"mobile\": \"07123456789\",\n \"email\": \"sales@arthuronline.co.uk\",\n \"main_tenant\": true,\n \"move_in_date\": \"2019-01-01\",\n \"move_out_date\": \"2020-01-01\"\n }\n ],\n \"letting_agent\": {\n \"id\": 99999,\n \"first_name\": \"Arthur\",\n \"last_name\": \"Agency\",\n \"primary_phone\": \"\",\n \"primary_email\": \"sales+agent@arthuronline.co.uk\"\n },\n \"contract_type\": \"Company\",\n \"renter_company\": \"\",\n \"start_date\": \"2019-09-01\",\n \"end_date\": \"2020-09-01\",\n \"break_clause_date\": null,\n \"fixed_break_date\": \"2020-02-13\",\n \"rolling_break_date\": \"2019-09-18\",\n \"notice_period\": \"1 months\",\n \"issue_break_clause_to\": \"landlord\",\n \"move_in_date\": \"2019-01-02\",\n \"move_in_time\": \"12:00\",\n \"move_out_date\": null,\n \"move_out_time\": null,\n \"rent_amount\": 875,\n \"rent_frequency\": \"Monthly\",\n \"deposit_held_by\": \"\",\n \"rent_payment_bank\": {\n \"id\": 55555,\n \"bank_name\": \"\",\n \"bank_account\": \"Arthur default account\",\n \"account_number\": \"00000000\",\n \"sort_code\": \"000000\"\n },\n \"deposit payment bank\": {\n \"id\": 5556,\n \"bank_name\": \"\",\n \"bank_account\": \"Arthur default account\",\n \"account_number\": \"00000000\",\n \"sort_code\": \"000000\"\n },\n \"default_rent_payment_method\": \"Bank Transfer\",\n \"rent_insured\": false,\n \"modified\": \"2019-09-02T11:20:42+00:00\",\n \"created\": \"2019-09-02T11:20:42+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"807f4e0f-30de-4bf5-aa21-0c1c54a1625e"}],"id":"c41ae310-8e4f-4af4-ba75-d0a3a9249fe3","description":"

This section provides resources for dealing with Tenancies related to a property.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2836946c-18aa-48c0-a351-a6de930f13e4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"cfa62f7c-4362-472c-b96b-75e39e8355a8"}}],"_postman_id":"c41ae310-8e4f-4af4-ba75-d0a3a9249fe3"},{"name":"Tasks","item":[{"name":"List Tasks On Property","id":"27e9582f-001b-4ea9-8e7a-f16410d2cf2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tasks","description":"

This endpoint retrieves a list of tasks associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","tasks"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"cf6c0f40-ba98-4ef3-aeab-80a8202a1205","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tasks"},"status":"List Tasks On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Need to fix the boiler\",\n \"total_subtasks\": 0,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"Raven Drive 51, 3 Inn Court, London, NW15LG\",\n \"related_to\": \"\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [\n \"http://arthur.localhost/public/attachments...\"\n ],\n \"document_urls\": [\n \"http://arthur.localhost/public/attachments...\"\n ],\n \"tags\": [\n \"one\",\n \"two\"\n ],\n \"api_notes\": \"\",\n \"modified\": \"2020-02-26T12:41:53+00:00\",\n \"created\": \"2020-02-26T12:40:29+00:00\"\n }\n]"}],"_postman_id":"27e9582f-001b-4ea9-8e7a-f16410d2cf2b"},{"name":"View Task On Property","id":"4d40544c-65db-4086-bbdc-7333e9342b77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tasks/{{task_id}}","description":"

This API endpoint retrieves the details of a single property task, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","tasks","{{task_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"9e09983c-0a3f-43e5-8acd-ac7f98b7c762","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tasks/{{task_id}}"},"status":"View Note On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Fix the boiler please\",\n \"total_subtasks\": 0,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"Swan Drive 51, 3 Wren Court, London, NW95DG\",\n \"related_to\": \"\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [\n \"z narni\",\n \"slay\"\n ],\n \"api_notes\": \"\",\n \"modified\": \"2020-02-26T10:49:28+00:00\",\n \"created\": \"2020-02-26T10:49:28+00:00\"\n }\n ]\n}"}],"_postman_id":"4d40544c-65db-4086-bbdc-7333e9342b77"},{"name":"Add Task On Property","id":"ca5af7e8-8711-4ed5-aff3-b986e21e70c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tasks","description":"

Use this endpoint to create a new task record for the property. The API will return the saved data and a unique task ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
task_type	Inspection	String	No
description	Radiator not working	String	Yes
tags	['one','two']	Array(String)	No
due_date	2020-10-11	Date	No
due_time	15:32	Time	No
assigned_managers	[123,1234]	Array(Integer)	No
emergency	True	Boolean	No
private	True	Boolean	No
api_notes	Landlord will be present	String	No
files (each object must contain \"file_type\", \"file_name\", and \"file\")	{ \"file_type\":\"application/pdf\", \"file_name\":\"testing\", \"file\":\"(base 64)\" }	[Array {Objects}]	No

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","tasks"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"322313b5-d4fd-43ea-8899-44b3a9d3f103","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"description\":\"Fix windows please\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tasks"},"status":"Add Task On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Fix windows please\",\n \"total_subtasks\": 0,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"51 Litchfield , 3 Raven Court, NS19SA\",\n \"related_to\": \"\",\n \"due_date\": null,\n \"due_time\": null,\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [],\n \"api_notes\": \"\",\n \"modified\": \"2020-03-05T12:17:07+00:00\",\n \"created\": \"2020-03-05T12:17:07+00:00\"\n }\n}"}],"_postman_id":"ca5af7e8-8711-4ed5-aff3-b986e21e70c3"},{"name":"Update Task On Property","id":"20654884-1b77-4e32-b3f1-c46ecc8c94a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tasks/{{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 property in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
task_type	Inspection	String	No
description	Radiator not working	String	No
tags	['one','two']	Array(String)	No
due_date	2020-10-11	Date	No
due_time	15:32	Time	No
assigned_managers	[123,1234]	Array(Integer)	No
emergency	True	Boolean	No
private	True	Boolean	No
api_notes	Landlord will be present	String	No

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","tasks","{{task_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e9204cc0-0e5e-4a58-b447-b5041e53e3d6","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"description\":\"Fix windows please updated\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tasks/{{task_id}}"},"status":"Update Task On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Fix windows please updated\",\n \"total_subtasks\": 0,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"51 Litchfield , 3 Raven Court, NS19SA\",\n \"related_to\": \"\",\n \"due_date\": null,\n \"due_time\": null,\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [],\n \"api_notes\": \"\",\n \"modified\": \"2020-03-05T12:17:07+00:00\",\n \"created\": \"2020-03-05T12:17:07+00:00\"\n }\n}"}],"_postman_id":"20654884-1b77-4e32-b3f1-c46ecc8c94a2"},{"name":"Delete Task On Property","id":"c53bc6c5-bb49-4649-b588-fd9539f25c07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tasks/{{task_id}}","description":"

This endpoint deletes an existing asset record using the task id, under a property ID

This section provides resources for dealing with Tasks related to a property.

\n","_postman_id":"f04180a3-7369-4957-bea4-55cc9ab5a0d6"},{"name":"Workorders","item":[{"name":"List Workorders On Property","id":"c454ef77-3fe5-41fc-bcfc-de499edb0a16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/workorders","description":"

This endpoint retrieves a list of workorders associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","workorders"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"58c4edcf-3c67-47e3-a1e0-d936b2e3fdf0","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/workorders"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": null,\n \"full_address\": null\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n },\n {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": null,\n \"full_address\": null\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n\n\n{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 0,\n \"full_address\": \"\"\n },\n \"unit\": {\n \"id\": null,\n \"full_address\": null\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"c454ef77-3fe5-41fc-bcfc-de499edb0a16"},{"name":"View Workorders On Property","id":"feae304d-2c07-4caf-8317-7676ac9967c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/workorders/{{workorder_id}}","description":"

This API endpoint retrieves the details of a single property workorder, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","workorders","{{workorder_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e1793313-e774-4138-a329-6b4d0aba0b1e","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/workorders/{{workorder_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": null,\n \"full_address\": null\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"feae304d-2c07-4caf-8317-7676ac9967c1"},{"name":"Create Workorders On Property","id":"d25c4db4-b838-4260-a108-ea2acd02f0dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/workorders","description":"

Use this endpoint to create a new workorder record for the property. The API will return the saved data and a unique workorder ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
title	workorder title	String	No
description	workorder description	String	No
invite_contractors	[123,1234]	Array(integer)	No
service_type	Carpet Layer	String	Yes
start_date	2020-02-20	Date	No
due_date	2020-02-20	Date	No
budget	1000,00	Float	No
allocated_time_hours	20	Float	No
actual_time_hours	20	Float	No
price_per_hour	7,90	Float	No
emergency	true	Boolean	No
quote_required	true	Boolean	No
share_assets	false	Boolean	No
hide_tenant_details	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","workorders"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"27746611-fe8c-4593-a436-1c44ff2a8356","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"service_type\":\"aerial network specialist\",\n \"title\":\"Workorder title\",\n \"description\":\"Workorder Description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/workorders"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 0,\n \"full_name\": \"\",\n \"status\": \"\"\n },\n \"invited_contractors\": [],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"unit address\"\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"d25c4db4-b838-4260-a108-ea2acd02f0dc"},{"name":"Update Workorders On Property","id":"be83e3c5-9290-4e14-a401-bdbc9b050ef2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/workorders/{{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 property in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
title	workorder title	String	No
description	workorder description	String	No
invite_contractors	[123,1234]	Array(integer)	No
service_type	Carpet Layer	String	No
start_date	2020-02-20	Date	No
due_date	2020-02-20	Date	No
budget	1000,00	Float	No
allocated_time_hours	20	Float	No
actual_time_hours	20	Float	No
price_per_hour	7,90	Float	No
emergency	true	Boolean	No
quote_required	true	Boolean	No
share_assets	false	Boolean	No
hide_tenant_details	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","workorders","{{workorder_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e8ac4a81-d231-4485-bb66-394f6b22ed32","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\":\"Updated title\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/workorders/{{workorder_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Updated title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": null,\n \"full_address\": null\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"be83e3c5-9290-4e14-a401-bdbc9b050ef2"}],"id":"3ec1fe8e-2adf-450a-845e-cfb147050492","description":"

This section provides resources for dealing with Workorders related to a property.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7b1e351e-fde8-4a31-815d-fececdbcf9d9"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1b186c3a-f000-489b-8f5d-67e50fe8cafc"}}],"_postman_id":"3ec1fe8e-2adf-450a-845e-cfb147050492"},{"name":"Utilities","item":[{"name":"List Utilities On Property","id":"3e65276f-e7ef-4f67-a4b7-d64df96ee0b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/utilities","description":"

This endpoint retrieves a list of utilities associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","utilities"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"4c1ce2b8-74c1-487d-b93f-ab0593490601","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/utilities"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 16016,\n \"type\": \"Broadband\",\n \"serial_number\": \"321K123AmX\",\n \"account_number\": \"39102712\",\n \"provider\": \"\",\n \"last_reading_value\": null,\n \"last_reading_date\": null,\n \"notes\": \"\",\n \"created_by\": {\n \"id\": 1,\n \"full_name\": \"Martin Zelazny\"\n },\n \"created\": \"2020-10-27T10:24:30+00:00\",\n \"modified\": \"2020-10-27T10:24:30+00:00\"\n },\n {\n \"id\": 16015,\n \"type\": \"Electric\",\n \"serial_number\": \"321K123AmX\",\n \"account_number\": \"39102712\",\n \"provider\": \"\",\n \"last_reading_value\": \"89212\",\n \"last_reading_date\": \"2020-10-27\",\n \"notes\": \"\",\n \"created_by\": {\n \"id\": 1,\n \"full_name\": \"Martin Zelazny\"\n },\n \"created\": \"2020-10-27T10:14:16+00:00\",\n \"modified\": \"2020-10-27T10:14:16+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"3e65276f-e7ef-4f67-a4b7-d64df96ee0b4"},{"name":"Create Utility On Property","id":"1e7c0751-6375-4d86-b45b-7cc92357f7aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/utilities","description":"

Use this endpoint to create a new utility record for the property. The API will return the saved data and a unique utility ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
type	gas	String	Yes
notes	behind back doors	String	No
serial_number	GA212FP21	String	No
account_number	12344321	string	No
provider	company_name	string	No

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","utilities"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"60fd65eb-2c22-4360-b4f4-04f8d22b8051","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"gas\",\n \"serial_number\":\"Created serial number\",\n \"account_number\": \"12344321\",\n \"provider\": \"\",\n \"last_reading_value\": null,\n \"last_reading_date\": null,\n \"notes\": \"\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/utilities"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"type\": \"gas\",\n \"serial_number\":\"Created serial number\",\n \"account_number\": \"12344321\",\n \"provider\": \"\",\n \"last_reading_value\": null,\n \"last_reading_date\": null,\n \"notes\": \"\",\n \"created_by\": {\n \"id\": 1,\n \"full_name\": \"Brian Shawn\"\n },\n \"created\": \"2020-10-27T10:24:30+00:00\",\n \"modified\": \"2020-10-27T10:24:30+00:00\"\n }\n}"}],"_postman_id":"1e7c0751-6375-4d86-b45b-7cc92357f7aa"}],"id":"ac77058c-1edf-463e-a448-8ac8388ac402","description":"

This section provides resources for dealing with Utilities related to a property.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"aa896095-1f50-4f0f-9f08-0df66b581697"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"753f4c2e-98a8-49fa-8375-b2b403d57ffc"}}],"_postman_id":"ac77058c-1edf-463e-a448-8ac8388ac402"},{"name":"Transactions","item":[{"name":"List Transactions On Property","id":"c3b3948f-c347-49aa-96a0-f72cecc77afa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/transactions","description":"

This retrieves a list of transactions for a Property

See available filters below to customize the list of transactions returned.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","transactions"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

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

\n","type":"text/plain"},"key":"statement","value":""},{"disabled":true,"description":{"content":"

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.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"date_from","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"date_to","value":""}],"variable":[]}},"response":[],"_postman_id":"c3b3948f-c347-49aa-96a0-f72cecc77afa"}],"id":"729cb440-6c2f-4801-895a-eb3e2001dada","description":"

This section provides resources for dealing with Transactions related to a property.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"004823d4-978a-44dd-a7c5-853c51ab0b17"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5dfc2557-89c4-4bd5-8879-989244dbe728"}}],"_postman_id":"729cb440-6c2f-4801-895a-eb3e2001dada"},{"name":"Tags","item":[{"name":"🆕 List Tags on Property","id":"9bf6324d-5410-4bc2-aa09-f8dea0bc7a1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tags","description":"

This endpoint retrieves a list of tags associated with the given property ID.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"1a6aa291-c0aa-4b45-a9a1-895ef4493ca6","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 33843,\n \"name\": \"1000 spend limit\",\n \"color\": \"blue\"\n },\n {\n \"id\": 49572,\n \"name\": \"benefits lapsed\",\n \"color\": \"blue\"\n }\n ]\n}"}],"_postman_id":"9bf6324d-5410-4bc2-aa09-f8dea0bc7a1c"},{"name":"Tag Property","id":"34c09069-eb38-4922-b5f7-ec273b33e9ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tags","description":"

Use this endpoint to create a new tag record for the property. The API will return the saved data and a unique tag ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	[\"123\"]	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"f60a7a9d-b275-44d5-a10e-238ec69e310d","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":[\"1234\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/tags"},"status":"Tag Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1234,\n \"name\": \"Tag one\",\n \"color\": \"orange\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 12,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"34c09069-eb38-4922-b5f7-ec273b33e9ca"},{"name":"Untag Property","id":"3e040bb5-402a-444e-973f-924b2e451331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/untag","description":"

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.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	\"1234\"	String	Yes

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","untag"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"cd9dab4b-f6a0-4cee-992f-9228aab3d8a0","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":\"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/untag"},"status":"Untag Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"3e040bb5-402a-444e-973f-924b2e451331"},{"name":"Untag All Property Tags","id":"6a004c7a-5c53-4c23-9ef7-3ee147e8eee6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/untag_all","description":"

Use this endpoint to unassign all tags from the property.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}","untag_all"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e742a7d0-382b-4c4b-a16e-5e9e5a0c001e","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}/untag_all"},"status":"Untag All Property Tags","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"6a004c7a-5c53-4c23-9ef7-3ee147e8eee6"}],"id":"a804582e-8535-45cf-b04c-2f1bae11adda","description":"

This section provides resources for dealing with Tags related to a property.

\n","_postman_id":"a804582e-8535-45cf-b04c-2f1bae11adda"},{"name":"List Properties","id":"9612ba46-550b-4623-bb31-9a97510a71ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties","description":"

This retrieves a list of properties.

See available filters below to customize the list of properties returned.

\n","urlObject":{"protocol":"https","path":["v2","properties"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by the full address of the property

\n","type":"text/plain"},"key":"full_address","value":""},{"disabled":true,"description":{"content":"

Filter by the address 1 field of the property

\n","type":"text/plain"},"key":"address_1","value":""},{"disabled":true,"description":{"content":"

Filter by the address 2 field of the property

\n","type":"text/plain"},"key":"address_2","value":""},{"disabled":true,"description":{"content":"

Filter by the city of the property

\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"

Filter by the county of the property

\n","type":"text/plain"},"key":"county","value":""},{"disabled":true,"description":{"content":"

Filter by the area ID of the property

\n","type":"text/plain"},"key":"area_id","value":""},{"disabled":true,"description":{"content":"

Filter by the postcode of the property

\n","type":"text/plain"},"key":"postcode","value":""},{"disabled":true,"description":{"content":"

Use this parameter to filter by the type of property

\n","type":"text/plain"},"key":"property_type","value":""},{"disabled":true,"description":{"content":"

Filter based on the number of units available for rent

\n","type":"text/plain"},"key":"rentable_units","value":""},{"disabled":true,"description":{"content":"

Filter based on the current status of units, including Available To Let, Under Offer, Let, and Unavailable to Let

\n","type":"text/plain"},"key":"unit_status","value":""},{"disabled":true,"description":{"content":"

Filter by tags associated with the property, which should be provided as a comma-separated list

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter based on the management status of the property (boolean)

\n","type":"text/plain"},"key":"i_manage_this","value":""},{"disabled":true,"description":{"content":"

Filter by the ID of the letting agent associated with the property

\n","type":"text/plain"},"key":"letting_agent_id","value":""},{"disabled":true,"description":{"content":"

Filter by the ID of the owner of the property

\n","type":"text/plain"},"key":"property_owner_id","value":""},{"disabled":true,"description":{"content":"

Filter by keyword

\n","type":"text/plain"},"key":"_q","value":""}],"variable":[]}},"response":[{"id":"1258abb0-fb8a-450b-8c1e-33715be7762d","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n \t{\n\t\t \"id\": 121619,\n \"property_type\": \"Residential Block\",\n \"property_description\": \"multi\",\n \"ref\": \"reference\",\n \"full_address\": \"full address\",\n \"address_line_1\": \"address line 1\",\n \"address_line_2\": \"address line 2\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country\": \"country\",\n \"area\": \"\",\n \"postcode\": \"postcode\",\n \"total_units\": 3,\n \"rentable_units\": 0,\n \"letting_agent_id\": null,\n \"property_owner_id\": 123,\n \"property_owner_full_name\": \"New Company\",\n \"max_occupancy\": \"N/A\",\n \"bathrooms\": \"N/A\",\n \"floors\": \"\",\n \"bedrooms\": \"N/A\",\n \"receptions\": \"N/A\",\n \"smart_meters\": \"\",\n \"council_tax_band\": \"N/A\",\n \"council_account_no\": \"\",\n \"council_id\": null,\n \"portal_market_rent\": 0,\n \"portal_market_rent_frequency\": \"\",\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [],\n \"property_features\": [],\n \"additional_features\": [],\n \"tags\": [],\n \"notes\": [],\n \"i_manage_this\": true,\n \"latitude\": null,\n \"longitude\": null,\n \"custom_fields\": [],\n \"modified\": \"2021-01-19T11:35:10+00:00\",\n \"created\": \"2021-01-19T11:35:10+00:00\"\n\t\t}\n\t],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n"}],"_postman_id":"9612ba46-550b-4623-bb31-9a97510a71ae"},{"name":"View Property","id":"f093779b-ab53-431c-b267-a024c1d5479e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}","description":"

This API endpoint retrieves the details of a single property, identified by its unique property_id.

Use this endpoint to view the specific details of a property.

\n","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"c5acffba-b0bb-4eaf-95c7-7d8b8014a578","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 121619,\n \"property_type\": \"Residential Block\",\n \"property_description\": \"multi\",\n \"ref\": \"reference\",\n \"full_address\": \"full address\",\n \"address_line_1\": \"address line 1\",\n \"address_line_2\": \"address line 2\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country\": \"country\",\n \"area\": \"\",\n \"postcode\": \"postcode\",\n \"total_units\": 3,\n \"rentable_units\": 0,\n \"letting_agent_id\": null,\n \"property_owner_id\": 123,\n \"property_owner_full_name\": \"New Company\",\n \"max_occupancy\": \"N/A\",\n \"bathrooms\": \"N/A\",\n \"floors\": \"\",\n \"bedrooms\": \"N/A\",\n \"receptions\": \"N/A\",\n \"smart_meters\": \"\",\n \"council_tax_band\": \"N/A\",\n \"council_account_no\": \"\",\n \"council_id\": null,\n \"portal_market_rent\": 0,\n \"portal_market_rent_frequency\": \"\",\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [],\n \"property_features\": [],\n \"additional_features\": [],\n \"tags\": [],\n \"notes\": [],\n \"i_manage_this\": true,\n \"latitude\": null,\n \"longitude\": null,\n \"custom_fields\": [],\n \"modified\": \"2021-01-19T11:35:10+00:00\",\n \"created\": \"2021-01-19T11:35:10+00:00\"\n }\n}"}],"_postman_id":"f093779b-ab53-431c-b267-a024c1d5479e"},{"name":"Add Property","id":"ee040a7e-a04e-4af4-8b54-50093a8757a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/properties","description":"

Use this endpoint to create a new property. The API will return the saved data and a unique Property ID.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Required?
property_type	Residential	String	No
ref	My big property	String	Yes
address_line_1	Arthur House	String	Yes
address_line_2	123 Property Street	String	No
city	Stevenage	String	No
county	Hertfordshire	String	No
country	United Kingdom	String	No
area	South East	Simple	No
postcode	AB1 2CD	String	No
letting_agent_id	4567	Integer	No
property_owner_id	5678	Integer	Yes
max_occupancy	4	String	No
bathrooms	2	String	No
floors	2	String	No
bedrooms	3	String	No
receptions	1	String	No
smart_meters	1	String	No
council_tax_band	B	String	No
council_account_no	ABC123	String	No
council_id	6789	Integer	No
portal_market_rent	850.00	Float	No
portal_market_rent_frequency	Weekly	String	No
features	[ \"Internet\", \"Fireplace\", \"Smart home integration\" ]	Array (String)	No
tags	[ \"Cheap Rent\" ]	Array (String)	No
i_manage_this	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","properties"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source

\n","type":"text/plain"},"key":"strict","value":"true"}],"variable":[]}},"response":[{"id":"98021183-67e4-44e5-a7e1-9bd7dec88f6b","name":"Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"property_type\": \"Residential\",\n \"ref\": \"My big property\",\n \"address_line_1\": \"Arthur House\",\n \"address_line_2\": \"123 Property Street\",\n \"city\": \"Stevenage\",\n \"county\": \"Hertfordshire\",\n \"country\": \"United Kingdom\",\n \"area\": \"South East\",\n \"postcode\": \"AB1 2CD\",\n \"letting_agent_id\": 49470,\n \"property_owner_id\": 265389,\n \"max_occupancy\": \"4\",\n \"bathrooms\": \"2\",\n \"floors\": \"2\",\n \"bedrooms\": \"3\",\n \"receptions\": \"1\",\n \"smart_meters\": \"0\",\n \"council_tax_band\": \"B\",\n \"council_account_no\": \"ABC123\",\n \"council_id\": 33624,\n \"portal_market_rent\": 850.00,\n \"portal_market_rent_frequency\": \"Weekly\",\n \"features\": [\n \t\"Internet\",\n \t\"Fireplace\",\n \t\"Smart home integration\"\n\t],\n \"tags\": [\n\t\t\"Cheap Rent\"\n\t],\n \"i_manage_this\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 282789,\n \"property_type\": \"Residential\",\n \"property_description\": \"single\",\n \"ref\": \"My big property\",\n \"full_address\": \"My big property, Arthur House, 123 Property Street, Stevenage, Hertfordshire, AB1 2CD, United Kingdom (South East)\",\n \"address_line_1\": \"Arthur House\",\n \"address_line_2\": \"123 Property Street\",\n \"city\": \"Stevenage\",\n \"county\": \"Hertfordshire\",\n \"country\": \"United Kingdom\",\n \"area\": \"South East\",\n \"postcode\": \"AB1 2CD\",\n \"lat\": 51.903761,\n \"lng\": -0.196612,\n \"total_units\": 1,\n \"rentable_units\": 1,\n \"letting_agent_id\": 49470,\n \"property_owner_id\": 265389,\n \"property_owner_full_name\": \"2nd PM Account\",\n \"max_occupancy\": \"4\",\n \"bathrooms\": \"2\",\n \"floors\": \"2\",\n \"bedrooms\": \"3\",\n \"receptions\": \"1\",\n \"smart_meters\": \"No\",\n \"council_tax_band\": \"B\",\n \"council_account_no\": \"ABC123\",\n \"council_id\": 33624,\n \"portal_market_rent\": 850,\n \"portal_market_rent_frequency\": \"Weekly\",\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [\n \"Fireplace\",\n \"Internet\",\n \"Smart home integration\"\n ],\n \"property_features\": [\n \"Fireplace\",\n \"Internet\"\n ],\n \"additional_features\": [\n \"Smart home integration\"\n ],\n \"tags\": [],\n \"notes\": [],\n \"i_manage_this\": true,\n \"latitude\": 51.903761,\n \"longitude\": -0.196612,\n \"custom_fields\": [],\n \"modified\": \"2023-02-28T13:05:57\",\n \"created\": \"2023-02-28T13:05:57\"\n }\n}"}],"_postman_id":"ee040a7e-a04e-4af4-8b54-50093a8757a3"},{"name":"Update Property","id":"7e0178ef-789a-4423-8b58-2f160510fe84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.arthuronline.co.uk/v2/properties/{{property_id}}","description":"

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.

Supported Fields

The following fields are supported for the request body

Field	Example	Type
property_type	Residential	String
ref	My big property	String
address_line_1	Arthur House	String
address_line_2	123 Property Street	String
city	Stevenage	String
county	Hertfordshire	String
country	United Kingdom	String
area	South East	Simple
postcode	AB1 2CD	String
letting_agent_id	4567	Integer
property_owner_id	5678	Integer
max_occupancy	4	String
bathrooms	2	String
floors	2	String
bedrooms	3	String
receptions	1	String
smart_meters	1	String
council_tax_band	B	String
council_account_no	ABC123	String
council_id	6789	Integer
portal_market_rent	850.00	Float
portal_market_rent_frequency	Weekly	String
features	[ \"Internet\", \"Fireplace\", \"Smart home integration\" ]	Array (String)
tags	[ \"Cheap Rent\" ]	Array (String)
i_manage_this	true	Boolean

","urlObject":{"protocol":"https","path":["v2","properties","{{property_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"7a849c9e-696a-4486-b65a-f3065b3d0f3a","name":"Example","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"property_type\": \"Residential\",\n \"ref\": \"My big property\",\n \"address_line_1\": \"Arthur House\",\n \"address_line_2\": \"123 Property Street\",\n \"city\": \"Stevenage\",\n \"county\": \"Hertfordshire\",\n \"country\": \"United Kingdom\",\n \"area\": \"South East\",\n \"postcode\": \"AB1 2CD\",\n \"letting_agent_id\": 49470,\n \"property_owner_id\": 265389,\n \"max_occupancy\": \"4\",\n \"bathrooms\": \"2\",\n \"floors\": \"2\",\n \"bedrooms\": \"3\",\n \"receptions\": \"1\",\n \"smart_meters\": \"0\",\n \"council_tax_band\": \"B\",\n \"council_account_no\": \"ABC123\",\n \"council_id\": 33624,\n \"portal_market_rent\": 850.00,\n \"portal_market_rent_frequency\": \"Weekly\",\n \"features\": [\n \t\"Internet\",\n \t\"Fireplace\",\n \t\"Smart home integration\"\n\t],\n \"tags\": [\n\t\t\"Cheap Rent\"\n\t],\n \"i_manage_this\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/properties/282789"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 282789,\n \"property_type\": \"Residential\",\n \"property_description\": \"single\",\n \"ref\": \"My big property\",\n \"full_address\": \"My big property, Arthur House, 123 Property Street, Stevenage, Hertfordshire, AB1 2CD, United Kingdom (South East)\",\n \"address_line_1\": \"Arthur House\",\n \"address_line_2\": \"123 Property Street\",\n \"city\": \"Stevenage\",\n \"county\": \"Hertfordshire\",\n \"country\": \"United Kingdom\",\n \"area\": \"South East\",\n \"postcode\": \"AB1 2CD\",\n \"lat\": 51.903761,\n \"lng\": -0.196612,\n \"total_units\": 1,\n \"rentable_units\": 1,\n \"letting_agent_id\": 49470,\n \"property_owner_id\": 265389,\n \"property_owner_full_name\": \"2nd PM Account\",\n \"max_occupancy\": \"4\",\n \"bathrooms\": \"2\",\n \"floors\": \"2\",\n \"bedrooms\": \"3\",\n \"receptions\": \"1\",\n \"smart_meters\": \"No\",\n \"council_tax_band\": \"B\",\n \"council_account_no\": \"ABC123\",\n \"council_id\": 33624,\n \"portal_market_rent\": 850,\n \"portal_market_rent_frequency\": \"Weekly\",\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [\n \"Fireplace\",\n \"Internet\",\n \"Smart home integration\"\n ],\n \"property_features\": [\n \"Fireplace\",\n \"Internet\"\n ],\n \"additional_features\": [\n \"Smart home integration\"\n ],\n \"tags\": [],\n \"notes\": [],\n \"i_manage_this\": true,\n \"latitude\": 51.903761,\n \"longitude\": -0.196612,\n \"custom_fields\": [],\n \"modified\": \"2023-02-28T13:05:57\",\n \"created\": \"2023-02-28T13:05:57\"\n }\n}"}],"_postman_id":"7e0178ef-789a-4423-8b58-2f160510fe84"}],"id":"09e539d2-8e01-446d-9ba6-47ed2318f220","description":"

Here you'll find a complete list of endpoints for the Properties area of the system, which covers assets, certificates, conversations, general information, notes, units, tenancies, tasks, work orders, utilities, transactions, and tags.

Each folder provides endpoints related to the property area, along with examples where applicable.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"457c0dcd-ca04-4ace-abcd-07ab50eacd12"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ed2aa78c-8a7e-4ef8-9d1d-1b7859a42038"}}],"_postman_id":"09e539d2-8e01-446d-9ba6-47ed2318f220"},{"name":"Units","item":[{"name":"Property","item":[{"name":"View parent Property","id":"17dba644-731e-4a90-aa42-f24a9918458d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/property","description":"

This endpoint retrieves the property associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","property"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"0a77b8ab-f47d-4c85-b9cd-8cd1dba86b65","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/property"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 121619,\n \"property_type\": \"Residential Block\",\n \"property_description\": \"multi\",\n \"ref\": \"reference\",\n \"full_address\": \"full address\",\n \"address_line_1\": \"address line 1\",\n \"address_line_2\": \"address line 2\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country\": \"country\",\n \"area\": \"\",\n \"postcode\": \"postcode\",\n \"total_units\": 3,\n \"rentable_units\": 0,\n \"letting_agent_id\": null,\n \"property_owner_id\": 123,\n \"property_owner_full_name\": \"New Company\",\n \"max_occupancy\": \"N/A\",\n \"bathrooms\": \"N/A\",\n \"floors\": \"\",\n \"bedrooms\": \"N/A\",\n \"receptions\": \"N/A\",\n \"smart_meters\": \"\",\n \"council_tax_band\": \"N/A\",\n \"council_account_no\": \"\",\n \"council_id\": null,\n \"portal_market_rent\": 0,\n \"portal_market_rent_frequency\": \"\",\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [],\n \"property_features\": [],\n \"additional_features\": [],\n \"tags\": [],\n \"notes\": [],\n \"i_manage_this\": true,\n \"latitude\": null,\n \"longitude\": null,\n \"custom_fields\": [],\n \"modified\": \"2021-01-19T11:35:10+00:00\",\n \"created\": \"2021-01-19T11:35:10+00:00\"\n }\n}"}],"_postman_id":"17dba644-731e-4a90-aa42-f24a9918458d"}],"id":"db9674a0-0eb5-4109-a16c-f673b69d3f78","description":"

This section provides resources for accessing the Property record related to a unit.

\n","_postman_id":"db9674a0-0eb5-4109-a16c-f673b69d3f78"},{"name":"Assets","item":[{"name":"List Assets On Unit","id":"a167cb93-708c-45e4-8355-7de0a65b84e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/assets","description":"

This endpoint retrieves a list of assets associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"c3a29d70-e65a-4193-aeda-e1f6046d7896","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \" Inventory\",\n \"description\": \" Inventory\",\n \"created_by\": {\n \"full_name\": \"Brian Williams\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Inventory\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Inventory\",\n \"model_id\": 123\n },\n {\n \"id\": 123,\n \"model\": \"Unit\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-06-23T11:13:02+01:00\",\n \"modified\": \"2020-06-23T11:13:02+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"a167cb93-708c-45e4-8355-7de0a65b84e4"},{"name":"Create Asset On Unit","id":"bcb87406-19d3-46a1-9283-b0f197bd905f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/assets","description":"

Use this endpoint to create a new asset related to a unit. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
asset_type	image	String	No
name	inventory	String	No
share_manager	true	Boolean	No
share_tenant	false	Boolean	No
share_contractor	true	Boolean	No
share_owner	true	Boolean	No
file	base64	String	Yes
mime_type	application/pdf	String	Yes
file_name	inventory	String	Yes

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"cfe4358d-869e-4a0a-b140-cf640c87b922","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset_type\":\"image\",\n\t\"name\":\"name of asset\",\n\t\"share_manager\":true,\n\t\"share_tenant\":true,\n\t\"share_owner\":true,\n\t\"share_contractor\":true,\n\t\"file\":\"pdf file converted to base64 string\",\n\t\"mime_type\":\"application/pdf\",\n\t\"file_name\":\"inventory\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"name of asset\",\n \"description\": null,\n \"created_by\": {\n \"full_name\": \"Brian Willson\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Image\",\n \"share_manager\": true,\n \"share_owner\": true,\n \"share_tenant\": true,\n \"share_contractor\": true,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Unit\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-07-03T09:25:52+01:00\",\n \"modified\": \"2020-07-03T09:25:52+01:00\"\n }\n}"}],"_postman_id":"bcb87406-19d3-46a1-9283-b0f197bd905f"}],"id":"e08ee308-c2ee-47bc-bcdd-97adf5b4da84","description":"

This section provides resources for dealing with assets related to a unit.

\n","_postman_id":"e08ee308-c2ee-47bc-bcdd-97adf5b4da84"},{"name":"Certificates","item":[{"name":"List Certificates On Unit","id":"a6837da5-cec0-43fc-89e7-1b6965e1a654","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/certificates","description":"

This endpoint retrieves a list of certificates associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","certificates"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"c05a552e-bf4b-4a37-8561-2ab74a1d476f","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/certificates"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 12345,\n \"type\": \"Gas Safety\",\n \"expiry_date\": \"2021-06-06\",\n \"status\": \"Expired\",\n \"missing\": false,\n \"file\": {\n \"id\": 12345,\n \"download_url\": \"https://asset.arthuronline.co.uk/download/{uuid}\",\n \"mime_type\": \"image/jpeg\"\n },\n \"property\": {\n \"id\": 1234,\n \"address\": \"Multiple Unit Property, test, ABC 123\"\n },\n \"unit\": {\n \"id\": 123,\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"tenancy\": {\n \"id\": 123456,\n \"ref\": \"TE1000\",\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"notes\": \"My Certificate Notes\",\n \"share_manager\": true,\n \"share_tenant\": false,\n \"share_contractor\": true,\n \"share_owner\": false,\n \"created\": \"2021-01-01T12:00:00\",\n \"modified\": \"2021-01-01T12:00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"a6837da5-cec0-43fc-89e7-1b6965e1a654"},{"name":"Add Certificate on Unit","id":"82dd114a-9ac9-412e-8def-528bf11cab4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"Boiler Service\",\n \"expiry_date\" : \"2022-02-28\",\n \"notes\" : \"Fully assessed\",\n \"file\" : \"JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjE2Ljg5NjAgVGQNCiggdGV4dC4gQW5kIG1vcmUgdGV4dC4gQm9yaW5nLCB6enp6ei4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjA0Ljk0NDAgVGQNCiggbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDU5Mi45OTIwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTY5LjA4ODAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NTcuMTM2MCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBFdmVuIG1vcmUuIENvbnRpbnVlZCBvbiBwYWdlIDIgLi4uKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjYgMCBvYmoNCjw8DQovVHlwZSAvUGFnZQ0KL1BhcmVudCAzIDAgUg0KL1Jlc291cmNlcyA8PA0KL0ZvbnQgPDwNCi9GMSA5IDAgUiANCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBTaW1wbGUgUERGIEZpbGUgMiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIC4uLmNvbnRpbnVlZCBmcm9tIHBhZ2UgMS4gWWV0IG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NzYuNjU2MCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY2NC43MDQwIFRkDQooIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiBCdXQgbm90IGFzIGJvcmluZyBhcyB3YXRjaGluZyApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY1Mi43NTIwIFRkDQooIHBhaW50IGRyeS4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NDAuODAwMCBUZA0KKCBCb3JpbmcuICBNb3JlLCBhIGxpdHRsZSBtb3JlIHRleHQuIFRoZSBlbmQsIGFuZCBqdXN0IGFzIHdlbGwuICkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo4IDAgb2JqDQpbL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZVwpKQ0KL1Byb2R1Y2VyIChOZXZyb25hIERlc2lnbnMpDQovQ3JlYXRpb25EYXRlIChEOjIwMDYwMzAxMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQowIDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgbg0KMDAwMDAwMDA5MyAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg==\",\n \"mime_type\" : \"application/pdf\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/certificates","description":"

Use this endpoint to create a new certificate related to a property. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
type	Boiler Service	String	Yes
expiry_date	2023-12-05	String	No
notes	Fully assessed	String	No
file	Base64	String	No
mime_type	application/pdf	String	No (Required if File field is present)
file_name	Certificate Document	string	No (Required if File field is present)

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","certificates"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"0d85b603-4edc-4623-b3a6-59ae16cc3bf5","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"x-entityid","value":"","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/certificates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 875729,\n \"type\": \"Boiler Service \",\n \"expiry_date\": \"2022-02-28\",\n \"status\": \"Expired\",\n \"missing\": false,\n \"file\": {\n \"id\": 5740763,\n \"download_url\": \"https://asset.arthuronline.co.uk/download/e62146f5-53a0-41df-a31b-b0f7b99644b9\",\n \"mime_type\": \"application/pdf\"\n },\n \"property\": {\n \"id\": 282789,\n \"address\": \"My big property, Arthur House, 123 Property Street, Stevenage, Hertfordshire, AB1 2CD\"\n },\n \"unit\": {\n \"id\": 0,\n \"address\": \"\"\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null,\n \"address\": null\n },\n \"notes\": \"Fully assessed\",\n \"share_manager\": true,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"share_owner\": false,\n \"created\": \"2023-02-28T14:50:47\",\n \"modified\": \"2023-02-28T14:50:47\"\n }\n}"}],"_postman_id":"82dd114a-9ac9-412e-8def-528bf11cab4f"}],"id":"9e873f10-76c9-4310-a44c-380778d91416","description":"

This section provides resources for dealing with certificates related to a unit.

\n","_postman_id":"9e873f10-76c9-4310-a44c-380778d91416"},{"name":"Conversations","item":[{"name":"Conversation Recipients","item":[{"name":"Get Recipients for Unit","id":"48f41259-cab4-4469-8d4e-784e3b11633c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/conversation_recipients","description":"

This endpoint retrieves a list of conversation recipients on a unit record, identified by its unique unit_id.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","conversation_recipients"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"dd239cc2-09f3-4b59-aeb3-c0a63039a1d5","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/conversation_recipients"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Henry\",\n \"last_name\": \"Williams\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 2,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Mike\",\n \"last_name\": \"Marky\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 3,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Josh\",\n \"last_name\": \"Jackson\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 4,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Brian\",\n \"last_name\": \"Shaw\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n }\n ]\n}"}],"_postman_id":"48f41259-cab4-4469-8d4e-784e3b11633c"}],"id":"56b7b7d0-a728-49d5-86f8-981b5a464515","description":"

Here you can find the full list of endpoints for the Conversation Receipients area of the system, related to a Unit record.

\n","_postman_id":"56b7b7d0-a728-49d5-86f8-981b5a464515"},{"name":"List Conversation On Unit","id":"b7c9befa-18bb-4ac3-a96f-7c1b408d45fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/conversations","description":"

This endpoint retrieves a list of conversations associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"87c4fcd5-d829-442d-b7f2-4b8e2950a77c","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Lorem ipsum topic\",\n \"message_count\": 1,\n \"model\": \"Unit\",\n \"model_id\": 2,\n \"created_by\": {\n \"id\": 3,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 4,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Lorem ipsum content\",\n \"created\": \"2020-03-05T15:12:54+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-03-05T15:12:54+01:00\",\n \"modified\": \"2020-03-05T15:12:54+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"b7c9befa-18bb-4ac3-a96f-7c1b408d45fa"},{"name":"Create Conversation On Unit","id":"72066822-560a-4592-af55-3d5ab4c65a9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/conversations","description":"

Use this endpoint to create a new conversation related to a unit. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
message	It's done	String	Yes
subject	Meeting tomorrow	String	Yes
person_ids	['1','2']	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ff85fb6e-1dd3-44af-9d29-c84357ae38b0","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"message\":\"Please clean the house on friday.\",\n\t\"subject\":\"House duties\",\n\t\"person_ids\":[\"21\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"House duties\",\n \"message_count\": 1,\n \"model\": \"Unit\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 2,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 21,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Please clean the house on friday.\",\n \"created\": \"2020-03-05T15:06:26+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-03-05T15:06:26+01:00\",\n \"modified\": \"2020-03-05T15:06:26+01:00\"\n }\n}"}],"_postman_id":"72066822-560a-4592-af55-3d5ab4c65a9d"}],"id":"096d6801-e057-4c85-97e7-0202a3d47d01","description":"

This section provides resources for dealing with conversations related to a unit.

\n","_postman_id":"096d6801-e057-4c85-97e7-0202a3d47d01"},{"name":"General Information","item":[{"name":"List General Info for Unit","id":"4f47a368-83c6-4eb3-b1f9-22dd1836ca6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/faqs","description":"

This endpoint retrieves a list of general information records associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","faqs"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"72699514-9630-4b90-b673-962382a7f47e","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/faqs"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 12345,\n \"property_id\": 123,\n \"unit_id\": 1234,\n \"title\": \"Our website\",\n \"faq_type\": \"URL\",\n \"description\": \"https://www.arthuronline.co.uk\",\n \"shared_with\": [\n \"Property Owner\",\n \"Tenants\"\n ],\n \"modified\": \"2019-05-28T12:00:00+00:00\",\n \"created\": \"2019-05-28T12:00:00+00:00\"\n },\n {\n \"id\": 12344,\n \"property_id\": 123,\n \"unit_id\": null,\n \"title\": \"Our other website\",\n \"faq_type\": \"URL\",\n \"description\": \"https://www.arthuronline.com\",\n \"shared_with\": [\n \"Property Owner\",\n \"Tenants\"\n ],\n \"modified\": \"2019-05-27T12:00:00+00:00\",\n \"created\": \"2019-05-27T12:00:00+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"4f47a368-83c6-4eb3-b1f9-22dd1836ca6a"},{"name":"Add General Info for Unit","id":"eede49fc-8f3d-4e70-bded-9548a075767d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/faqs","description":"

Use this endpoint to create a new general information record for the unit. The API will return the saved data and a unique general information ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type
title	Maintenance	String
description	Weekly clean	String
faq_type	General	String
share_owner	true	Boolean
share_tenant	true	Boolean
share_contractor	false	Boolean

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","faqs"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"5ba58fef-26e7-4f49-93a3-466c5f31a08b","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\" : \"Maintenance - Weekly Clean\",\n \"description\" : \"Once a week the main hall will be cleaned\",\n \"faq_type\": \"General\",\n \"share_owner\": true,\n \"share_tenant\": true,\n \"share_contractor\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/faqs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Feb 2023 13:33:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"13b-zobeyQfSuTE39r6FBLg9R1GHe/g\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=YP4ULcsIqigIj6hjYecs7njwnKd2ISSW2%2B6hK8DyZh5jObyC0aX0zsfELXP8RjKZDtQP8OpdGqk5A02akpCb2WoF9rCUI1uvOb4dsnlS9WWWeXdGm%2FK5pTIOyqrIZqccwGAPaCQ%2Bytw%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7a0987e678f9416b-LHR"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 35767,\n \"property_id\": 282789,\n \"unit_id\": null,\n \"title\": \"Maintenance - Weekly Clean\",\n \"faq_type\": \"General\",\n \"description\": \"Once a week the main hall will be cleaned\",\n \"created_by\": {\n \"id\": 1817080,\n \"full_name\": \"API Documentation\"\n },\n \"share_owner\": true,\n \"share_contractor\": true,\n \"share_tenant\": true,\n \"modified\": \"2023-02-28T13:33:14\",\n \"created\": \"2023-02-28T13:33:14\"\n }\n}"}],"_postman_id":"eede49fc-8f3d-4e70-bded-9548a075767d"}],"id":"7e852f54-7d65-4571-8e38-689ef28262b1","description":"

This section provides resources for dealing with general information related to a unit.

\n","_postman_id":"7e852f54-7d65-4571-8e38-689ef28262b1"},{"name":"Notes","item":[{"name":"List Notes On Unit","id":"d1ec1b4c-d8fe-4e84-99a8-d35a2f365934","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/notes","description":"

This endpoint retrieves a list of notes associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"3e03d9b0-f3cc-45c6-a308-1bb0c877290f","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/notes"},"status":"List Notes On Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\t \"last_edited_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t\t },\n \t \"last_edited_date\": \"2020-04-20T11:53:42+01:00\",\n \"tags\": [\n \t{\n \"id\": 19601,\n \"name\": \"two\"\n }\n ],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:51:55+01:00\",\n \t\"modified\": \"2020-05-28T12:09:34+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n"}],"_postman_id":"d1ec1b4c-d8fe-4e84-99a8-d35a2f365934"},{"name":"View Note On Unit","id":"870c5c8f-426a-4557-830d-526d754e83cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/notes/{{note_id}}","description":"

This API endpoint retrieves the details of a single note, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"5ae31485-a81f-45f9-ae4a-36297f4a56a3","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/notes/{{note_id}}"},"status":"View Note On Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Interesting\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": null,\n \"full_name\": null\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"870c5c8f-426a-4557-830d-526d754e83cd"},{"name":"Add Note On Unit","id":"bb2124f9-dbc7-4a47-83e5-9ebe761bb289","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/notes","description":"

Use this endpoint to create a new note record for the unit. The API will return the saved data and a unique note ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	Yes

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"718dd02c-10ca-4b62-ad39-3dc410f1cf32","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\":\"Remember this note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/notes"},"status":"Add Note On Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": null,\n \"full_name\": null\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"bb2124f9-dbc7-4a47-83e5-9ebe761bb289"},{"name":"Update Note On Unit","id":"79ed18d7-f1f4-4a61-89c2-f06132b723cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/notes/{{note_id}}","description":"

This endpoint updates an existing note using the same fields as the 'Add Note' endpoint. The API will return the updated data for the unit in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	No
tags	['one','two']	Array(String)	No

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"2e6e89cf-2c7d-4430-a5be-771d50a0f0c1","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\":\"Updated Note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/notes/{{note_id}}"},"status":"Update Note On Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Updated Note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [\n \t\"one\",\n \t\"two\"\n ],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"79ed18d7-f1f4-4a61-89c2-f06132b723cc"},{"name":"Delete Note On Unit","id":"a838c095-8fb9-408d-a0ec-e6ed10c2e3ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/notes/{{note_id}}","description":"

This endpoint deletes an existing note using the note id.

This section provides resources for dealing with notes related to a unit.

\n","_postman_id":"d38320e8-7cee-4d56-8740-d5c1d17e2d26"},{"name":"Viewings","item":[{"name":"List Viewings on Unit","id":"b513d95a-ba48-448d-a92a-e85af67397e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/viewings","description":"

This endpoint retrieves a list of viewings associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","viewings"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter the viewings by status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter the viewings by assigned to ID.

\n","type":"text/plain"},"key":"assignedTo","value":""},{"disabled":true,"description":{"content":"

Filter the viewings by the date.

\n","type":"text/plain"},"key":"viewingDate","value":""}],"variable":[]}},"response":[{"id":"1e5639b2-1485-4e75-a1e6-24ae33577c83","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/viewings"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"unit_id\": \"1\",\n \"applicant_id\": \"11\",\n \"viewing_status\": \"Confirmed\",\n \"viewing_date\": \"2019-05-28\",\n \"viewing_time\": \"12:30\",\n \"offer_amount\": \"500.00\",\n \"offer_frequency\": \"Weekly\",\n \"move_in_date\": \"2019-07-01\",\n \"assigned_to_ids\": [\n \"1234\"\n ],\n \"source\": \"my website\",\n \"notes\": \"this is an applicant\",\n\t \"modified\": \"2019-05-28T12:00:00+00:00\",\n\t \"created\": \"2019-05-28T12:00:00+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"b513d95a-ba48-448d-a92a-e85af67397e5"},{"name":"Add Viewing on Unit","id":"45c0478d-e426-475c-a00a-e24a6e93d275","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/viewings","description":"

Use this endpoint to create a new viewing record for the unit. The API will return the saved data and a unique viewing ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Default	Required?
applicant_id	123	Integer		Yes
viewing_date	2019-05-28	Date		No
viewing_time	00:00	Time		No
offer_amount	250.00	Float		No
offer_frequency	Week	Enum	Month	No
move_in_date	2019-07-01	Date		No
assigned_to_ids	[123,124]	Array (Integer)		No
source	My website	Simple		No
notes	Landlord will be present for this viewing.	String		No

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","viewings"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source

\n","type":"text/plain"},"key":"strict","value":"true"}],"variable":[]}},"response":[{"id":"64831773-3cac-47f2-9966-6ae3a8c90c6a","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"applicant_id\": \"12345\",\n\t\"viewing_date\": \"2019-05-28\",\n\t\"viewing_time\": \"12:30\",\n\t\"offer_amount\": \"500.00\",\n\t\"offer_frequency\": \"Weekly\",\n\t\"move_in_date\": \"2019-07-01\",\n\t\"assigned_to_ids\": [\n\t\t\"1234\"\n\t],\n\t\"source\": \"my website\",\n\t\"notes\": \"this is an applicant\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/viewings"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"unit_id\": \"1\",\n \"applicant_id\": \"12345\",\n \"viewing_status\": \"Confirmed\",\n \"viewing_date\": \"2019-05-28\",\n \"viewing_time\": \"12:30\",\n \"offer_amount\": \"500.00\",\n \"offer_frequency\": \"Weekly\",\n \"move_in_date\": \"2019-07-01\",\n \"assigned_to_ids\": [\n \"1234\"\n ],\n \"source\": \"my website\",\n \"notes\": \"this is an applicant\",\n \"modified\": \"2019-05-28T12:00:00+00:00\",\n \"created\": \"2019-05-28T12:00:00+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"45c0478d-e426-475c-a00a-e24a6e93d275"}],"id":"dab966cd-6949-41f7-b8b4-54f808cb891e","description":"

This section provides resources for dealing with Viewings related to a unit. To update and view specific existing Viewings, please use the Viewings endpoint with its ID.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"03ddf4ca-1323-48a7-9a34-df52547ff43a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"11cfad75-8a6b-4cb3-97e7-6aefecf64f09"}}],"_postman_id":"dab966cd-6949-41f7-b8b4-54f808cb891e"},{"name":"Tenancies","item":[{"name":"List Tenancies on Unit","id":"85a652c4-ed58-4efb-9d58-d32483f5d93d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tenancies","description":"

This endpoint retrieves a list of tenancies associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","tenancies"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"8e49a869-5dcc-429c-a7a3-a108c98cfc32","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tenancies"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 12345,\n \"property_id\": 11223,\n \"unit_id\": 22334,\n \"ref\": \"TE1001\",\n \"status\": \"Current\",\n \"tenancy_type\": \"Commercial\",\n \"tenants\": [\n {\n \"id\": 226495,\n \"first_name\": \"tenant\",\n \"last_name\": \"one\",\n \"date_of_birth\": \"1980-05-06\",\n \"mobile\": \"07123456789\",\n \"email\": \"sales@arthuronline.co.uk\",\n \"main_tenant\": true,\n \"move_in_date\": \"2019-01-01\",\n \"move_out_date\": \"2020-01-01\"\n }\n ],\n \"letting_agent\": {\n \"id\": 99999,\n \"first_name\": \"Arthur\",\n \"last_name\": \"Agency\",\n \"primary_phone\": \"\",\n \"primary_email\": \"sales+agent@arthuronline.co.uk\"\n },\n \"contract_type\": \"Company\",\n \"renter_company\": \"\",\n \"start_date\": \"2019-09-01\",\n \"end_date\": \"2020-09-01\",\n \"break_clause_date\": null,\n \"fixed_break_date\": \"2020-02-13\",\n \"rolling_break_date\": \"2019-09-18\",\n \"notice_period\": \"1 months\",\n \"issue_break_clause_to\": \"landlord\",\n \"move_in_date\": \"2019-01-02\",\n \"move_in_time\": \"12:00\",\n \"move_out_date\": null,\n \"move_out_time\": null,\n \"rent_amount\": 875,\n \"rent_frequency\": \"Monthly\",\n \"deposit_held_by\": \"\",\n \"rent_payment_bank\": {\n \"id\": 55555,\n \"bank_name\": \"\",\n \"bank_account\": \"Arthur default account\",\n \"account_number\": \"00000000\",\n \"sort_code\": \"000000\"\n },\n \"deposit payment bank\": {\n \"id\": 5556,\n \"bank_name\": \"\",\n \"bank_account\": \"Arthur default account\",\n \"account_number\": \"00000000\",\n \"sort_code\": \"000000\"\n },\n \"default_rent_payment_method\": \"Bank Transfer\",\n \"rent_insured\": false,\n \"modified\": \"2019-09-02T11:20:42+00:00\",\n \"created\": \"2019-09-02T11:20:42+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"85a652c4-ed58-4efb-9d58-d32483f5d93d"},{"name":"Add Tenancy On Unit","id":"9205cb80-c631-490a-93e6-c2e3cdfd3470","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tenancies","description":"

Use this endpoint to create a new tenancy record for the unit. The API will return the saved data and a unique tenancy ID.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Default	Required?
status	Current	Integer	Prospective	No
tenancy_type	Commercial	Integer	Residential	No
letting_agent_id	90909	Integer		No
contract_type	Company	String		No
renter_company	Renter Ltd.	String		No
start_date	2019-01-01	Date		Yes
end_date	2020-01-01	Date		No
break_clause_date	2019-06-01	Date		No
fixed_break_date	2019-06-01	Date		No
rolling_break_date	2019-09-18	Date		No
notice_period	2 months	String	1 months	No
issue_break_clause_to	landlord	String		No
move_in_date	2019-01-01	Date		No
move_in_time	12:00	Time		No
move_out_date	2020-01-01	Date		No
move_out_time	12:00	Time		No
rent_amount	875	Float		Yes
rent_frequency	Monthly	String		No
deposit_held_by	DPS	String		No
rent_payment_bank_id	1423	Integer		No
deposit_payment_bank_id	4132	Integer		No
default_rent_payment_method	Bank Transfer	String		No
rent_insured	false	Boolean		No
tags	[\"12 month contract\"]	Array (String)		No

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","tenancies"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"8431db13-7cae-4cc1-9bb5-09e4451493f0","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"status\": \"Current\",\r\n \"tenancy_type\": \"Commercial\",\r\n \"start_date\": \"2019-01-01\",\r\n \"end_date\": \"2020-01-01\",\r\n \"break_clause_date\": \"2019-06-01\",\r\n \"fixed_break_date\": \"2019-06-01\",\r\n \"rolling_break_date\": \"2019-09-18\",\r\n \"move_in_date\": \"2019-01-01\",\r\n \"move_in_time\": \"12:00\",\r\n \"move_out_date\": \"2020-01-01\",\r\n \"move_out_time\": \"12:00\",\r\n \"deposit_held_by\": \"\",\r\n \"default_rent_payment_method\": \"Bank Transfer\",\r\n \"rent_insured\": false,\r\n \"tags\": [\r\n \t\"12 month contract\"\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tenancies"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"property_id\": 2,\n \"unit_id\": 3,\n \"ref\": \"TE10\",\n \"status\": \"Current\",\n \"full_address\": \"unit address, London, MA918S\",\n \"unit_owner\": \"Ronnie Sherman\",\n \"tenancy_type\": \"Commercial\",\n \"tenancy_sub_type\": \"\",\n \"unit_assigned_managers\": \"Brian Shawn\",\n \"main_tenant_name\": \"\",\n \"tenants\": [],\n \"letting_agent\": {\n \"id\": 0,\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"primary_phone\": \"\",\n \"primary_email\": \"\"\n },\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"start_date\": \"2019-01-01\",\n \"end_date\": \"2020-01-01\",\n \"break_clause_date\": \"2019-06-01\",\n \"fixed_break_date\": \"2019-06-01\",\n \"rolling_break_date\": \"2019-09-18\",\n \"notice_period\": \"\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"2019-01-01\",\n \"move_in_time\": \"12:00\",\n \"move_out_date\": \"2020-01-01\",\n \"move_out_time\": \"12:00\",\n \"rent_amount\": 0,\n \"rent_frequency\": \"\",\n \"deposit_held_by\": \"\",\n \"deposit_scheme\": \"\",\n \"deposit_registered\": false,\n \"deposit_registered_amount\": \"0.00\",\n \"rent_review_date\": null,\n \"section_21_served\": false,\n \"rent_payment_bank\": {\n \"id\": 77775,\n \"bank_name\": \"Barclays\",\n \"bank_account\": \"deposit\",\n \"account_number\": \"123\",\n \"sort_code\": \"123\"\n },\n \"deposit payment bank\": {\n \"id\": 77775,\n \"bank_name\": \"Barclays\",\n \"bank_account\": \"deposit\",\n \"account_number\": \"123\",\n \"sort_code\": \"123\"\n },\n \"default_rent_payment_method\": \"Bank Transfer\",\n \"rent_insured\": false,\n \"tags\": [\n \"12 month contract\"\n ],\n \"notes\": [],\n \"custom_fields\": [],\n \"modified\": \"2020-10-29T11:24:20+00:00\",\n \"created\": \"2020-10-29T11:24:20+00:00\"\n }\n}"}],"_postman_id":"9205cb80-c631-490a-93e6-c2e3cdfd3470"}],"id":"dd75f83e-9a90-4c45-8c60-7e51e07c2132","description":"

This section provides resources for dealing with Tenancies related to a unit.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ab2e8a02-1c9b-4767-bd49-eb8c011ce85b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1c89c9b5-6305-48eb-b2f8-e9130c8b1e98"}}],"_postman_id":"dd75f83e-9a90-4c45-8c60-7e51e07c2132"},{"name":"Tasks","item":[{"name":"List Tasks On Unit","id":"adeb5da4-1a62-4885-885c-9376d6f7571e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tasks","description":"

This endpoint retrieves a list of tasks associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","tasks"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b43b7133-2027-4713-bcee-725277f55b4b","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tasks"},"status":"List Tasks On Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Need to fix the boiler\",\n \"total_subtasks\": 0,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"Raven Drive 51, 3 Inn Court, London, NW15LG\",\n \"related_to\":\"\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [\n \"http://arthur.localhost/public/attachments...\"\n ],\n \"document_urls\": [\n \"http://arthur.localhost/public/attachments...\"\n ],\n \"tags\": [\n \"one\",\n \"two\"\n ],\n \"api_notes\": \"\",\n \"modified\": \"2020-02-26T12:41:53+00:00\",\n \"created\": \"2020-02-26T12:40:29+00:00\"\n }\n]"}],"_postman_id":"adeb5da4-1a62-4885-885c-9376d6f7571e"},{"name":"View Task On Unit","id":"5f7a4d52-d9ad-4124-b1cb-c543532e27e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tasks/{{task_id}}","description":"

This API endpoint retrieves the details of a single unit task, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","tasks","{{task_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"cf00d618-fae0-4938-a17e-981e868b9e83","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tasks/{{task_id}}"},"status":"View Note On Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Fix the boiler please\",\n \"total_subtasks\": 0,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"Swan Drive 51, 3 Wren Court, London, NW95DG\",\n \"related\":\"\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [\n \"z narni\",\n \"slay\"\n ],\n \"api_notes\": \"\",\n \"modified\": \"2020-02-26T10:49:28+00:00\",\n \"created\": \"2020-02-26T10:49:28+00:00\"\n }\n ]\n}"}],"_postman_id":"5f7a4d52-d9ad-4124-b1cb-c543532e27e7"},{"name":"Add Task On Unit","id":"b13c7aa7-c0ac-4dbf-bff2-f1f21104d6cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tasks","description":"

Use this endpoint to create a new task record for the unit. The API will return the saved data and a unique task ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
task_type	Inspection	String	No
description	Radiator not working	String	Yes
tags	['one','two']	Array(String)	No
due_date	2020-10-11	Date	No
due_time	15:32	Time	No
assigned_managers	[123,1234]	Array(Integer)	No
emergency	True	Boolean	No
private	True	Boolean	No
api_notes	Landlord will be present	String	No
files (each object must contain \"file_type\", \"file_name\", and \"file\")	{ \"file_type\":\"application/pdf\", \"file_name\":\"testing\", \"file\":\"(base 64)\" }	[Array {Objects}]	No

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","tasks"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"bf22095e-a37e-4aeb-b155-506e65e898ad","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"description\":\"Fix windows please\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tasks"},"status":"Add Task On Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Fix windows please\",\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"51 Litchfield , 3 Raven Court, NS19SA\",\n \"due_date\": null,\n \"due_time\": null,\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [],\n \"api_notes\": \"\",\n \"modified\": \"2020-03-05T12:17:07+00:00\",\n \"created\": \"2020-03-05T12:17:07+00:00\"\n }\n}"}],"_postman_id":"b13c7aa7-c0ac-4dbf-bff2-f1f21104d6cc"},{"name":"Update Task On Unit","id":"aac2c75c-992a-495d-b6be-76ae32f59331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tasks/{{task_id}}","description":"

This endpoint updates an existing task using the same fields as the 'Add Task' endpoint. The API will return the updated data for the unit in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
task_type	Inspection	String	No
description	Radiator not working	String	No
tags	['one','two']	Array(String)	No
due_date	2020-10-11	Date	No
due_time	15:32	Time	No
assigned_managers	[123,1234]	Array(Integer)	No
emergency	True	Boolean	No
private	True	Boolean	No
api_notes	Landlord will be present	String	No

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","tasks","{{task_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"02d22a07-a99f-42aa-a982-5fd855478cee","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"description\":\"Fix windows please updated\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tasks/{{task_id}}"},"status":"Update Task On Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Fix windows please updated\",\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"51 Litchfield , 3 Raven Court, NS19SA\",\n \"due_date\": null,\n \"due_time\": null,\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [],\n \"api_notes\": \"\",\n \"modified\": \"2020-03-05T12:17:07+00:00\",\n \"created\": \"2020-03-05T12:17:07+00:00\"\n }\n}"}],"_postman_id":"aac2c75c-992a-495d-b6be-76ae32f59331"},{"name":"Delete Task On Unit","id":"d0b4e652-e80a-4238-9da4-b1143c8d5520","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tasks/{{task_id}}","description":"

This endpoint deletes an existing asset record using the task id, under a unit ID

This section provides resources for dealing with Tasks related to a unit.

\n","_postman_id":"68c63828-2f10-4f07-ba02-ec8d856d572b"},{"name":"Workorders","item":[{"name":"List Workorders On Unit","id":"91bfdd47-e043-40a9-b95b-954f7c6757c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/workorders","description":"

This endpoint retrieves a list of workorders associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","workorders"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"5ba41ae2-56fe-48e2-a61d-2da68b7f9c89","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/workorders"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Unit 123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"91bfdd47-e043-40a9-b95b-954f7c6757c8"},{"name":"View Workorders On Unit","id":"198b19e0-5f8f-465c-8898-2c60a21aab99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/workorders/{{workorder_id}}","description":"

This API endpoint retrieves the details of a single unit workorder, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","workorders","{{workorder_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"211a15e0-765c-48ff-8273-738d7b01475e","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/workorders/{{workorder_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"198b19e0-5f8f-465c-8898-2c60a21aab99"},{"name":"Update Workorders On Unit","id":"5f89c4ce-990a-4c4e-b8d0-3c84af69de5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/workorders/{{workorder_id}}","description":"

This endpoint updates an existing workorder using the same fields as the 'Add Workorder' endpoint. The API will return the updated data for the unit in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
title	workorder title	String	No
description	workorder description	String	No
invite_contractors	[123,1234]	Array(integer)	No
service_type	Carpet Layer	String	No
start_date	2020-02-20	Date	No
due_date	2020-02-20	Date	No
budget	1000,00	Float	No
allocated_time_hours	20	Float	No
actual_time_hours	20	Float	No
price_per_hour	7,90	Float	No
emergency	true	Boolean	No
quote_required	true	Boolean	No
share_assets	false	Boolean	No
hide_tenant_details	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","workorders","{{workorder_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"397f08c2-2609-4714-aa39-c7b31bc78c6d","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\":\"Updated title\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/workorders/{{workorder_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Updated title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"unit address\"\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"5f89c4ce-990a-4c4e-b8d0-3c84af69de5f"},{"name":"Create Workorders On Unit","id":"fd3a9c1c-2f9b-42ac-b06b-777139e17ca2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/workorders","description":"

Use this endpoint to create a new workorder record for the unit. The API will return the saved data and a unique workorder ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
title	workorder title	String	No
description	workorder description	String	No
invite_contractors	[123,1234]	Array(integer)	No
service_type	Carpet Layer	String	Yes
start_date	2020-02-20	Date	No
due_date	2020-02-20	Date	No
budget	1000,00	Float	No
allocated_time_hours	20	Float	No
actual_time_hours	20	Float	No
price_per_hour	7,90	Float	No
emergency	true	Boolean	No
quote_required	true	Boolean	No
share_assets	false	Boolean	No
hide_tenant_details	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","workorders"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"d7ea86f2-dbcf-4beb-9df0-61599b1e1b94","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"service_type\":\"aerial network specialist\",\n \"title\":\"Workorder title\",\n \"description\":\"Workorder Description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/workorders"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Unit 123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 0,\n \"full_name\": \"\",\n \"status\": \"\"\n },\n \"invited_contractors\": [],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"unit address\"\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"fd3a9c1c-2f9b-42ac-b06b-777139e17ca2"}],"id":"af1db011-b469-4120-9ee1-fc4635e37dac","description":"

This section provides resources for dealing with Workorders related to a unit.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f306d7a0-36fc-432a-a94a-f1505bbf6ef8"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"76f09838-84ad-4c1f-95c9-62d8ab8af07c"}}],"_postman_id":"af1db011-b469-4120-9ee1-fc4635e37dac"},{"name":"Utilities","item":[{"name":"List Utilities On Unit","id":"6d7992b8-c087-4374-8de4-de641aa68eab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/utilities","description":"

This endpoint retrieves a list of utilities associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","utilities"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"5228006b-2a14-43e3-a7e5-5f228292c547","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/utilities"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 16016,\n \"type\": \"Broadband\",\n \"serial_number\": \"321K123AmX\",\n \"account_number\": \"39102712\",\n \"provider\": \"\",\n \"last_reading_value\": null,\n \"last_reading_date\": null,\n \"notes\": \"\",\n \"created_by\": {\n \"id\": 1,\n \"full_name\": \"Martin Zelazny\"\n },\n \"created\": \"2020-10-27T10:24:30+00:00\",\n \"modified\": \"2020-10-27T10:24:30+00:00\"\n },\n {\n \"id\": 16015,\n \"type\": \"Electric\",\n \"serial_number\": \"321K123AmX\",\n \"account_number\": \"39102712\",\n \"provider\": \"\",\n \"last_reading_value\": \"89212\",\n \"last_reading_date\": \"2020-10-27\",\n \"notes\": \"\",\n \"created_by\": {\n \"id\": 1,\n \"full_name\": \"Martin Zelazny\"\n },\n \"created\": \"2020-10-27T10:14:16+00:00\",\n \"modified\": \"2020-10-27T10:14:16+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"6d7992b8-c087-4374-8de4-de641aa68eab"},{"name":"Create Utility On Unit","id":"8a45c116-65bd-4d14-83cb-8149ba11c58e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/utilities","description":"

Use this endpoint to create a new utility record for the unit. The API will return the saved data and a unique utility ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
type	gas	String	Yes
notes	behind back doors	String	No
serial_number	GA212FP21	String	No
account_number	12344321	string	No
provider	company_name	string	No

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","utilities"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"8ec97dcc-a091-45a2-bbbd-83fe9fbde67f","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"gas\",\n \"serial_number\":\"Created serial number\",\n \"account_number\": \"12344321\",\n \"provider\": \"\",\n \"last_reading_value\": null,\n \"last_reading_date\": null,\n \"notes\": \"\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/utilities"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"type\": \"gas\",\n \"serial_number\":\"Created serial number\",\n \"account_number\": \"12344321\",\n \"provider\": \"\",\n \"last_reading_value\": null,\n \"last_reading_date\": null,\n \"notes\": \"\",\n \"created_by\": {\n \"id\": 1,\n \"full_name\": \"Brian Shawn\"\n },\n \"created\": \"2020-10-27T10:24:30+00:00\",\n \"modified\": \"2020-10-27T10:24:30+00:00\"\n }\n}"}],"_postman_id":"8a45c116-65bd-4d14-83cb-8149ba11c58e"}],"id":"c125f95a-acdc-41d6-b370-a7f9b4cc37ba","description":"

This section provides resources for dealing with Utilities related to a unit.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8cd2a7f2-af30-4b86-989e-cacfdb2090e8"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2c11fd1e-f33f-4ba2-a8d9-35e798ee625e"}}],"_postman_id":"c125f95a-acdc-41d6-b370-a7f9b4cc37ba"},{"name":"Transactions","item":[{"name":"List Transactions On Unit","id":"e35a943b-206b-4ad6-99dd-27c999e70f55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/transactions","description":"

This retrieves a list of transactions for a Unit

See available filters below to customize the list of transactions returned.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","transactions"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"statement","value":""},{"disabled":true,"description":{"content":"

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.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"date_from","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"date_to","value":""}],"variable":[]}},"response":[{"id":"c6fe110c-5e3c-49d8-8527-d4b11590cd30","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/transactions"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ref\": \"TR007\",\n \"transaction_type\": \"Registered Deposit Charge\",\n \"payment_type\": \"charge\",\n \"description\": \"Registered Deposit\",\n \"property_id\": 11,\n \"unit_id\": 123,\n \"tenancy_id\": 33,\n \"payee_group_id\": 10,\n \"invoice_ref\": \"\",\n \"payee_tenant_id\": 44,\n \"amount\": \"1500.00\",\n \"amount_charged\": \"1500.00\",\n \"amount_paid\": \"0.00\",\n \"amount_outstanding\": \"1500.00\",\n \"amount_net\": \"1500.00\",\n \"vat_code_id\": 4,\n \"source\": \"arthur\",\n \"created_by\": {\n \"id\": 11,\n \"full_name\": \"Brian Brown\"\n },\n \"payee_name\": \"Thomas Smith\",\n \"payee_person_id\": null,\n \"payee_entity_id\": 0,\n \"date\": \"2020-06-25\",\n \"due_date\": \"2020-06-25\",\n \"modified\": \"2020-06-25T15:35:01+01:00\",\n \"created\": \"2020-06-25T15:35:01+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"e35a943b-206b-4ad6-99dd-27c999e70f55"}],"id":"69317385-d8c6-4f5a-8bf6-cd5b2e74e65b","description":"

This section provides resources for dealing with Transactions related to a unit.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"dd0f3f49-91bb-48c7-a2dd-ece1664ee7ce"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"25aed88f-20b6-4317-8d18-b635753b4fba"}}],"_postman_id":"69317385-d8c6-4f5a-8bf6-cd5b2e74e65b"},{"name":"Tags","item":[{"name":"Get Tags on Unit","id":"ccc5cd45-65d8-4e60-b155-da1f9860b2d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{id}/tags","description":"

This endpoint retrieves a list of tags associated with the given unit ID.

\n","urlObject":{"protocol":"https","path":["v2","units","{id}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e473a375-381c-4f32-9cad-5a7c95772595","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 33843,\n \"name\": \"1000 spend limit\",\n \"color\": \"blue\"\n },\n {\n \"id\": 49572,\n \"name\": \"benefits lapsed\",\n \"color\": \"blue\"\n }\n ]\n}"}],"_postman_id":"ccc5cd45-65d8-4e60-b155-da1f9860b2d2"},{"name":"Tag Unit","id":"5536d1db-6877-47cc-8904-b87ed7c0fb9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tags","description":"

Use this endpoint to create a new tag record for the unit. The API will return the saved data and a unique tag ID.

Supported Fields

The following fields are supported for the request body
Tag field should be a valid tag ID or name.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Default	Required?
tag	[\"123\"]	Array(String)		Yes

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"9e90d256-a4d2-40a0-a850-4e0eba0a9309","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":[\"1234\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/tags"},"status":"Tag Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1234,\n \"name\": \"Tag one\",\n \"color\": \"orange\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 12,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"5536d1db-6877-47cc-8904-b87ed7c0fb9f"},{"name":"Untag Unit","id":"1af9bb6e-bec7-4248-a09b-6740adbcd86f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/untag","description":"

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.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	123	String	Yes

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","untag"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"8a84c09d-9a96-48f1-bfe0-b7a2e4e4ed46","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":\"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/untag"},"status":"Untag Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"1af9bb6e-bec7-4248-a09b-6740adbcd86f"},{"name":"Untag All Unit Tags","id":"198919f2-1bdf-44cc-8dd9-0dc9bbf0e50a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/untag_all","description":"

Use this endpoint to unassign all tags from the unit.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}","untag_all"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"3d9f2a6e-c3f1-4201-92d6-d860c3843790","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/untag_all"},"status":"Untag All Unit Tags","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"198919f2-1bdf-44cc-8dd9-0dc9bbf0e50a"}],"id":"1ee592c5-3695-4bb5-b2f2-0176edc06de1","description":"

This section provides resources for dealing with Tags related to a unit.

\n","_postman_id":"1ee592c5-3695-4bb5-b2f2-0176edc06de1"},{"name":"List Units","id":"d8c6fb88-a1f2-4abc-802c-17877c422b99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units","description":"

This retrieves a list of units.

See available filters below to customize the list of units returned.

\n","urlObject":{"protocol":"https","path":["v2","units"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by the address name of the unit

\n","type":"text/plain"},"key":"unit_ref","value":""},{"disabled":true,"description":{"content":"

Filter by the address 1 field of the unit

\n","type":"text/plain"},"key":"address_line_1","value":""},{"disabled":true,"description":{"content":"

Filter by the address 2 field of the unit

\n","type":"text/plain"},"key":"address_line_2","value":""},{"disabled":true,"description":{"content":"

Filter by the city of the unit

\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"

Filter by the county of the unit

\n","type":"text/plain"},"key":"county","value":""},{"disabled":true,"description":{"content":"

Filter by the area ID of the unit

\n","type":"text/plain"},"key":"area_id","value":""},{"disabled":true,"description":{"content":"

Filter by the area name of the unit

\n","type":"text/plain"},"key":"area","value":""},{"disabled":true,"description":{"content":"

Filter by the postcode of the unit

\n","type":"text/plain"},"key":"postcode","value":""},{"disabled":true,"description":{"content":"

Filter units by portal

\n","type":"text/plain"},"key":"portal","value":""},{"disabled":true,"description":{"content":"

Filter units by unit vacancy (boolean)

\n","type":"text/plain"},"key":"unit_vacant","value":""},{"disabled":true,"description":{"content":"

Filter by unit availability date range. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"available_move_in_date","value":""},{"disabled":true,"description":{"content":"

Filter by unit avaiability date range. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"available_move_out_date","value":""},{"disabled":true,"description":{"content":"

Filter units by unit type

\n","type":"text/plain"},"key":"unit_type","value":""},{"disabled":true,"description":{"content":"

Filter based on the current status of units, including Available To Let, Under Offer, Let, and Unavailable to Let

\n","type":"text/plain"},"key":"unit_status","value":""},{"disabled":true,"description":{"content":"

Filter units by market rent amount

\n","type":"text/plain"},"key":"market_rent","value":""},{"disabled":true,"description":{"content":"

Filter units by bedroom count

\n","type":"text/plain"},"key":"bedrooms","value":""},{"disabled":true,"description":{"content":"

Filter units by floor count

\n","type":"text/plain"},"key":"floors","value":""},{"disabled":true,"description":{"content":"

Filter by tags associated with the units, which should be provided as a comma-separated list

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter based on the management status of the property (boolean)

\n","type":"text/plain"},"key":"i_manage_this","value":""},{"disabled":true,"description":{"content":"

Filter by the ID of the owner of the unit

\n","type":"text/plain"},"key":"unit_owner_id","value":""},{"disabled":true,"description":{"content":"

Filter by the max occupancy on a unit

\n","type":"text/plain"},"key":"max_occupancy","value":null},{"disabled":true,"description":{"content":"

Filter by keyword

\n","type":"text/plain"},"key":"_q","value":""}],"variable":[]}},"response":[{"id":"20e0f83f-3392-4407-9eea-3ef899355651","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"property_id\": 1,\n \"unit_type\": \"Flat\",\n \"unit_status\": \"Under Offer\",\n \"unit_ref\": \"Unit 3 - C\",\n \"unit_vacant\": true,\n \"available_from\": null,\n \"owner\": {\n \"id\": 1,\n \"full_name\": \"New Company\"\n },\n \"assigned_managers\": \"\",\n \"full_address\": \"full address\",\n \"address_line_1\": \"address line 1\",\n \"address_line_2\": \"address line 2\",\n \"city\": \"london\",\n \"county\": \"\",\n \"country\": \"United Kingdom\",\n \"area\": \"\",\n \"postcode\": \"123456\",\n \"market_rent\": 0,\n \"market_rent_frequency\": \"Not provided\",\n \"available_since\": null,\n \"letting_agent_id\": null,\n \"letting_agent\": {\n \"id\": null,\n \"full_name\": null\n },\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"N/A\",\n \"bathrooms\": \"N/A\",\n \"floors\": \"\",\n \"bedrooms\": \"N/A\",\n \"receptions\": \"N/A\",\n \"smart_meters\": \"\",\n \"date_available\": null,\n \"rental_term\": \"\",\n \"deposit_amount\": 0,\n \"service_charge\": false,\n \"service_charge_amount\": 0,\n \"council_tax_band\": \"N/A\",\n \"council_account_no\": \"\",\n \"council_id\": null,\n \"portal_market_rent\": 0,\n \"portal_market_rent_frequency\": \"Not provided\",\n \"sharing_tenancies\": \"N/A\",\n \"virtual_tour_url\": \"\",\n \"i_manage_this\": true,\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [],\n \"unit_features\": [],\n \"additional_features\": [],\n \"notes\": [],\n \"tags\": [],\n \"custom_fields\": [],\n \"days_vacant\": \"\",\n \"days_vacant_total\": 0,\n \"modified\": \"2021-01-09T12:53:18+00:00\",\n \"created\": \"2021-01-09T12:52:11+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"d8c6fb88-a1f2-4abc-802c-17877c422b99"},{"name":"View Unit","id":"4d149092-0e49-4d55-804d-f8ec8e172ed0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}","description":"

This API endpoint retrieves the details of a single unit, identified by its unique unit_id.

Use this endpoint to view the specific details of a unit.

\n","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e712693b-eb7d-4e1b-b6d0-541cdddd9f82","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"property_id\": 1,\n \"unit_type\": \"Flat\",\n \"unit_status\": \"Under Offer\",\n \"unit_ref\": \"Unit 3 - C\",\n \"unit_vacant\": true,\n \"available_from\": null,\n \"owner\": {\n \"id\": 1,\n \"full_name\": \"New Company\"\n },\n \"assigned_managers\": \"\",\n \"full_address\": \"full address\",\n \"address_line_1\": \"address line 1\",\n \"address_line_2\": \"address line 2\",\n \"city\": \"london\",\n \"county\": \"\",\n \"country\": \"United Kingdom\",\n \"area\": \"\",\n \"postcode\": \"123456\",\n \"market_rent\": 0,\n \"market_rent_frequency\": \"Not provided\",\n \"available_since\": null,\n \"letting_agent_id\": null,\n \"letting_agent\": {\n \"id\": null,\n \"full_name\": null\n },\n \"portal_address\": \"\",\n \"short_description\": \"\",\n \"description\": \"\",\n \"portal_unit_type\": \"\",\n \"size\": \"\",\n \"size_unit\": \"\",\n \"furnished\": \"\",\n \"max_occupancy\": \"N/A\",\n \"bathrooms\": \"N/A\",\n \"floors\": \"\",\n \"bedrooms\": \"N/A\",\n \"receptions\": \"N/A\",\n \"smart_meters\": \"\",\n \"date_available\": null,\n \"rental_term\": \"\",\n \"deposit_amount\": 0,\n \"service_charge\": false,\n \"service_charge_amount\": 0,\n \"council_tax_band\": \"N/A\",\n \"council_account_no\": \"\",\n \"council_id\": null,\n \"portal_market_rent\": 0,\n \"portal_market_rent_frequency\": \"Not provided\",\n \"sharing_tenancies\": \"N/A\",\n \"virtual_tour_url\": \"\",\n \"i_manage_this\": true,\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [],\n \"unit_features\": [],\n \"additional_features\": [],\n \"notes\": [],\n \"tags\": [],\n \"custom_fields\": [],\n \"days_vacant\": \"\",\n \"days_vacant_total\": 0,\n \"modified\": \"2021-01-09T12:53:18+00:00\",\n \"created\": \"2021-01-09T12:52:11+00:00\"\n }\n}"}],"_postman_id":"4d149092-0e49-4d55-804d-f8ec8e172ed0"},{"name":"Add Unit","id":"d485c689-e4f7-47c2-aafa-1e35f8497412","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/units","description":"

Use this endpoint to create a new unit. The API will return the saved data and a unique Unit ID.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Default	Required?
property_id	12345	Integer		Yes
unit_type	Residential	String		No
unit_status	Available to Let	String	Available to Let	No
unit_ref	Unit 1	String		Yes
address_line_1	Arthur House	String		Yes
address_line_2	123 Property Street	String		No
city	Stevenage	String		Yes
county	Hertfordshire	String		No
country	United Kingdom	String		No
area	South East	String		No
postcode	AB1 2CD	String		Yes
market_rent	800.00	Float		No
market_rent_frequency	Monthly	String		No
available_from	2019-01-01	Date		No
available_since	2019-01-01	Date		No
unit_owner_id	3456	Integer		No
letting_agent_id	4567	Integer		No
portal_address	Property Street, Stevenage, AB1	String		No
short_description	Brand new furnished unit in the heart of the city center!	String		No
description	This fabulous new property has been recently refurbished with close links to city center and nearby public transport. Please call now to book a viewing.	String		No
portal_unit_type	Apartment	String		No
size	500	String		No
size_unit	Sq Meter	String		No
furnished	Part-Furnished	String		No
max_occupancy	1	String		No
bathrooms	1	String		No
floors	1	String		No
bedrooms	1	String		No
receptions	1	String		No
smart_meters	No	String		No
date_available	2019-01-01	Date		No
rental_term	Long	String		No
deposit_amount	1600.00	Float		No
service_charge	true	Boolean		No
service_charge_amount	75.00	Float		No
council_tax_band	C	String		No
council_account_no	ABC123	String		No
council_id	9874	Integer		No
portal_market_rent	800.00	Float		No
portal_market_rent_frequency	Monthly	String		No
sharing_tenancies	N/A	String		No
i_manage_this	true	Boolean		No
features	[ \"Internet\", \"Fireplace\", \"Smart home integration\" ]	Array (String)		No
tags	[ \"Cheap Rent\" ]	Array (String)		No

","urlObject":{"protocol":"https","path":["v2","units"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"d8647ec7-84c8-4ec2-a25f-b01b5f10a8d5","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"property_id\": 282789,\n \"unit_type\": \"Residential\",\n \"unit_status\": \"Available To Let\",\n \"unit_ref\": \"Unit 1\",\n \"address_line_1\": \"Arthur House\",\n \"address_line_2\": \"123 Property Street\",\n \"city\": \"Stevenage\",\n \"county\": \"Hertfordshire\",\n \"country\": \"United Kingdom\",\n \"area\": \"South East\",\n \"postcode\": \"AB1 2CD\",\n \"market_rent\": 800,\n \"market_rent_frequency\": \"Monthly\",\n \"available_from\": \"2019-01-01\",\n \"available_since\": \"2019-01-01\",\n \"portal_address\": \"Property Street, Stevenage, AB1\",\n \"short_description\": \"Brand new furnished unit in the heart of the city center!\",\n \"description\": \"This fabulous new property has been recently refurbished with close links to city center and nearby public transport. Please call now to book a viewing.\",\n \"portal_unit_type\": \"Apartment\",\n \"size\": \"500\",\n \"size_unit\": \"Sq Meter\",\n \"furnished\": \"Part-Furnished\",\n \"max_occupancy\": \"1\",\n \"bathrooms\": \"1\",\n \"floors\": \"1\",\n \"bedrooms\": \"1\",\n \"receptions\": \"1\",\n \"smart_meters\": \"No\",\n \"date_available\": \"2019-01-01\",\n \"rental_term\": \"Long\",\n \"deposit_amount\": 1600,\n \"service_charge\": true,\n \"service_charge_amount\": 75,\n \"council_tax_band\": \"C\",\n \"council_account_no\": \"ABC123\",\n \"portal_market_rent\": 800,\n \"portal_market_rent_frequency\": \"Monthly\",\n \"sharing_tenancies\": \"N/A\",\n \"i_manage_this\": true,\n \"features\": [\n \"Internet\",\n \"Fireplace\",\n \"Smart home integration\"\n ],\n \"tags\": [\n \"Cheap Rent\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 651669,\n \"property_id\": 282789,\n \"unit_type\": \"Residential\",\n \"unit_status\": \"Available To Let\",\n \"unit_ref\": \"Unit 1\",\n \"unit_vacant\": true,\n \"available_from\": \"2019-01-01\",\n \"owner\": {\n \"id\": null,\n \"full_name\": null\n },\n \"assigned_managers\": \"\",\n \"full_address\": \"Unit 1, Arthur House, 123 Property Street, Stevenage, Hertfordshire, AB1 2CD, United Kingdom (South East)\",\n \"address_line_1\": \"Arthur House\",\n \"address_line_2\": \"123 Property Street\",\n \"city\": \"Stevenage\",\n \"county\": \"Hertfordshire\",\n \"country\": \"United Kingdom\",\n \"area\": \"South East\",\n \"postcode\": \"AB1 2CD\",\n \"lat\": 51.903761,\n \"lng\": -0.196612,\n \"market_rent\": 800,\n \"market_rent_frequency\": \"Monthly\",\n \"available_since\": null,\n \"letting_agent_id\": null,\n \"letting_agent\": {\n \"id\": null,\n \"full_name\": null\n },\n \"portal_address\": \"Property Street, Stevenage, AB1\",\n \"short_description\": \"Brand new furnished unit in the heart of the city center!\",\n \"description\": \"This fabulous new property has been recently refurbished with close links to city center and nearby public transport. Please call now to book a viewing.\",\n \"portal_unit_type\": \"Apartment\",\n \"size\": \"500\",\n \"size_unit\": \"Sq Meter\",\n \"furnished\": \"Part-Furnished\",\n \"max_occupancy\": \"1\",\n \"bathrooms\": \"1\",\n \"floors\": \"1\",\n \"bedrooms\": \"1\",\n \"receptions\": \"1\",\n \"smart_meters\": \"No\",\n \"date_available\": \"2019-01-01\",\n \"rental_term\": \"Long\",\n \"deposit_amount\": 1600,\n \"service_charge\": true,\n \"service_charge_amount\": 75,\n \"council_tax_band\": \"C\",\n \"council_account_no\": \"ABC123\",\n \"council_id\": null,\n \"portal_market_rent\": 800,\n \"portal_market_rent_frequency\": \"Monthly\",\n \"sharing_tenancies\": \"N/A\",\n \"virtual_tour_url\": \"\",\n \"i_manage_this\": true,\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [\n \"Fireplace\",\n \"Internet\",\n \"Smart home integration\"\n ],\n \"unit_features\": [\n \"Fireplace\",\n \"Internet\"\n ],\n \"additional_features\": [\n \"Smart home integration\"\n ],\n \"notes\": [],\n \"tags\": [\n \"Cheap Rent\"\n ],\n \"custom_fields\": [],\n \"relationships\": [\n {\n \"model\": \"Property\",\n \"model_id\": \"282789\",\n \"ref\": \"My big property\"\n }\n ],\n \"days_vacant\": \"1520 days ago\",\n \"days_vacant_total\": 1520,\n \"modified\": \"2023-03-01T16:14:06\",\n \"created\": \"2023-03-01T16:14:05\"\n }\n}"}],"_postman_id":"d485c689-e4f7-47c2-aafa-1e35f8497412"},{"name":"Update Unit","id":"a357ed39-533d-43a8-8c63-64679f949525","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}","description":"

This endpoint updates an existing unit using the same fields as the 'Add Unit' endpoint excluding the property_id. Any fields that are not provided will not be changed. The API will return the updated data for the unit in the response.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Required?
unit_type	Residential	String	No
unit_status	Available to Let	String	No
unit_ref	Unit 1	String	No
address_line_1	Arthur House	String	No
address_line_2	123 Property Street	String	No
city	Stevenage	String	No
county	Hertfordshire	String	No
country	United Kingdom	String	No
area	South East	String	No
postcode	AB1 2CD	String	No
market_rent	800.00	Float	No
market_rent_frequency	Monthly	String	No
available_from	2019-01-01	Date	No
available_since	2019-01-01	Date	No
unit_owner_id	3456	Integer	No
letting_agent_id	4567	Integer	No
portal_address	Property Street, Stevenage, AB1	String	No
short_description	Brand new furnished unit in the heart of the city center!	String	No
description	This fabulous new property has been recently refurbished with close links to city center and nearby public transport. Please call now to book a viewing.	String	No
portal_unit_type	Apartment	String	No
size	500	String	No
size_unit	Sq Meter	String	No
furnished	Part-Furnished	String	No
max_occupancy	1	String	No
bathrooms	1	String	No
floors	1	String	No
bedrooms	1	String	No
receptions	1	String	No
smart_meters	No	String	No
date_available	2019-01-01	Date	No
rental_term	Long	String	No
deposit_amount	1600.00	Float	No
service_charge	true	Boolean	No
service_charge_amount	75.00	Float	No
council_tax_band	C	String	No
council_account_no	ABC123	String	No
council_id	9874	Integer	No
portal_market_rent	800.00	Float	No
portal_market_rent_frequency	Monthly	String	No
sharing_tenancies	N/A	String	No
i_manage_this	true	Boolean	No
features	[ \"Internet\", \"Fireplace\", \"Smart home integration\" ]	Array (String)	No
tags	[ \"Cheap Rent\" ]	Array (String)	No

","urlObject":{"protocol":"https","path":["v2","units","{{unit_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"d4d4a8d4-92a0-4dca-939b-11f8338e8ded","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"property_id\": 282789,\n \"unit_type\": \"Residential\",\n \"unit_status\": \"Available To Let\",\n \"unit_ref\": \"Unit 1\",\n \"address_line_1\": \"Arthur House\",\n \"address_line_2\": \"123 Property Street\",\n \"city\": \"Stevenage\",\n \"county\": \"Hertfordshire\",\n \"country\": \"United Kingdom\",\n \"area\": \"South East\",\n \"postcode\": \"AB1 2CD\",\n \"market_rent\": 800,\n \"market_rent_frequency\": \"Monthly\",\n \"available_from\": \"2019-01-01\",\n \"available_since\": \"2019-01-01\",\n \"portal_address\": \"Property Street, Stevenage, AB1\",\n \"short_description\": \"Brand new furnished unit in the heart of the city center!\",\n \"description\": \"This fabulous new property has been recently refurbished with close links to city center and nearby public transport. Please call now to book a viewing.\",\n \"portal_unit_type\": \"Apartment\",\n \"size\": \"500\",\n \"size_unit\": \"Sq Meter\",\n \"furnished\": \"Part-Furnished\",\n \"max_occupancy\": \"1\",\n \"bathrooms\": \"1\",\n \"floors\": \"1\",\n \"bedrooms\": \"1\",\n \"receptions\": \"1\",\n \"smart_meters\": \"No\",\n \"date_available\": \"2019-01-01\",\n \"rental_term\": \"Long\",\n \"deposit_amount\": 1600,\n \"service_charge\": true,\n \"service_charge_amount\": 75,\n \"council_tax_band\": \"C\",\n \"council_account_no\": \"ABC123\",\n \"portal_market_rent\": 800,\n \"portal_market_rent_frequency\": \"Monthly\",\n \"sharing_tenancies\": \"N/A\",\n \"i_manage_this\": true,\n \"features\": [\n \"Internet\",\n \"Fireplace\",\n \"Smart home integration\"\n ],\n \"tags\": [\n \"Cheap Rent\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 651669,\n \"property_id\": 282789,\n \"unit_type\": \"Residential\",\n \"unit_status\": \"Available To Let\",\n \"unit_ref\": \"Unit 1\",\n \"unit_vacant\": true,\n \"available_from\": \"2019-01-01\",\n \"owner\": {\n \"id\": null,\n \"full_name\": null\n },\n \"assigned_managers\": \"\",\n \"full_address\": \"Unit 1, Arthur House, 123 Property Street, Stevenage, Hertfordshire, AB1 2CD, United Kingdom (South East)\",\n \"address_line_1\": \"Arthur House\",\n \"address_line_2\": \"123 Property Street\",\n \"city\": \"Stevenage\",\n \"county\": \"Hertfordshire\",\n \"country\": \"United Kingdom\",\n \"area\": \"South East\",\n \"postcode\": \"AB1 2CD\",\n \"lat\": 51.903761,\n \"lng\": -0.196612,\n \"market_rent\": 800,\n \"market_rent_frequency\": \"Monthly\",\n \"available_since\": null,\n \"letting_agent_id\": null,\n \"letting_agent\": {\n \"id\": null,\n \"full_name\": null\n },\n \"portal_address\": \"Property Street, Stevenage, AB1\",\n \"short_description\": \"Brand new furnished unit in the heart of the city center!\",\n \"description\": \"This fabulous new property has been recently refurbished with close links to city center and nearby public transport. Please call now to book a viewing.\",\n \"portal_unit_type\": \"Apartment\",\n \"size\": \"500\",\n \"size_unit\": \"Sq Meter\",\n \"furnished\": \"Part-Furnished\",\n \"max_occupancy\": \"1\",\n \"bathrooms\": \"1\",\n \"floors\": \"1\",\n \"bedrooms\": \"1\",\n \"receptions\": \"1\",\n \"smart_meters\": \"No\",\n \"date_available\": \"2019-01-01\",\n \"rental_term\": \"Long\",\n \"deposit_amount\": 1600,\n \"service_charge\": true,\n \"service_charge_amount\": 75,\n \"council_tax_band\": \"C\",\n \"council_account_no\": \"ABC123\",\n \"council_id\": null,\n \"portal_market_rent\": 800,\n \"portal_market_rent_frequency\": \"Monthly\",\n \"sharing_tenancies\": \"N/A\",\n \"virtual_tour_url\": \"\",\n \"i_manage_this\": true,\n \"main_image_url\": null,\n \"epc_urls\": [],\n \"floor_plan_urls\": [],\n \"thumbnail_urls\": [],\n \"image_urls\": [],\n \"features\": [\n \"Fireplace\",\n \"Internet\",\n \"Smart home integration\"\n ],\n \"unit_features\": [\n \"Fireplace\",\n \"Internet\"\n ],\n \"additional_features\": [\n \"Smart home integration\"\n ],\n \"notes\": [],\n \"tags\": [\n \"Cheap Rent\"\n ],\n \"custom_fields\": [],\n \"relationships\": [\n {\n \"model\": \"Property\",\n \"model_id\": \"282789\",\n \"ref\": \"My big property\"\n }\n ],\n \"days_vacant\": \"1520 days ago\",\n \"days_vacant_total\": 1520,\n \"modified\": \"2023-03-01T16:14:06\",\n \"created\": \"2023-03-01T16:14:05\"\n }\n}"}],"_postman_id":"a357ed39-533d-43a8-8c63-64679f949525"}],"id":"fb8b4169-1815-449e-bdcc-8bc671e58d1e","description":"

Here you can find the full list of endpoints for the Units area of the system.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b7be6130-54c4-4491-a641-8a3481c89e5c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7a7aa223-b7d8-44be-84e8-bfbc2819bcb7"}}],"_postman_id":"fb8b4169-1815-449e-bdcc-8bc671e58d1e"},{"name":"Tenancies","item":[{"name":"Tenants","item":[{"name":"List Tenants On Tenancy","id":"077fc85b-89b7-466a-a518-58ff2bb5ddc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tenants","description":"

This retrieves a list of tenants related to a tenancy

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","tenants"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"d878ac96-eb29-4481-8215-2b7656a7dfff","name":"Get Tenants On Tenancy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tenants"},"status":"Get Tenants For Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"tenancy_id\": 123,\n \"status\": \"offline\",\n \"invite_code\": null,\n \"main_tenant\": false,\n \"move_in_date\": null,\n \"move_out_date\": null,\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": null,\n \"gender\": \"\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_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_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\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\": null,\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_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"applicant_note\": \"\",\n \"manager_note\": \"\",\n \"modified\": \"2020-03-03T16:11:24+00:00\",\n \"created\": \"2020-03-03T16:11:24+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 20,\n \"count\": 23,\n \"pageCount\": 2,\n \"limit\": 20\n }\n}"}],"_postman_id":"077fc85b-89b7-466a-a518-58ff2bb5ddc2"},{"name":"Add Tenant On Tenancy","id":"7f7cbf36-7296-45f3-a3df-da35ba4c93ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tenants","description":"

Use this endpoint to create a new tenant on a tenancy. The API will return the saved data and a unique tenant ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
main_tenant	True	Boolean	No
move_in_date	2019-05-28	Date	No
move_out_date	2019-06-28	Time	No
title	Mr	Enum	No
first_name	Ryan	String	No
last_name	Cullen	String	No
date_of_birth	1995-01-21	Date	No
gender	Male	Enum	No
citizen_type	1	Enum	No
email	email@gmail.com	String	No
company_name	MyCompany	Strong	No
compant_address_name	Address	String	No
company_address1	Boundry Road	String	No
company_address2	Wren Court	String	No
company_city	London	String	No
company_postcode	SW94DA	String	No
company_county	City of London	String	No
company_country	England	String	No
phone_home	029302932	String	No
phone_work	029382928	String	No
mobile	020192029	String	No
residential_number	201	String	No
visa_number	120-123	String	No
visa_years	3	String	No
visa_type	Tier 2	Enum	No
country_of_origin	Wales	String	No
ni_number	KS 01 AK 11 F	String	No
kin_mobile	029302991	String	No
kin_last_name	Cullen	String	No
kin_first_name	Monica	String	No
kin_phone_work	029320191	String	No
student_status	Full-time	String	No
university	Oxford	String	No
course_name	Doe Studies	String	No
course_id	1	String	No
course_year	2	String	No
employment_company_name	Lorem	String	No
employment_address1	Address First Line	String	No
employment_address2	Address Second Line	String	No
employment_city	Liverpool	String	No
employment_postcode	LN91LS	String	No
employment_county	Norfolk	String	No
employment_contact_name	Grace	String	No
employment_contact_number	0239203900	String	No
employment_salary	90000	String	No
employment_length	5 years	String	No
housing_benefit_council	Borought	String	No
housing_benefit_number	19203	String	No
guarantor_first_name	Nicolas	String	No
guarantor_last_name	Cage	String	No
guarantor_date_of_birth	1911-02-12	String	No
guarantor_address1	Address first line	String	No
guarantor_address2	Address second line	String	No
guarantor_city	London	String	No
guarantor_postcode	XP91AP	String	No
guarantor_county	Suffolk	String	No
guarantor_country	England	String	No
guarantor_phone_home	028392871	String	No
guarantor_phone_work	028191282	String	No
guarantor_mobile	029384383	String	No
guarantor_email	guarantor@email.com	String	No
guarantor_relation	Brother	String	No
guarantor_home_owner	Yes	String	No
guarantor_profession	Teacher	String	No
bank_name	Barclays	String	No
bank_address1	Address first line	String	No
bank_address2	Address second line	String	No
bank_city	Romford	String	No
bank_county	Essex	String	No
bank_postcode	FS18LA	String	No
ref_name	Ref Name	String	No
ref_address1	Ref First Line	String	No
ref_address2	Ref Second Line	String	No
ref_county	Ref Hertfordshire	String	No
ref_city	Ref City	String	No
ref_postcode	Ref Postcode	String	No
ref_contact_number	029392832	String	No
ref_relation	Mother	String	No
applicant_note	Note to remember	String	No
manager_note	Manager note	String	No

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","tenants"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e68492f1-18a9-49ee-91c2-4b2fac60ea52","name":"Add Tenant On Tenancy","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tenants"},"status":"Add Tenant For Tenancy","_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"tenancy_id\": 123,\n \"status\": \"offline\",\n \"invite_code\": null,\n \"main_tenant\": false,\n \"move_in_date\": null,\n \"move_out_date\": null,\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": null,\n \"gender\": \"\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_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_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\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\": null,\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_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"applicant_note\": \"\",\n \"manager_note\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n}"}],"_postman_id":"7f7cbf36-7296-45f3-a3df-da35ba4c93ce"}],"id":"41569b6f-0d2b-4fe7-ac12-953cbe035c1f","description":"

This section provides resources for dealing with Tenants related to a tenancy.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"102270da-6a05-41e3-8bf5-1a822177816d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2ea854bd-555b-42c8-accc-02ab45af5784"}}],"_postman_id":"41569b6f-0d2b-4fe7-ac12-953cbe035c1f"},{"name":"Assets","item":[{"name":"List Assets On Tenancy","id":"8cebe981-7db0-4f36-9cf5-3c20f895ac4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/assets","description":"

This endpoint retrieves a list of assets associated with the given tenancy ID.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"6def31b8-0b83-478c-971b-c64322b23a57","name":"List Assets On Tenancy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \" Inventory\",\n \"description\": \" Inventory\",\n \"created_by\": {\n \"full_name\": \"Brian Williams\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Inventory\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Inventory\",\n \"model_id\": 123\n },\n {\n \"id\": 123,\n \"model\": \"Tenancy\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-06-23T11:13:02+01:00\",\n \"modified\": \"2020-06-23T11:13:02+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"8cebe981-7db0-4f36-9cf5-3c20f895ac4a"},{"name":"Create Asset On Tenancy","id":"68b8534a-5c7f-4603-9a2c-edef132c8cf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/assets","description":"

Use this endpoint to create a new asset related to an tenancy. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
asset_type	image	String	No
name	inventory	String	No
share_manager	true	Boolean	No
share_tenant	false	Boolean	No
share_contractor	true	Boolean	No
share_owner	true	Boolean	No
file	base64	String	Yes
mime_type	application/pdf	String	Yes
file_name	inventory	String	Yes

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"94a85317-e543-4874-bfc2-77622c8892cf","name":"Create Asset On Tenancy","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset_type\":\"image\",\n\t\"name\":\"name of asset\",\n\t\"share_manager\":true,\n\t\"share_tenant\":true,\n\t\"share_owner\":true,\n\t\"share_contractor\":true,\n\t\"file\":\"pdf file converted to base64 string\",\n\t\"mime_type\":\"application/pdf\",\n\t\"file_name\":\"inventory\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"name of asset\",\n \"description\": null,\n \"created_by\": {\n \"full_name\": \"Brian Wilson\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Image\",\n \"share_manager\": true,\n \"share_owner\": true,\n \"share_tenant\": true,\n \"share_contractor\": true,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Tenancy\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-07-03T09:25:52+01:00\",\n \"modified\": \"2020-07-03T09:25:52+01:00\"\n }\n}"}],"_postman_id":"68b8534a-5c7f-4603-9a2c-edef132c8cf5"}],"id":"99f077c5-28d3-4e73-a862-28c04ac6b899","description":"

This section provides resources for dealing with Assets related to a tenancy.

\n","_postman_id":"99f077c5-28d3-4e73-a862-28c04ac6b899"},{"name":"Certificates","item":[{"name":"List Certificates On Tenancy","id":"c3b26685-8cdc-443a-a016-6019b530fec0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/certificates","description":"

This endpoint retrieves a list of certificates associated with the given tenancy ID.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","certificates"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ecad863d-9276-4147-afac-b3017b33838e","name":"List Certificates On Tenancy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/certificates"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 12345,\n \"type\": \"Gas Safety\",\n \"expiry_date\": \"2021-06-06\",\n \"status\": \"Expired\",\n \"missing\": false,\n \"file\": {\n \"id\": 12345,\n \"download_url\": \"https://asset.arthuronline.co.uk/download/{uuid}\",\n \"mime_type\": \"image/jpeg\"\n },\n \"property\": {\n \"id\": 1234,\n \"address\": \"Multiple Unit Property, test, ABC 123\"\n },\n \"unit\": {\n \"id\": 123,\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"tenancy\": {\n \"id\": 123456,\n \"ref\": \"TE1000\",\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"notes\": \"My Certificate Notes\",\n \"share_manager\": true,\n \"share_tenant\": false,\n \"share_contractor\": true,\n \"share_owner\": false,\n \"created\": \"2021-01-01T12:00:00\",\n \"modified\": \"2021-01-01T12:00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"c3b26685-8cdc-443a-a016-6019b530fec0"},{"name":"🆕 Add Certificate on Tenancy","id":"ef6d37f5-2243-4939-84cb-13d812d1aa01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/certificates","description":"

Use this endpoint to create a new certificate related to a tenancy. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
type	Boiler Service	String	Yes
expiry_date	2023-12-05	String	No
notes	Fully assessed	String	No
file	Base64	String	No
mime_type	application/pdf	String	No (Required if File field is present)
file_name	Certificate Document	string	No (Required if File field is present)

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","certificates"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"96486201-d052-48c1-b120-2a97404193a4","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"Boiler Service\",\n \"expiry_date\" : \"2022-02-28\",\n \"notes\" : \"Fully assessed\",\n \"file\" : \"JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjE2Ljg5NjAgVGQNCiggdGV4dC4gQW5kIG1vcmUgdGV4dC4gQm9yaW5nLCB6enp6ei4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjA0Ljk0NDAgVGQNCiggbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDU5Mi45OTIwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTY5LjA4ODAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NTcuMTM2MCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBFdmVuIG1vcmUuIENvbnRpbnVlZCBvbiBwYWdlIDIgLi4uKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjYgMCBvYmoNCjw8DQovVHlwZSAvUGFnZQ0KL1BhcmVudCAzIDAgUg0KL1Jlc291cmNlcyA8PA0KL0ZvbnQgPDwNCi9GMSA5IDAgUiANCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBTaW1wbGUgUERGIEZpbGUgMiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIC4uLmNvbnRpbnVlZCBmcm9tIHBhZ2UgMS4gWWV0IG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NzYuNjU2MCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY2NC43MDQwIFRkDQooIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiBCdXQgbm90IGFzIGJvcmluZyBhcyB3YXRjaGluZyApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY1Mi43NTIwIFRkDQooIHBhaW50IGRyeS4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NDAuODAwMCBUZA0KKCBCb3JpbmcuICBNb3JlLCBhIGxpdHRsZSBtb3JlIHRleHQuIFRoZSBlbmQsIGFuZCBqdXN0IGFzIHdlbGwuICkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo4IDAgb2JqDQpbL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZVwpKQ0KL1Byb2R1Y2VyIChOZXZyb25hIERlc2lnbnMpDQovQ3JlYXRpb25EYXRlIChEOjIwMDYwMzAxMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQowIDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgbg0KMDAwMDAwMDA5MyAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg==\",\n \"mime_type\" : \"application/pdf\",\n \"file_name\" : \"file_name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/certificates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Mar 2023 15:08:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"2da-TFzay8B5rqUHpbI91REJ5NN0GmI\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=nIfoaJuPhXz%2BCtwczYezUqwos7Ar1RJJtAsqTkK1gW%2FaL6RT2i8KS%2FB3a3Lew%2BgUCj2GMLlDAlsRkOkqwiickGxsLK3P9TCk%2FzTFO9xbHhI2vDamUwe6G4ihQBlH9%2FLu7wHn4utkUPU%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7a3b83059e8b4167-LHR"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 878809,\n \"type\": \"Boiler Service \",\n \"expiry_date\": \"2022-02-28\",\n \"status\": \"Expired\",\n \"missing\": false,\n \"file\": {\n \"id\": 5779465,\n \"download_url\": \"https://asset.arthuronline.co.uk/download/27210b2b-896e-45fe-949f-171f90998f14\",\n \"mime_type\": \"application/pdf\"\n },\n \"property\": {\n \"id\": 280736,\n \"address\": \"5 marford close, northwich, Cheshire, CW9 8WW\"\n },\n \"unit\": {\n \"id\": 599238,\n \"address\": \"Unit 2 - B, 5 marford close, northwich, Cheshire, CW9 8WW\"\n },\n \"tenancy\": {\n \"id\": 709960,\n \"ref\": \"TE1197\",\n \"address\": \"Unit 2 - B, 5 marford close, northwich, Cheshire, CW9 8WW\"\n },\n \"notes\": \"Fully assessed\",\n \"share_manager\": true,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"share_owner\": false,\n \"created\": \"2023-03-06T15:08:02\",\n \"modified\": \"2023-03-06T15:08:02\"\n }\n}"}],"_postman_id":"ef6d37f5-2243-4939-84cb-13d812d1aa01"}],"id":"9e0f0fb0-b877-46c1-b5ce-19267e47b98f","description":"

This section provides resources for dealing with Certificates related to a tenancy.

\n","_postman_id":"9e0f0fb0-b877-46c1-b5ce-19267e47b98f"},{"name":"Register Deposit","item":[{"name":"🆕 Register Deposit on Tenancy","id":"76a210d9-7d08-42f2-9594-792ee6135c0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{id}/register_deposit","description":"

This endpoint retrieves the registered deposit associated with the given tenancy ID.

Use this endpoint to update the registered deposit related to a tenancy. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
deposit_registered_not_needed	true	Boolean	No
date_registered	2023-12-05	String	No
certificate_no	ABC	String	No
deposit_scheme	Base64	String	No
deposit_held_by	TDS	String	No
deposit_required	1200	string	No
deposit_registered	true	Boolean	No

The \"deposit_scheme\" field is required to have one of the following values:

Tenancy Deposit Scheme (TDS)
Deposit Protection Service (DPS)
MyDeposits
Letting Protection Scotland
Safe Deposits Scotland
My Deposits Scotland
Reposit
N/A

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{id}","register_deposit"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"282bfaa0-3abc-425f-8aaa-6951695500b5","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deposit_registered_not_needed\" : true,\n \"date_registered\": \"2022-01-20\",\n \"certificate_no\": \"ABC123\",\n \"deposit_scheme\": \"Tenancy Deposit Scheme (TDS)\",\n \"deposit_held_by\": \"TDS\",\n \"deposit_required\": \"1200\",\n \"deposit_registered\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/709960/register_deposit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Mar 2023 15:43:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"1cc-vKXv1kh5fUcK6OA3Sut+autQ8TM\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=4zKLnxtLYPF3cMMH%2BscH2YbZMJ4pw%2FuHsmy2Neud5%2F%2BCSJ2fPQe74K%2FJWPCwFD%2F8jDWMWoTKCfFfajxUcBcRjzCjXoPfbUJND%2FLC3fgxG9s%2FQp%2BXK%2FCXu2zQuQNEh6deYcI%2BlyThSw4%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7a3bb668feb67779-LHR"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"tenancy_id\": 709960,\n \"deposit_registered_not_needed\": true,\n \"date_registered\": \"2022-01-20\",\n \"payment_id\": \"\",\n \"certificate_no\": \"ABC123\",\n \"deposit_scheme\": \"Tenancy Deposit Scheme (TDS)\",\n \"deposit_held_by\": \"TDS\",\n \"deposit_required\": \"1200.00\",\n \"deposit_registered\": true,\n \"image_urls\": [],\n \"document_urls\": [\n \"https://asset.arthuronline.co.uk/download/27210b2b-896e-45fe-949f-171f90998f14\"\n ],\n \"modified\": \"2023-03-06T15:43:07\",\n \"created\": \"2023-03-06T09:08:26\"\n }\n}"}],"_postman_id":"44aff61a-d065-4fe0-9ada-ed9973b45ad2"}],"id":"08928b00-9337-4623-a6b0-a8004e76b749","description":"

This section provides resources for dealing with Registering Deposits related to a tenancy.

\n","_postman_id":"08928b00-9337-4623-a6b0-a8004e76b749"},{"name":"Tasks","item":[{"name":"List Tasks On Tenancy","id":"7a49c42d-03c6-483d-9960-6038380646c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tasks","description":"

This endpoint retrieves a list of tasks associated with the given tenancy ID.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","tasks"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"5407e627-d610-4559-a19e-43f4e0af176d","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tasks"},"status":"List Tasks On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Need to fix the boiler\",\n \"total_subtasks\": 0,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"Raven Drive 51, 3 Inn Court, London, NW15LG\",\n \"related_to\":\"\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [\n \"http://arthur.localhost/public/attachments...\"\n ],\n \"document_urls\": [\n \"http://arthur.localhost/public/attachments...\"\n ],\n \"tags\": [\n \"one\",\n \"two\"\n ],\n \"api_notes\": \"\",\n \"modified\": \"2020-02-26T12:41:53+00:00\",\n \"created\": \"2020-02-26T12:40:29+00:00\"\n }\n]"}],"_postman_id":"7a49c42d-03c6-483d-9960-6038380646c8"},{"name":"View Task On Tenancy","id":"1f014e81-3100-45b5-8f94-a67f87ab53de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tasks/{{task_id}}","description":"

This API endpoint retrieves the details of a single tenancy task, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","tasks","{{task_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"98f557cd-9ce2-4e4d-82a0-41fa6086020e","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tasks/{{task_id}}"},"status":"View Note On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Fix the boiler please\",\n \"total_subtasks\": 0,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"Swan Drive 51, 3 Wren Court, London, NW95DG\",\n \"related_to\":\"\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [\n \"z narni\",\n \"slay\"\n ],\n \"api_notes\": \"\",\n \"modified\": \"2020-02-26T10:49:28+00:00\",\n \"created\": \"2020-02-26T10:49:28+00:00\"\n }\n ]\n}"}],"_postman_id":"1f014e81-3100-45b5-8f94-a67f87ab53de"},{"name":"Add Task On Tenancy","id":"8086d69c-53fa-4e19-adb5-10e1d43d897a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tasks","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.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
task_type	Inspection	String	No
description	Radiator not working	String	Yes
tags	['one','two']	Array(String)	No
due_date	2020-10-11	Date	No
due_time	15:32	Time	No
assigned_managers	[123,1234]	Array(Integer)	No
emergency	True	Boolean	No
private	True	Boolean	No
api_notes	Landlord will be present	String	No
files (each object must contain \"file_type\", \"file_name\", and \"file\")	{ \"file_type\":\"application/pdf\", \"file_name\":\"testing\", \"file\":\"(base 64)\" }	[Array {Objects}]	No

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","tasks"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ba19f751-bdda-403a-ba13-f5f43382e88b","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"description\":\"Fix windows please\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tasks"},"status":"Add Task On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Fix windows please\",\n \"total_subtasks\": 0,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"51 Litchfield , 3 Raven Court, NS19SA\",\n \"related_to\":\"\",\n \"due_date\": null,\n \"due_time\": null,\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [],\n \"api_notes\": \"\",\n \"modified\": \"2020-03-05T12:17:07+00:00\",\n \"created\": \"2020-03-05T12:17:07+00:00\"\n }\n}"}],"_postman_id":"8086d69c-53fa-4e19-adb5-10e1d43d897a"},{"name":"Update Task On Tenancy","id":"0a38de39-243b-425c-b896-de07a44e2c9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tasks/{{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.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
task_type	Inspection	String	No
description	Radiator not working	String	No
tags	['one','two']	Array(String)	No
due_date	2020-10-11	Date	No
due_time	15:32	Time	No
assigned_managers	[123,1234]	Array(Integer)	No
emergency	True	Boolean	No
private	True	Boolean	No
api_notes	Landlord will be present	String	No

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","tasks","{{task_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"565288c2-1dea-469f-928d-7e311292f195","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"description\":\"Fix windows please updated\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tasks/{{task_id}}"},"status":"Update Task On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Fix windows please updated\",\n \"total_subtasks\": 0,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"51 Litchfield , 3 Raven Court, NS19SA\",\n \"related_to\":\"\",\n \"due_date\": null,\n \"due_time\": null,\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [],\n \"api_notes\": \"\",\n \"modified\": \"2020-03-05T12:17:07+00:00\",\n \"created\": \"2020-03-05T12:17:07+00:00\"\n }\n}"}],"_postman_id":"0a38de39-243b-425c-b896-de07a44e2c9f"},{"name":"🆕 Delete Task On Tenancy","id":"458c7129-f676-467e-9aca-4c7128dae0e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}","description":"

This endpoint deletes an existing asset record using the task id, under a tenancy ID

This section provides resources for dealing with Tasks related to a tenancy.

\n","_postman_id":"5202d8a0-5b19-4b61-8741-3eeb9482a5d8"},{"name":"Workorders","item":[{"name":"List Workorders On Tenancy","id":"188974e5-add5-4b20-815c-8d6f2b9ab778","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/workorders","description":"

This endpoint retrieves a list of workorders associated with the given tenancy ID.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","workorders"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"5f2cbb8a-be41-442f-84fb-880a7dcd44f3","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/workorders"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Unit 123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"188974e5-add5-4b20-815c-8d6f2b9ab778"},{"name":"View Workorder On Tenancy","id":"31881929-4079-405e-be11-f2a55c08b5fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/workorders/{{workorder_id}}","description":"

This API endpoint retrieves the details of a single tenancy workorder, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","workorders","{{workorder_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"42bf53e6-39fa-48b9-b6cb-9ea16bb2f1df","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/unit/{{unit_id}}/workorders/{{workorder_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"31881929-4079-405e-be11-f2a55c08b5fe"},{"name":"Create Workorder On Tenancy","id":"85fa2864-0df8-4e66-b4ad-2e2aa9fb4372","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/workorders","description":"

Use this endpoint to create a new workorder record for a tenancy. The API will return the saved data and a unique workorder ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
title	workorder title	String	No
description	workorder description	String	No
invite_contractors	[123,1234]	Array(integer)	No
service_type	Carpet Layer	String	Yes
start_date	2020-02-20	Date	No
due_date	2020-02-20	Date	No
budget	1000,00	Float	No
allocated_time_hours	20	Float	No
actual_time_hours	20	Float	No
price_per_hour	7,90	Float	No
emergency	true	Boolean	No
quote_required	true	Boolean	No
share_assets	false	Boolean	No
hide_tenant_details	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","workorders"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"38fe80b9-80f3-4b72-901a-7aa709b3eb7c","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"service_type\":\"aerial network specialist\",\n \"title\":\"Workorder title\",\n \"description\":\"Workorder Description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/workorders"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Unit 123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 0,\n \"full_name\": \"\",\n \"status\": \"\"\n },\n \"invited_contractors\": [],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"unit address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"85fa2864-0df8-4e66-b4ad-2e2aa9fb4372"},{"name":"Update Workorder On Tenancy","id":"6e415bcc-4326-47f2-9772-9b64e30a369f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancy/{{tenancy_id}}/workorders/{{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.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
title	workorder title	String	No
description	workorder description	String	No
invite_contractors	[123,1234]	Array(integer)	No
service_type	Carpet Layer	String	No
start_date	2020-02-20	Date	No
due_date	2020-02-20	Date	No
budget	1000,00	Float	No
allocated_time_hours	20	Float	No
actual_time_hours	20	Float	No
price_per_hour	7,90	Float	No
emergency	true	Boolean	No
quote_required	true	Boolean	No
share_assets	false	Boolean	No
hide_tenant_details	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","tenancy","{{tenancy_id}}","workorders","{{workorder_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"7340a500-e093-485e-92b9-2277646a6889","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\":\"Updated title\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/workorders/{{workorder_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Updated title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"unit address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"6e415bcc-4326-47f2-9772-9b64e30a369f"}],"id":"c6b9b232-6923-4834-a78a-b1f807d4c5c7","description":"

This section provides resources for dealing with Workorders related to a tenancy.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4744e71f-1c2b-4fec-94b8-a5f629f27f58"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"bc2e2431-e7a5-4297-b270-67d3b8385ee6"}}],"_postman_id":"c6b9b232-6923-4834-a78a-b1f807d4c5c7"},{"name":"Conversations","item":[{"name":"Conversation Recipients","item":[{"name":"Get Recipients for Tenancy","id":"004f7f09-0272-445d-a719-2f767a8fb7c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/conversation_recipients","description":"

This endpoint retrieves a list of conversation recipients on a tenancy record, identified by its unique tenancy_id.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","conversation_recipients"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"dbe9f045-6a7d-4233-8175-85305ff77378","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/conversation_recipients"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Henry\",\n \"last_name\": \"Williams\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 2,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Mike\",\n \"last_name\": \"Marky\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 3,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Tenants\",\n \"first_name\": \"Josh\",\n \"last_name\": \"Jackson\",\n \"group\": \"tenant\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 4,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Tenants\",\n \"first_name\": \"Brian\",\n \"last_name\": \"Shaw\",\n \"group\": \"tenant\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 5,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Guarantors\",\n \"first_name\": \"Jason\",\n \"last_name\": \"Doe\",\n \"group\": \"guarantor\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:28:56+01:00\",\n \"modified\": \"2020-06-29T14:28:56+01:00\"\n },\n {\n \"id\": 6,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Owner\",\n \"first_name\": \"Leon\",\n \"last_name\": \"Silva\",\n \"group\": \"owner\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:28:56+01:00\",\n \"modified\": \"2020-06-29T14:28:56+01:00\"\n }\n ]\n}"}],"_postman_id":"004f7f09-0272-445d-a719-2f767a8fb7c6"}],"id":"95cb4b0d-c249-4614-a4cc-f9de2d83c1ca","description":"

Here you can find the full list of endpoints for the Conversation Receipients area of the system, related to a Tenancy record.

\n","_postman_id":"95cb4b0d-c249-4614-a4cc-f9de2d83c1ca"},{"name":"List Conversation On Tenancy","id":"7ca31ca0-9755-46cf-bee3-3912afac2a20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/conversations","description":"

This endpoint retrieves a list of conversations on a tenancy, identified by its unique tenancy_id.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"8918101c-b284-49dc-8b66-c86bb2fa1323","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"title\": \"Subject 1\",\n \"message_count\": 1,\n \"model\": \"Tenancy\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Sure!\",\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"modified\": \"2020-04-22T12:03:28+01:00\"\n },\n {\n \"id\": 123,\n \"title\": \"Subject 2\",\n \"message_count\": 1,\n \"model\": \"Tenancy\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Remember to clean on friday.\",\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"modified\": \"2020-04-30T11:49:54+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"7ca31ca0-9755-46cf-bee3-3912afac2a20"},{"name":"Create Conversation On Tenancy","id":"deefc449-3549-43ae-b3bb-3331ee7aac59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/conversations","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.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
message	It's done	String	Yes
subject	Meeting tomorrow	String	Yes
person_ids	['1','2']	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"0ec62bb4-5371-4631-9d7f-94e952078aa5","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"message\":\"Please clean the house on friday.\",\n\t\"subject\":\"House duties\",\n\t\"person_ids\":[\"21\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"House duties\",\n \"message_count\": 1,\n \"model\": \"Tenancy\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 2,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 21,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Please clean the house on friday.\",\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"modified\": \"2020-06-05T15:06:26+01:00\"\n }\n}"}],"_postman_id":"deefc449-3549-43ae-b3bb-3331ee7aac59"}],"id":"5b588d5e-f31d-45e0-acd8-3fee9105da30","description":"

This section provides resources for dealing with Conversations related to a tenancy.

\n","_postman_id":"5b588d5e-f31d-45e0-acd8-3fee9105da30"},{"name":"Transactions","item":[{"name":"List Transactions On Tenancy","id":"7a660a7c-2eae-462a-a956-48d4049cc203","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/transactions","description":"

This retrieves a list of transactions for a Tenancy

See available filters below to customize the list of transactions returned.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","transactions"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"statement","value":""},{"disabled":true,"description":{"content":"

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.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"date_from","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"date_to","value":""}],"variable":[]}},"response":[{"id":"a5b4d5cc-7e4a-406e-bb23-df1fd1d590d4","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/transactions"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ref\": \"TR007\",\n \"transaction_type\": \"Registered Deposit Charge\",\n \"payment_type\": \"charge\",\n \"description\": \"Registered Deposit\",\n \"property_id\": 11,\n \"unit_id\": 22,\n \"tenancy_id\": 123,\n \"payee_group_id\": 10,\n \"invoice_ref\": \"\",\n \"payee_tenant_id\": 44,\n \"amount\": \"1500.00\",\n \"amount_charged\": \"1500.00\",\n \"amount_paid\": \"0.00\",\n \"amount_outstanding\": \"1500.00\",\n \"amount_net\": \"1500.00\",\n \"vat_code_id\": 4,\n \"source\": \"arthur\",\n \"created_by\": {\n \"id\": 11,\n \"full_name\": \"Brian Brown\"\n },\n \"payee_name\": \"Thomas Smith\",\n \"payee_person_id\": null,\n \"payee_entity_id\": 0,\n \"date\": \"2020-06-25\",\n \"due_date\": \"2020-06-25\",\n \"modified\": \"2020-06-25T15:35:01+01:00\",\n \"created\": \"2020-06-25T15:35:01+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"7a660a7c-2eae-462a-a956-48d4049cc203"}],"id":"77dd0102-5006-4e2a-85ff-efef021f4189","description":"

This section provides resources for dealing with Transactions related to a tenancy.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"78590193-1eeb-4d15-93d5-549586909cee"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c22aecbd-9bfa-434f-bc00-9ba3e70a2ab1"}}],"_postman_id":"77dd0102-5006-4e2a-85ff-efef021f4189"},{"name":"Notes","item":[{"name":"List Notes On Tenancy","id":"00a87d9c-deff-4ca9-9c4d-42198d867ded","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/notes","description":"

This endpoint retrieves a list of notes associated with the given tenancy ID.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"92e0ca4b-0176-4fd0-a524-b91759c58153","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/notes"},"status":"List Notes On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\"last_edited_by\": {\n \t\"id\": null,\n \t\"full_name\": null\n \t},\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \t\"modified\": \"2020-05-28T11:57:55+01:00\"\n },\n {\n \"id\": 1234,\n \"content\": \"Remember this note , please\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\"last_edited_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \t\"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n"}],"_postman_id":"00a87d9c-deff-4ca9-9c4d-42198d867ded"},{"name":"View Note On Tenancy","id":"451b6956-5b0a-4ebc-bb33-8ea99b717f81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/notes/{{note_id}}","description":"

This API endpoint retrieves the details of a single tenancy note, identified by its unique id

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"cb75aa31-3eea-42ea-a537-02f73026a43e","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/notes/{{note_id}}"},"status":"View Note On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Interesting\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}\n"}],"_postman_id":"451b6956-5b0a-4ebc-bb33-8ea99b717f81"},{"name":"Add Note On Tenancy","id":"f1890973-fec6-451c-9fa8-2339782bea1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/notes","description":"

Use this endpoint to create a new note record for a tenancy. The API will return the saved data and a unique note ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	Yes
tags	['one','two']	Array(String)	No

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b39e2f15-e6f5-4910-957c-462c8de5ff1d","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\":\"Remember this note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/notes"},"status":"Add Note On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": null,\n \"full_name\": null\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [\n {\n \"id\": 123,\n \"name\": \"one\"\n },\n {\n \"id\": 1234,\n \"name\": \"two\"\n }\n ],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"f1890973-fec6-451c-9fa8-2339782bea1d"},{"name":"Update Note On Tenancy","id":"c97b097b-1a2d-432e-a8c4-fada86325755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/notes/{{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.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	No
tags	['one','two']	Array(String)	No

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"24cc8e26-c46e-42a0-a722-16a8f787de62","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\":\"Updated Note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/notes/{{note_id}}"},"status":"Update Note On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Updated Note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}\n"}],"_postman_id":"c97b097b-1a2d-432e-a8c4-fada86325755"},{"name":"Delete Note On Tenancy","id":"a9e6e0ad-2c03-4e83-9cdf-41235a0bc4fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/notes/{{note_id}}","description":"

This endpoint deletes an existing tenancy note using the note id.

This section provides resources for dealing with Notes related to a tenancy.

\n","_postman_id":"8c438090-ed01-4016-84a2-19ad0e2e5182"},{"name":"Tags","item":[{"name":"🆕 List Tags on Tenancy","id":"75d39e97-0768-4901-82c0-e18f6342a11a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tags","description":"

This endpoint retrieves a list of tags associated with the given Tenancy ID.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"fc9ec0b6-2230-44b9-bf53-93b4dee43aa1","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tags"},"status":"List Tags On Resource","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"tag one\",\n \"color\": \"sky\"\n },\n {\n \"id\": 123,\n \"name\": \"tag two\",\n \"color\": \"lightgreen\"\n },\n {\n \"id\": 123,\n \"name\": \"tag three\",\n \"color\": \"purple\"\n }\n ]\n}"}],"_postman_id":"75d39e97-0768-4901-82c0-e18f6342a11a"},{"name":"Tag Tenancy","id":"82c9c419-b432-41db-af6b-b3d721bda45a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tags","description":"

Use this endpoint to create a new tag record for a tenancy. The API will return the saved data and a unique tag ID.

Supported Fields

The following fields are supported for the request body
Tag field should be a valid tag ID or name.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	[\"123\"]	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"efc8c229-b3e9-486f-a797-cd4cca2251a4","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":[\"1234\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/tags"},"status":"Tag Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1234,\n \"name\": \"Tag one\",\n \"color\": \"orange\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 12,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"82c9c419-b432-41db-af6b-b3d721bda45a"},{"name":"Untag Tenancy","id":"2f4548ba-4656-4150-a2ce-ed0756cdb09c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/untag","description":"

Use this endpoint to unassign tag record from a tenancy. The API will return the saved data. Tag field should be a valid tag ID or name.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	\"1234\"	String	Yes

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","untag"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e32abd48-f167-4a22-9a90-2c7f92ccba52","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":\"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/untag"},"status":"Untag Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"2f4548ba-4656-4150-a2ce-ed0756cdb09c"},{"name":"Untag All Tenancy Tags","id":"b32be9ff-915c-48ce-b925-67286052d798","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/untag_all","description":"

Use this endpoint to unassign all tags from the tenancy.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}","untag_all"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"19c4c9c3-3321-408b-bd05-3fa53e16ed77","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/untag_all"},"status":"Untag All Tenancy Tags","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"b32be9ff-915c-48ce-b925-67286052d798"}],"id":"50205c83-064a-4d32-954b-68758497a0e0","description":"

This section provides resources for dealing with Tags related to a tenancy.

\n","_postman_id":"50205c83-064a-4d32-954b-68758497a0e0"},{"name":"Recurrings","item":[{"name":"List Recurrings","id":"349c705d-dd8c-40a1-822a-6b4888a7cb72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-EntityID","value":"{{entityId}}","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancyId}}/recurrings","description":"

This endpoint retrieves a list of recurrings associated to a specific tenancy

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancyId}}","recurrings"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"7c85724e-ecc6-4b73-834c-3b9646fd805c","name":"List Recurrings","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"X-EntityID","value":"{{entityId}}","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancyId}}/recurrings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1481960,\n \"tenancy_id\": 966665,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2025-01-31\",\n \"next_collection_date\": null,\n \"end_type\": \"tenancy-end\",\n \"end_date\": \"2025-01-29T00:00:00\",\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Arthur Lettings\"\n },\n \"active\": false,\n \"created\": \"2025-01-29T12:49:28\",\n \"modified\": \"2025-01-29T12:59:49\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"349c705d-dd8c-40a1-822a-6b4888a7cb72"}],"id":"faf2d3d0-5334-4779-9a3f-a123999840cc","description":"

This section provides resources for dealing with Recurrings related to a tenancy.

\n","_postman_id":"faf2d3d0-5334-4779-9a3f-a123999840cc"},{"name":"List Tenancies","id":"5fe22331-5e3a-47d7-a347-50c440ac1e36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies","description":"

This retrieves a list of tenancies.

See available filters below to customize the list of tenants returned.

\n","urlObject":{"protocol":"https","path":["v2","tenancies"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by unit manager ID

\n","type":"text/plain"},"key":"assigned_to","value":""},{"disabled":true,"description":{"content":"

Filter by tags associated with the tenancy, which should be provided as a comma-separated list

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter by tenancies move in date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"moveInDate","value":""},{"disabled":true,"description":{"content":"

Filter by tenancy move out date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"moveOutDate","value":""},{"disabled":true,"description":{"content":"

Filter by the last modified date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"modified","value":""},{"disabled":true,"description":{"content":"

Filters tenancies by the modified date, starting from the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"modifiedFrom","value":""},{"disabled":true,"description":{"content":"

Filters tenancies by the modified date, up to the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"modifiedTo","value":""},{"disabled":true,"description":{"content":"

Filter by the tenancy status

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by the full address of the property

\n","type":"text/plain"},"key":"full_address","value":""},{"disabled":true,"description":{"content":"

Filter by the tenancy type

\n","type":"text/plain"},"key":"tenancy_type","value":""},{"disabled":true,"description":{"content":"

Filter by the tenancy sub type

\n","type":"text/plain"},"key":"tenancy_sub_type","value":""},{"disabled":true,"description":{"content":"

Filer by the landlord ID

\n","type":"text/plain"},"key":"unit_owner_id","value":""},{"disabled":true,"description":{"content":"

Filter by the letting agent ID

\n","type":"text/plain"},"key":"letting_agent_id","value":""},{"disabled":true,"description":{"content":"

Filter by start date

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Filter by end date

\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"

Filter by a keyword

\n","type":"text/plain"},"key":"_q","value":""}],"variable":[]}},"response":[{"id":"90c61ae2-cf77-426c-a731-8897bd361d8b","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n \t{\n\t \"id\": 12345,\n \t\"property_id\": 11223,\n \t\"unit_id\": 22334,\n \t\"ref\": \"TE1001\",\n \t\"status\": \"Current\",\n \t\"full_address\": \"Flat 10, 2 Station Road, London, EN5 1QW\",\n \t\"unit_owner\": \"\",\n \t\"tenancy_type\": \"Commercial\",\n \t\"unit_assigned_managers\": \"\",\n \t\"main_tenant_name\": \"tenant one\",\n\t \"tenants\": [\n\t {\n\t \"id\": 12121,\n \t\"first_name\": \"tenant\",\n \t\"last_name\": \"one\",\n \t\"date_of_birth\": \"1980-05-06\",\n \t\"mobile\": \"07123456789\",\n \t\"phone_home\": \"\",\n \t\"phone_work\": \"\",\n \t\"email\": \"sales@arthuronline.co.uk\",\n \t\"lastest_credit_score\": \"0\",\n \t\"lastest_credit_description\": \"\",\n \t\"main_tenant\": true,\n \t\"move_in_date\": \"2019-01-01\",\n \t\"move_out_date\": \"2020-01-01\"\n\t }\n\t ],\n\t \"letting_agent\": {\n\t \"id\": 99999,\n\t \"first_name\": \"Arthur\",\n\t \"last_name\": \"Agency\",\n\t \"primary_phone\": \"\",\n\t \"primary_email\": \"sales+agent@arthuronline.co.uk\"\n\t },\n\t \"contract_type\": \"Company\",\n \t\"renter_company\": \"\",\n \t\"start_date\": \"2019-09-01\",\n \t\"end_date\": \"2020-09-01\",\n \t\"break_clause_date\": null,\n \t\"fixed_break_date\": \"2020-02-13\",\n \t\"rolling_break_date\": \"2019-09-18\",\n \t\"notice_period\": \"1 months\",\n \t\"issue_break_clause_to\": \"landlord\",\n \t\"move_in_date\": \"2019-01-02\",\n \t\"move_in_time\": \"12:00\",\n \t\"move_out_date\": null,\n \t\"move_out_time\": null,\n \t\"rent_amount\": 875,\n \t\"rent_frequency\": \"Monthly\",\n \t\"deposit_held_by\": \"\",\n \t\"deposit_registered\": false,\n \t\"deposit_registered_amount\": \"\",\n \t\"rent_review_date\": null,\n \t\"section_21_served\": false,\n\t \"rent_payment_bank\": {\n\t \"id\": 55555,\n\t \"bank_name\": \"\",\n\t \"bank_account\": \"Arthur default account\",\n\t \"account_number\": \"00000000\",\n\t \"sort_code\": \"000000\"\n\t },\n\t \"deposit payment bank\": {\n\t \"id\": 5556,\n\t \"bank_name\": \"\",\n\t \"bank_account\": \"Arthur default account\",\n\t \"account_number\": \"00000000\",\n\t \"sort_code\": \"000000\"\n\t },\n\t \"default_rent_payment_method\": \"Bank Transfer\",\n\t \"rent_insured\": false,\n\t\t\t\"tags\": [],\n \t\"notes\": [],\n\t \"modified\": \"2019-09-02T11:20:42+00:00\",\n\t \"created\": \"2019-09-02T11:20:42+00:00\"\n\t }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"5fe22331-5e3a-47d7-a347-50c440ac1e36"},{"name":"View Tenancy","id":"bd8d0a89-9375-478a-913e-7b0eb4b55180","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}","description":"

This API endpoint retrieves the details of a single tenancy, identified by its unique tenancy_id.

Use this endpoint to view the specific details of a tenancy.

\n","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"f0422360-dff2-4817-b36d-58cdd498a3bf","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n\t \"id\": 12345,\n \"property_id\": 11223,\n \"unit_id\": 22334,\n \"ref\": \"TE1001\",\n \"status\": \"Current\",\n \"full_address\": \"Flat 10, 2 Station Road, London, EN5 1QW\",\n \"unit_owner\": \"\",\n \"tenancy_type\": \"Commercial\",\n \"unit_assigned_managers\": \"\",\n \"main_tenant_name\": \"tenant one\",\n\t \"tenants\": [\n\t {\n\t \"id\": 12121,\n \t\"first_name\": \"tenant\",\n \t\"last_name\": \"one\",\n \t\"date_of_birth\": \"1980-05-06\",\n \t\"mobile\": \"07123456789\",\n \t\"phone_home\": \"\",\n \t\"phone_work\": \"\",\n \t\"email\": \"sales@arthuronline.co.uk\",\n \"lastest_credit_score\": \"0\",\n \"lastest_credit_description\": \"\",\n \"main_tenant\": true,\n \"move_in_date\": \"2019-01-01\",\n \"move_out_date\": \"2020-01-01\"\n\t }\n\t ],\n\t \"letting_agent\": {\n\t \"id\": 99999,\n\t \"first_name\": \"Arthur\",\n\t \"last_name\": \"Agency\",\n\t \"primary_phone\": \"\",\n\t \"primary_email\": \"sales+agent@arthuronline.co.uk\"\n\t },\n\t \"contract_type\": \"Company\",\n \"renter_company\": \"\",\n \"start_date\": \"2019-09-01\",\n \"end_date\": \"2020-09-01\",\n \"break_clause_date\": null,\n \"fixed_break_date\": \"2020-02-13\",\n \"rolling_break_date\": \"2019-09-18\",\n \"notice_period\": \"1 months\",\n \"issue_break_clause_to\": \"landlord\",\n \"move_in_date\": \"2019-01-02\",\n \"move_in_time\": \"12:00\",\n \"move_out_date\": null,\n \"move_out_time\": null,\n \"rent_amount\": 875,\n \"rent_frequency\": \"Monthly\",\n \"deposit_held_by\": \"\",\n \"deposit_registered\": false,\n \"deposit_registered_amount\": \"\",\n \"rent_review_date\": null,\n \"section_21_served\": false,\n\t \"rent_payment_bank\": {\n\t \"id\": 55555,\n\t \"bank_name\": \"\",\n\t \"bank_account\": \"Arthur default account\",\n\t \"account_number\": \"00000000\",\n\t \"sort_code\": \"000000\"\n\t },\n\t \"deposit payment bank\": {\n\t \"id\": 5556,\n\t \"bank_name\": \"\",\n\t \"bank_account\": \"Arthur default account\",\n\t \"account_number\": \"00000000\",\n\t \"sort_code\": \"000000\"\n\t },\n\t \"default_rent_payment_method\": \"Bank Transfer\",\n\t \"rent_insured\": false,\n\t\t\"tags\": [],\n \"notes\": [],\n\t \"modified\": \"2019-09-02T11:20:42+00:00\",\n\t \"created\": \"2019-09-02T11:20:42+00:00\"\n\t}\n}"}],"_postman_id":"bd8d0a89-9375-478a-913e-7b0eb4b55180"},{"name":"Add Tenancy","id":"a8f56a73-6798-4e7b-9884-43d1f8b9a30c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancies","description":"

Use this endpoint to create a new tenancy record. The API will return the saved data and a unique tenancy ID.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Default	Required?
unit_id	12345	Integer		Yes
status	Current	Integer	Prospective	No
tenancy_type	Commercial	Integer	Residential	No
letting_agent_id	90909	Integer		No
contract_type	Company	String		No
renter_company	Renter Ltd.	String		No
start_date	2019-01-01	Date		Yes
end_date	2020-01-01	Date		No
break_clause_date	2019-06-01	Date		No
fixed_break_date	2019-06-01	Date		No
rolling_break_date	2019-09-18	Date		No
notice_period	2 months	String	1 months	No
issue_break_clause_to	landlord	String		No
move_in_date	2019-01-01	Date		No
move_in_time	12:00	Time		No
move_out_date	2020-01-01	Date		No
move_out_time	12:00	Time		No
rent_amount	875	Float		Yes
rent_frequency	Monthly	String		No
deposit_held_by	DPS	String		No
rent_payment_bank_id	1423	Integer		No
deposit_payment_bank_id	4132	Integer		No
default_rent_payment_method	Bank Transfer	String		No
rent_insured	false	Boolean		No
tags	[\"12 month contract\"]	Array (String)		No

","urlObject":{"protocol":"https","path":["v2","tenancies"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"95287b9b-98cb-451e-ad01-15e4b2734bac","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"unit_id\":3,\n \"status\": \"Current\",\n \"tenancy_type\": \"Commercial\",\n \"start_date\": \"2019-01-01\",\n \"end_date\": \"2020-01-01\",\n \"break_clause_date\": \"2019-06-01\",\n \"fixed_break_date\": \"2019-06-01\",\n \"rolling_break_date\": \"2019-09-18\",\n \"move_in_date\": \"2019-01-01\",\n \"move_in_time\": \"12:00\",\n \"move_out_date\": \"2020-01-01\",\n \"move_out_time\": \"12:00\",\n \"deposit_held_by\": \"\",\n \"default_rent_payment_method\": \"Bank Transfer\",\n \"rent_insured\": false,\n \"tags\": [\n \t\"12 month contract\"\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"property_id\": 2,\n \"unit_id\": 3,\n \"ref\": \"TE10\",\n \"status\": \"Current\",\n \"full_address\": \"unit address, London, MA918S\",\n \"unit_owner\": \"Ronnie Sherman\",\n \"tenancy_type\": \"Commercial\",\n \"tenancy_sub_type\": \"\",\n \"unit_assigned_managers\": \"Brian Shawn\",\n \"main_tenant_name\": \"\",\n \"tenants\": [],\n \"letting_agent\": {\n \"id\": 0,\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"primary_phone\": \"\",\n \"primary_email\": \"\"\n },\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"start_date\": \"2019-01-01\",\n \"end_date\": \"2020-01-01\",\n \"break_clause_date\": \"2019-06-01\",\n \"fixed_break_date\": \"2019-06-01\",\n \"rolling_break_date\": \"2019-09-18\",\n \"notice_period\": \"\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"2019-01-01\",\n \"move_in_time\": \"12:00\",\n \"move_out_date\": \"2020-01-01\",\n \"move_out_time\": \"12:00\",\n \"rent_amount\": 0,\n \"rent_frequency\": \"\",\n \"deposit_held_by\": \"\",\n \"deposit_scheme\": \"\",\n \"deposit_registered\": false,\n \"deposit_registered_amount\": \"0.00\",\n \"rent_review_date\": null,\n \"section_21_served\": false,\n \"rent_payment_bank\": {\n \"id\": 77775,\n \"bank_name\": \"Barclays\",\n \"bank_account\": \"deposit\",\n \"account_number\": \"123\",\n \"sort_code\": \"123\"\n },\n \"deposit payment bank\": {\n \"id\": 77775,\n \"bank_name\": \"Barclays\",\n \"bank_account\": \"deposit\",\n \"account_number\": \"123\",\n \"sort_code\": \"123\"\n },\n \"default_rent_payment_method\": \"Bank Transfer\",\n \"rent_insured\": false,\n \"tags\": [\n \"12 month contract\"\n ],\n \"notes\": [],\n \"custom_fields\": [],\n \"modified\": \"2020-10-29T11:24:20+00:00\",\n \"created\": \"2020-10-29T11:24:20+00:00\"\n }\n}"}],"_postman_id":"a8f56a73-6798-4e7b-9884-43d1f8b9a30c"},{"name":"Update Tenancy","id":"39e329f1-0867-419e-a2af-30892b9aa13a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}","description":"

This endpoint updates an existing tenancy using the same fields as the 'Add Tenancy' endpoint excluding the 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.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Required?
status	Current	Integer	No
tenancy_type	Commercial	Integer	No
letting_agent_id	90909	Integer	No
contract_type	Company	String	No
renter_company	Renter Ltd.	String	No
start_date	2019-01-01	Date	No
end_date	2020-01-01	Date	No
break_clause_date	2019-06-01	Date	No
fixed_break_date	2019-06-01	Date	No
rolling_break_date	2019-09-18	Date	No
notice_period	2 months	String	No
issue_break_clause_to	landlord	String	No
move_in_date	2019-01-01	Date	No
move_in_time	12:00	Time	No
move_out_date	2020-01-01	Date	No
move_out_time	12:00	Time	No
rent_amount	875	Float	No
rent_frequency	Monthly	String	No
deposit_held_by	DPS	String	No
rent_payment_bank_id	1423	Integer	No
deposit_payment_bank_id	4132	Integer	No
default_rent_payment_method	Bank Transfer	String	No
rent_insured	false	Boolean	No
tags	[\"12 month contract\"]	Array (String)	No

","urlObject":{"protocol":"https","path":["v2","tenancies","{{tenancy_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"0d2cf948-51d2-45a2-a902-e8e49a3f14d9","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"Current\",\n \"tenancy_type\": \"Commercial\",\n \"start_date\": \"2019-01-01\",\n \"end_date\": \"2020-01-01\",\n \"break_clause_date\": \"2019-06-01\",\n \"fixed_break_date\": \"2019-06-01\",\n \"rolling_break_date\": \"2019-09-18\",\n \"move_in_date\": \"2019-01-01\",\n \"move_in_time\": \"12:00\",\n \"move_out_date\": \"2020-01-01\",\n \"move_out_time\": \"12:00\",\n \"deposit_held_by\": \"\",\n \"default_rent_payment_method\": \"Bank Transfer\",\n \"rent_insured\": false,\n \"tags\": [\n \t\"12 month contract\"\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tenancies"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"property_id\": 2,\n \"unit_id\": 3,\n \"ref\": \"TE10\",\n \"status\": \"Current\",\n \"full_address\": \"unit address, London, MA918S\",\n \"unit_owner\": \"Ronnie Sherman\",\n \"tenancy_type\": \"Commercial\",\n \"tenancy_sub_type\": \"\",\n \"unit_assigned_managers\": \"Brian Shawn\",\n \"main_tenant_name\": \"\",\n \"tenants\": [],\n \"letting_agent\": {\n \"id\": 0,\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"primary_phone\": \"\",\n \"primary_email\": \"\"\n },\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"start_date\": \"2019-01-01\",\n \"end_date\": \"2020-01-01\",\n \"break_clause_date\": \"2019-06-01\",\n \"fixed_break_date\": \"2019-06-01\",\n \"rolling_break_date\": \"2019-09-18\",\n \"notice_period\": \"\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"2019-01-01\",\n \"move_in_time\": \"12:00\",\n \"move_out_date\": \"2020-01-01\",\n \"move_out_time\": \"12:00\",\n \"rent_amount\": 0,\n \"rent_frequency\": \"\",\n \"deposit_held_by\": \"\",\n \"deposit_scheme\": \"\",\n \"deposit_registered\": false,\n \"deposit_registered_amount\": \"0.00\",\n \"rent_review_date\": null,\n \"section_21_served\": false,\n \"rent_payment_bank\": {\n \"id\": 77775,\n \"bank_name\": \"Barclays\",\n \"bank_account\": \"deposit\",\n \"account_number\": \"123\",\n \"sort_code\": \"123\"\n },\n \"deposit payment bank\": {\n \"id\": 77775,\n \"bank_name\": \"Barclays\",\n \"bank_account\": \"deposit\",\n \"account_number\": \"123\",\n \"sort_code\": \"123\"\n },\n \"default_rent_payment_method\": \"Bank Transfer\",\n \"rent_insured\": false,\n \"tags\": [\n \"12 month contract\"\n ],\n \"notes\": [],\n \"custom_fields\": [],\n \"modified\": \"2020-10-29T11:24:20+00:00\",\n \"created\": \"2020-10-29T11:24:20+00:00\"\n }\n}"}],"_postman_id":"39e329f1-0867-419e-a2af-30892b9aa13a"}],"id":"5372bf3b-20a5-4d37-8e12-d47bb88c06a4","description":"

Here you can find the full list of endpoints for the Tenancies area of the system.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4e680527-cf59-4d24-aca4-96d3bec3888b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"87de5be2-a27a-49c8-a758-c6cf58524758"}}],"_postman_id":"5372bf3b-20a5-4d37-8e12-d47bb88c06a4"},{"name":"Tenants","item":[{"name":"Invite","item":[{"name":"🆕 Invite Tenant","id":"cfaa4c33-63ed-41dc-992f-3d186154bde9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenants/{tenant_id}/invite","description":"

This API endpoint can be used to initiate an automated process for inviting a tenant who is identified by their unique tenant_id.

Once the API call is made, the response will contain the tenant's details as well as an \"invite_code\".

\n","urlObject":{"protocol":"https","path":["v2","tenants","{tenant_id}","invite"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ab238572-afe7-4ac3-a36a-085111a8b071","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenants/{tenant_id}/invite"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 870487,\n \"tenancy_id\": 707291,\n \"unit_id\": 651074,\n \"property_id\": 282634,\n \"full_address\": \"Iron Bridge House 2, London, SE1 6BX\",\n \"status\": \"invited\",\n \"invite_code\": \"2LN3U5E\",\n \"reset_password_code\": null,\n \"main_tenant\": true,\n \"title\": \"Mr\",\n \"first_name\": \"API\",\n \"last_name\": \"Support\",\n \"date_of_birth\": null,\n \"gender\": \"\",\n \"citizen\": \"\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"\",\n \"company_address2\": \"\",\n \"company_city\": \"\",\n \"company_county\": \"\",\n \"company_postcode\": \"\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"passport_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_phone_work\": \"\",\n \"kin_mobile\": \"\",\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_county\": \"\",\n \"employment_postcode\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"has_guarantor\": false,\n \"guarantor_first_name\": \"\",\n \"guarantor_last_name\": \"\",\n \"guarantor_date_of_birth\": null,\n \"guarantor_address1\": \"\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"\",\n \"guarantor_county\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_profession\": \"\",\n \"guarantor_home_owner\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_sort_code\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"move_in_date\": null,\n \"move_out_date\": null,\n \"applicant_note\": \"\",\n \"manager_note\": \"\",\n \"custom_fields\": [],\n \"latest_credit_score\": \"0\",\n \"latest_credit_description\": \"\",\n \"modified\": \"2023-03-06T08:44:40\",\n \"created\": \"2023-02-24T14:38:39\"\n }\n}"}],"_postman_id":"cfaa4c33-63ed-41dc-992f-3d186154bde9"}],"id":"08cd39c4-df67-4518-b08b-978f4b291169","description":"

Here you can find the full list of endpoints for the Tenant Invitation area of the system

\n","_postman_id":"08cd39c4-df67-4518-b08b-978f4b291169"},{"name":"List Tenants","id":"37eeb6b0-6908-4545-8b10-4657f19ab1a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenants","description":"

This retrieves a list of tenants.

See available filters below to customize the list of tenants returned.

\n","urlObject":{"protocol":"https","path":["v2","tenants"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by the property

\n","type":"text/plain"},"key":"property_id","value":""},{"disabled":true,"description":{"content":"

Filter by the unit

\n","type":"text/plain"},"key":"unit_id","value":""},{"disabled":true,"description":{"content":"

Filter by the tenancy

\n","type":"text/plain"},"key":"tenancy_id","value":""},{"disabled":true,"description":{"content":"

Filter by tenant email

\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"

Filter by phone home number

\n","type":"text/plain"},"key":"phone_home","value":""},{"disabled":true,"description":{"content":"

Filter by phone work number

\n","type":"text/plain"},"key":"phone_work","value":""},{"disabled":true,"description":{"content":"

Fily by mobile number

\n","type":"text/plain"},"key":"mobile","value":""},{"disabled":true,"description":{"content":"

Filter by the full address of the property

\n","type":"text/plain"},"key":"full_address","value":""}],"variable":[]}},"response":[{"id":"71f11eb9-c795-44c8-955f-bc2ae106964c","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"https://api.arthuronline.co.uk/v2/tenants","protocol":"https","host":["api","arthuronline","co","uk"],"path":["v2","tenants"],"query":[{"key":"","value":"","disabled":true}]}},"status":"List Tenants","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"tenancy_id\": 123,\n \"status\": \"offline\",\n \"invite_code\": null,\n \"main_tenant\": true,\n \"move_in_date\": null,\n \"move_out_date\": null,\n \"title\": \"Mr\",\n \"first_name\": \"Arnold\",\n \"last_name\": \"Schwarzenegger\",\n \"date_of_birth\": null,\n \"gender\": \"\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_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\": \"02929293022\",\n \"residential_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\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\": null,\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_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"applicant_note\": \"\",\n \"manager_note\": \"\",\n \"modified\": \"2020-01-30T09:09:00+00:00\",\n \"created\": \"2020-01-30T09:09:00+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"37eeb6b0-6908-4545-8b10-4657f19ab1a3"},{"name":"View Tenant","id":"b8aa8920-4708-431e-a875-82fa5fdd80b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tenants/{{tenant_id}}","description":"

This API endpoint retrieves the details of a single tenant, identified by its unique tenant_id.

Use this endpoint to view the specific details of a renter.

\n","urlObject":{"protocol":"https","path":["v2","tenants","{{tenant_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"94fd00a2-6a5a-4fed-80b7-5f987b8f6092","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenants/{{tenant_id}}"},"status":"View Tenant","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": 200,\n \"data\": {\n \"id\": 123,\n \"tenancy_id\": 123,\n \"status\": \"pending\",\n \"invite_code\": null,\n \"main_tenant\": false,\n \"move_in_date\": null,\n \"move_out_date\": null,\n \"title\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"citizen_type\": \"\",\n \"email\": \"\",\n \"company_name\": \"\",\n \"company_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_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_mobile\": \"\",\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_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"applicant_note\": \"\",\n \"manager_note\": \"\",\n \"modified\": \"\",\n \"created\": \"\"\n }\n}"}],"_postman_id":"b8aa8920-4708-431e-a875-82fa5fdd80b8"},{"name":"Add Tenant","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"e810b047-1b4e-42f4-99c0-415e9437fdb1"}}],"id":"b3fd0cde-248e-42af-9e7e-6870806e1f5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenants","description":"

Use this endpoint to create a new tenant. The API will return the saved data and a unique tenant ID.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Required?
tenancy_id	123	Integer	Yes
main_tenant	True	Boolean	No
move_in_date	2019-05-28	Date	No
move_out_date	2019-06-28	Time	No
title	Mr	Enum	No
first_name	Ryan	String	No
last_name	Cullen	String	No
date_of_birth	1995-01-21	Date	No
gender	Male	Enum	No
citizen_type	1	Enum	No
email	email@gmail.com	String	No
company_name	MyCompany	Strong	No
compant_address_name	Address	String	No
company_address1	Boundry Road	String	No
company_address2	Wren Court	String	No
company_city	London	String	No
company_postcode	SW94DA	String	No
company_county	City of London	String	No
company_country	England	String	No
phone_home	029302932	String	No
phone_work	029382928	String	No
mobile	020192029	String	No
residential_number	201	String	No
visa_number	120-123	String	No
visa_years	3	String	No
visa_type	Tier 2	Enum	No
country_of_origin	Wales	String	No
ni_number	KS 01 AK 11 F	String	No
kin_mobile	029302991	String	No
kin_last_name	Cullen	String	No
kin_first_name	Monica	String	No
kin_phone_work	029320191	String	No
student_status	Full-time	String	No
university	Oxford	String	No
course_name	Doe Studies	String	No
course_id	1	String	No
course_year	2	String	No
employment_company_name	Lorem	String	No
employment_address1	Address First Line	String	No
employment_address2	Address Second Line	String	No
employment_city	Liverpool	String	No
employment_postcode	LN91LS	String	No
employment_county	Norfolk	String	No
employment_contact_name	Grace	String	No
employment_contact_number	0239203900	String	No
employment_salary	90000	String	No
employment_length	5 years	String	No
housing_benefit_council	Borought	String	No
housing_benefit_number	19203	String	No
guarantor_first_name	Nicolas	String	No
guarantor_last_name	Cage	String	No
guarantor_date_of_birth	1911-02-12	String	No
guarantor_address1	Address first line	String	No
guarantor_address2	Address second line	String	No
guarantor_city	London	String	No
guarantor_postcode	XP91AP	String	No
guarantor_county	Suffolk	String	No
guarantor_country	England	String	No
guarantor_phone_home	028392871	String	No
guarantor_phone_work	028191282	String	No
guarantor_mobile	029384383	String	No
guarantor_email	guarantor@email.com	String	No
guarantor_relation	Brother	String	No
guarantor_home_owner	Home owner outright, Home owner with mortgage, Rented accommodation	String	No
guarantor_profession	Teacher	String	No
bank_name	Barclays	String	No
bank_address1	Address first line	String	No
bank_address2	Address second line	String	No
bank_city	Romford	String	No
bank_county	Essex	String	No
bank_postcode	FS18LA	String	No
ref_name	Ref Name	String	No
ref_address1	Ref First Line	String	No
ref_address2	Ref Second Line	String	No
ref_county	Ref Hertfordshire	String	No
ref_city	Ref City	String	No
ref_postcode	Ref Postcode	String	No
ref_contact_number	029392832	String	No
ref_relation	Mother	String	No
applicant_note	Note to remember	String	No
manager_note	Manager note	String	No

","urlObject":{"protocol":"https","path":["v2","tenants"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source

\n","type":"text/plain"},"key":"strict","value":"true"}],"variable":[]}},"response":[{"id":"dbd9e60f-be19-4064-948e-56c3582922fa","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"tenancy_id\":123,\n\t\"main_tenant\":true,\n\t\"move_in_date\":\"2019-05-28\",\n\t\"move_out_date\":\"2019-08-28\",\n \"title\": \"Mr\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1970-01-01\",\n \"gender\": \"Male\",\n \"citizen_type\": \"UK Citizen\",\n \"email\": \"sales@arthuronline.co.uk\",\n \"company_name\": \"Doe Industries\",\n \"company_address_name\": \"Main Office\",\n \"company_address1\": \"Fake House\",\n \"company_address2\": \"123 Fake Street\",\n \"company_city\": \"London\",\n \"company_postcode\": \"ABC 123\",\n \"company_county\": \"\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"01234 567899\",\n \"phone_work\": \"01234 567898\",\n \"mobile\": \"07777 777777\",\n \"residential_number\": \"1234567890\",\n \"visa_number\": \"\",\n \"visa_years\": \"5\",\n \"visa_type\": \"Tier 1\",\n \"country_of_origin\": \"UK\",\n \"ni_number\": \"12 34 56 78\",\n \"kin_first_name\": \"Jennifer\",\n \"kin_last_name\": \"Doe\",\n \"kin_mobile\": \"0788 888888\",\n \"kin_phone_work\": \"09876 543211\",\n \"student_status\": \"full time\",\n \"university\": \"University of Doe\",\n \"course_name\": \"Doe Studies\",\n \"course_id\": \"1234\",\n \"course_year\": \"2\",\n \"employment_company_name\": \"Arthur Online\",\n \"employment_address1\": \"Unit 2 Iron Bridge House\",\n \"employment_address2\": \"Bridge Approach\",\n \"employment_city\": \"London\",\n \"employment_postcode\": \"NW1 8BD\",\n \"employment_county\": \"Greater London\",\n \"employment_contact_name\": \"Alice Doe\",\n \"employment_contact_number\": \"+44(0)207 112 4860\",\n \"employment_salary\": \"100000\",\n \"employment_length\": \"1 year\",\n \"housing_benefit_council\": \"Doe Council\",\n \"housing_benefit_number\": \"1234567\",\n \"guarantor_first_name\": \"Jason\",\n \"guarantor_last_name\": \"Doe\",\n \"guarantor_date_of_birth\": \"1968-05-08\",\n \"guarantor_address1\": \"123 Fake Street\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"Notreal City\",\n \"guarantor_postcode\": \"ABC 123\",\n \"guarantor_county\": \"Doeshire\",\n \"guarantor_country\": \"United Kingdom\",\n \"guarantor_phone_home\": \"12345 678900\",\n \"guarantor_phone_work\": \"01234 567890\",\n \"guarantor_mobile\": \"07000 000000\",\n \"guarantor_email\": \"example@email.com\",\n \"guarantor_relation\": \"Father\",\n \"guarantor_home_owner\": \"Home owner outright\",\n \"guarantor_profession\": \"Professional\",\n \"bank_name\": \"Doe Bank\",\n \"bank_address1\": \"99 Bank Street\",\n \"bank_address2\": \"\",\n \"bank_city\": \"Bank City\",\n \"bank_county\": \"Bankshire\",\n \"bank_postcode\": \"B4N K99\",\n \"ref_name\": \"Referee Ali\",\n \"ref_address1\": \"Unit 3 Referee House\",\n \"ref_address2\": \"123 Referee Street\",\n \"ref_city\": \"Ref City\",\n \"ref_county\": \"Refshire\",\n \"ref_postcode\": \"ZXY 987\",\n \"ref_contact_number\": \"07788 888777\",\n \"ref_relation\": \"Friend\",\n \"number_of_sharers\": \"3\",\n \"applicant_note\": \"I would like a brand new 1 bed flat somewhere within 1 mile of the station.\",\n \"manager_note\": \"This applicant has called 15 times this week!\",\n}"},"url":{"raw":"https://api.arthuronline.co.uk/v2/tenants","protocol":"https","host":["api","arthuronline","co","uk"],"path":["v2","tenants"],"query":[{"key":"strict","value":"true","description":"Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source","disabled":true}]}},"status":"Add Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"tenancy_id\": 123,\n \"status\": \"pending\",\n \"invite_code\": null,\n \"main_tenant\": true,\n \"move_in_date\": \"2019-05-28\",\n \"move_out_date\": \"2019-08-28\",\n \"title\": \"Mr\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1970-01-01\",\n \"gender\": \"Male\",\n \"citizen_type\": \"UK Citizen\",\n \"email\": \"sales@arthuronline.co.uk\",\n \"company_name\": \"Doe Industries\",\n \"company_address_name\": \"Main Office\",\n \"company_address1\": \"Fake House\",\n \"company_address2\": \"123 Fake Street\",\n \"company_city\": \"London\",\n \"company_postcode\": \"ABC 123\",\n \"company_county\": \"\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"01234 567899\",\n \"phone_work\": \"01234 567898\",\n \"mobile\": \"07777 777777\",\n \"residential_number\": \"1234567890\",\n \"visa_number\": \"1346dq89\",\n \"visa_years\": \"5\",\n \"visa_type\": \"Tier 1\",\n \"country_of_origin\": \"UK\",\n \"ni_number\": \"12 34 56 78\",\n \"kin_first_name\": \"Jennifer\",\n \"kin_last_name\": \"Doe\",\n \"kin_mobile\": \"0788 888888\",\n \"kin_phone_work\": \"09876 543211\",\n \"student_status\": \"Full Time\",\n \"university\": \"University of Doe\",\n \"course_name\": \"Doe Studies\",\n \"course_id\": \"1234\",\n \"course_year\": \"2\",\n \"employment_company_name\": \"Arthur Online\",\n \"employment_address1\": \"Unit 2 Iron Bridge House\",\n \"employment_address2\": \"Bridge Approach\",\n \"employment_city\": \"London\",\n \"employment_postcode\": \"NW1 8BD\",\n \"employment_county\": \"Greater London\",\n \"employment_contact_name\": \"Alice Doe\",\n \"employment_contact_number\": \"+44(0)207 112 4860\",\n \"employment_salary\": \"100000\",\n \"employment_length\": \"1 year\",\n \"housing_benefit_council\": \"Doe Council\",\n \"housing_benefit_number\": \"1234567\",\n \"guarantor_first_name\": \"Jason\",\n \"guarantor_last_name\": \"Doe\",\n \"guarantor_date_of_birth\": \"1968-05-08\",\n \"guarantor_address1\": \"123 Fake Street\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"Notreal City\",\n \"guarantor_postcode\": \"ABC 123\",\n \"guarantor_county\": \"Doeshire\",\n \"guarantor_country\": \"United Kingdom\",\n \"guarantor_phone_home\": \"12345 678900\",\n \"guarantor_phone_work\": \"01234 567890\",\n \"guarantor_mobile\": \"07000 000000\",\n \"guarantor_email\": \"example@email.com\",\n \"guarantor_relation\": \"Father\",\n \"guarantor_home_owner\": \"Home owner outright\",\n \"guarantor_profession\": \"Professional\",\n \"bank_name\": \"Doe Bank\",\n \"bank_address1\": \"99 Bank Street\",\n \"bank_address2\": \"\",\n \"bank_city\": \"Bank City\",\n \"bank_county\": \"Bankshire\",\n \"bank_postcode\": \"B4N K99\",\n \"ref_name\": \"Referee Ali\",\n \"ref_address1\": \"Unit 3 Referee House\",\n \"ref_address2\": \"123 Referee Street\",\n \"ref_city\": \"Ref City\",\n \"ref_county\": \"Refshire\",\n \"ref_postcode\": \"ZXY 987\",\n \"ref_contact_number\": \"07788 888777\",\n \"ref_relation\": \"Friend\",\n \"applicant_note\": \"I would like a brand new 1 bed flat somewhere within 1 mile of the station.\",\n \"manager_note\": \"This applicant has called 15 times this week!\",\n \"modified\": \"2020-03-04T09:53:05+00:00\",\n \"created\": \"2020-03-04T09:53:05+00:00\"\n }\n}"}],"_postman_id":"b3fd0cde-248e-42af-9e7e-6870806e1f5f"},{"name":"Update Tenant","id":"9b26dafa-2ed4-4971-b6bf-1ddfa7b46be2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenants/{{tenant_id}}","description":"

This endpoint updates an existing tenant using the same fields as the 'Add Tenant' endpoint. Any fields that are not provided will not be changed. The API will return the updated data for the tenant in the response.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Required?
tenancy_id	123	Integer	No
main_tenant	True	Boolean	No
move_in_date	2019-05-28	Date	No
move_out_date	2019-06-28	Time	No
title	Mr	Enum	No
first_name	Ryan	String	No
last_name	Cullen	String	No
date_of_birth	1995-01-21	Date	No
gender	Male	Enum	No
citizen_type	1	Enum	No
email	email@gmail.com	String	No
company_name	MyCompany	Strong	No
compant_address_name	Address	String	No
company_address1	Boundry Road	String	No
company_address2	Wren Court	String	No
company_city	London	String	No
company_postcode	SW94DA	String	No
company_county	City of London	String	No
company_country	England	String	No
phone_home	029302932	String	No
phone_work	029382928	String	No
mobile	020192029	String	No
residential_number	201	String	No
visa_number	120-123	String	No
visa_years	3	String	No
visa_type	Tier 2	Enum	No
country_of_origin	Wales	String	No
ni_number	KS 01 AK 11 F	String	No
kin_mobile	029302991	String	No
kin_last_name	Cullen	String	No
kin_first_name	Monica	String	No
kin_phone_work	029320191	String	No
student_status	Full-time	String	No
university	Oxford	String	No
course_name	Doe Studies	String	No
course_id	1	String	No
course_year	2	String	No
employment_company_name	Lorem	String	No
employment_address1	Address First Line	String	No
employment_address2	Address Second Line	String	No
employment_city	Liverpool	String	No
employment_postcode	LN91LS	String	No
employment_county	Norfolk	String	No
employment_contact_name	Grace	String	No
employment_contact_number	0239203900	String	No
employment_salary	90000	String	No
employment_length	5 years	String	No
housing_benefit_council	Borought	String	No
housing_benefit_number	19203	String	No
guarantor_first_name	Nicolas	String	No
guarantor_last_name	Cage	String	No
guarantor_date_of_birth	1911-02-12	String	No
guarantor_address1	Address first line	String	No
guarantor_address2	Address second line	String	No
guarantor_city	London	String	No
guarantor_postcode	XP91AP	String	No
guarantor_county	Suffolk	String	No
guarantor_country	England	String	No
guarantor_phone_home	028392871	String	No
guarantor_phone_work	028191282	String	No
guarantor_mobile	029384383	String	No
guarantor_email	guarantor@email.com	String	No
guarantor_relation	Brother	String	No
guarantor_home_owner	Yes	String	No
guarantor_profession	Teacher	String	No
bank_name	Barclays	String	No
bank_address1	Address first line	String	No
bank_address2	Address second line	String	No
bank_city	Romford	String	No
bank_county	Essex	String	No
bank_postcode	FS18LA	String	No
ref_name	Ref Name	String	No
ref_address1	Ref First Line	String	No
ref_address2	Ref Second Line	String	No
ref_county	Ref Hertfordshire	String	No
ref_city	Ref City	String	No
ref_postcode	Ref Postcode	String	No
ref_contact_number	029392832	String	No
ref_relation	Mother	String	No
applicant_note	Note to remember	String	No
manager_note	Manager note	String	No

","urlObject":{"protocol":"https","path":["v2","tenants","{{tenant_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a1cfbfdd-c73a-4f15-8e6b-e8ba4dc5d45e","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arthuronline.co.uk/v2/tenants/{{tenant_id}}"},"status":"Update Tenant","_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"tenancy_id\": 123,\n \"status\": \"pending\",\n \"invite_code\": null,\n \"main_tenant\": false,\n \"move_in_date\": \"2019-05-28\",\n \"move_out_date\": \"2019-08-28\",\n \"title\": \"Mr\",\n \"first_name\": \"Johny\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1970-01-01\",\n \"gender\": \"Male\",\n \"citizen_type\": \"UK Citizen\",\n \"email\": \"sales@arthuronline.co.uk\",\n \"company_name\": \"Doe Industries\",\n \"company_address_name\": \"Main Office\",\n \"company_address1\": \"Fake House\",\n \"company_address2\": \"123 Fake Street\",\n \"company_city\": \"London\",\n \"company_postcode\": \"ABC 123\",\n \"company_county\": \"\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"01234 567899\",\n \"phone_work\": \"01234 567898\",\n \"mobile\": \"07777 777777\",\n \"residential_number\": \"1234567890\",\n \"visa_number\": \"1346dq89\",\n \"visa_years\": \"5\",\n \"visa_type\": \"Tier 1\",\n \"country_of_origin\": \"UK\",\n \"ni_number\": \"12 34 56 78\",\n \"kin_first_name\": \"Jennifer\",\n \"kin_last_name\": \"Doe\",\n \"kin_mobile\": \"0788 888888\",\n \"kin_phone_work\": \"09876 543211\",\n \"student_status\": \"Full Time\",\n \"university\": \"University of Doe\",\n \"course_name\": \"Doe Studies\",\n \"course_id\": \"1234\",\n \"course_year\": \"2\",\n \"employment_company_name\": \"Arthur Online\",\n \"employment_address1\": \"Unit 2 Iron Bridge House\",\n \"employment_address2\": \"Bridge Approach\",\n \"employment_city\": \"London\",\n \"employment_postcode\": \"NW1 8BD\",\n \"employment_county\": \"Greater London\",\n \"employment_contact_name\": \"Alice Doe\",\n \"employment_contact_number\": \"+44(0)207 112 4860\",\n \"employment_salary\": \"100000\",\n \"employment_length\": \"1 year\",\n \"housing_benefit_council\": \"Doe Council\",\n \"housing_benefit_number\": \"1234567\",\n \"guarantor_first_name\": \"Jason\",\n \"guarantor_last_name\": \"Doe\",\n \"guarantor_date_of_birth\": \"1968-05-08\",\n \"guarantor_address1\": \"123 Fake Street\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"Notreal City\",\n \"guarantor_postcode\": \"ABC 123\",\n \"guarantor_county\": \"Doeshire\",\n \"guarantor_country\": \"United Kingdom\",\n \"guarantor_phone_home\": \"12345 678900\",\n \"guarantor_phone_work\": \"01234 567890\",\n \"guarantor_mobile\": \"07000 000000\",\n \"guarantor_email\": \"example@email.com\",\n \"guarantor_relation\": \"Father\",\n \"guarantor_home_owner\": \"Home owner outright\",\n \"guarantor_profession\": \"Professional\",\n \"bank_name\": \"Doe Bank\",\n \"bank_address1\": \"99 Bank Street\",\n \"bank_address2\": \"\",\n \"bank_city\": \"Bank City\",\n \"bank_county\": \"Bankshire\",\n \"bank_postcode\": \"B4N K99\",\n \"ref_name\": \"Referee Ali\",\n \"ref_address1\": \"Unit 3 Referee House\",\n \"ref_address2\": \"123 Referee Street\",\n \"ref_city\": \"Ref City\",\n \"ref_county\": \"Refshire\",\n \"ref_postcode\": \"ZXY 987\",\n \"ref_contact_number\": \"07788 888777\",\n \"ref_relation\": \"Friend\",\n \"applicant_note\": \"I would like a brand new 1 bed flat somewhere within 1 mile of the station.\",\n \"manager_note\": \"This applicant has called 15 times this week!\",\n \"modified\": \"2020-03-04T11:17:51+00:00\",\n \"created\": \"2020-03-04T09:16:15+00:00\"\n }\n}"}],"_postman_id":"9b26dafa-2ed4-4971-b6bf-1ddfa7b46be2"}],"id":"68be3760-95bb-4c6c-9b57-0315a940743b","description":"

Here you can find the full list of endpoints for the Tenants area of the system

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4f6458b1-3932-4051-9763-96b716f0500d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"38d022bb-af4a-418c-8206-502478842d80"}}],"_postman_id":"68be3760-95bb-4c6c-9b57-0315a940743b"},{"name":"Applicants","item":[{"name":"Assets","item":[{"name":"List Assets On Applicant","id":"863b5f33-404d-4737-a6ce-ffa3d56912e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/assets","description":"

This endpoint retrieves a list of assets associated with the given applicant ID.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"abff73e2-9f21-471f-8f23-632938133e22","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/assets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \" Inventory\",\n \"description\": \" Inventory\",\n \"created_by\": {\n \"full_name\": \"Brian Wiliams\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"PDF\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Inventory\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Applicant\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-06-23T11:13:02+01:00\",\n \"modified\": \"2020-06-23T11:13:02+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"863b5f33-404d-4737-a6ce-ffa3d56912e0"},{"name":"🆕 Create Asset On Applicant","id":"339e8fc7-6ac5-4e77-94b1-89a3549ab862","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/assets","description":"

Use this endpoint to create a new asset related to an applicant. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
asset_type	image	String	No
name	inventory	String	No
share_manager	true	Boolean	No
share_tenant	false	Boolean	No
share_contractor	true	Boolean	No
share_owner	true	Boolean	No
file	base64	String (base64)	Yes
mime_type	application/pdf	String	Yes
file_name	inventory	String	Yes

","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"1cd1f0c6-9903-4e1c-9dad-7e7a9e393859","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset_type\":\"image\",\n\t\"name\":\"name of asset\",\n\t\"share_manager\":true,\n\t\"share_tenant\":true,\n\t\"share_owner\":true,\n\t\"share_contractor\":true,\n\t\"file\":\"pdf file converted to base64 string\",\n\t\"mime_type\":\"application/pdf\",\n\t\"file_name\":\"inventory\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/assets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"name of asset\",\n \"description\": null,\n \"created_by\": {\n \"full_name\": \"API Documentation\",\n \"company\": \"API\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Image\",\n \"share_manager\": true,\n \"share_owner\": true,\n \"share_tenant\": true,\n \"share_contractor\": true,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Property\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-07-03T09:25:52+01:00\",\n \"modified\": \"2020-07-03T09:25:52+01:00\"\n }\n}"}],"_postman_id":"339e8fc7-6ac5-4e77-94b1-89a3549ab862"}],"id":"7824ce2b-34d0-44fb-a009-5a2850d77cb9","description":"

This section provides resources for dealing with assets related to a applicant.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"64544e59-8e75-462e-aa9c-51ab7efb1886"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a46645b3-d8e1-4e7f-9250-b45152b54a9c"}}],"_postman_id":"7824ce2b-34d0-44fb-a009-5a2850d77cb9"},{"name":"Assigned Managers","item":[{"name":"🆕 List Managers on Applicant","id":"2e8dd73e-f4ff-44d2-afd1-4b8220bd9c9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/managers/{{manager_id}}","description":"

This endpoint retrieves a list of assigned managers associated with the given applicant ID.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","managers","{{manager_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b3c415b0-3a01-4b0d-aef4-2353e4c9fdaa","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1869821,\n \"first_name\": \"API Support\",\n \"last_name\": \"Team\",\n \"full_name\": \"API Support Team\",\n \"group\": \"Property Manager\",\n \"email\": \"api.support@arthuronline.co.uk\",\n \"mobile\": \"\",\n \"phone_work\": \"\",\n \"phone_home\": \"\",\n \"created\": \"2023-01-16T16:52:06\",\n \"modified\": \"2023-01-16T16:52:42\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"2e8dd73e-f4ff-44d2-afd1-4b8220bd9c9e"},{"name":"🆕 View Manager on Applicant","id":"0eb053e7-6981-40e9-9d16-810f94170936","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/managers/{{manager_id}}","description":"

This API endpoint retrieves the details of a single assigned manager, identified by its unique manager_id.

Use this endpoint to view the specific details of an assigned manager.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","managers","{{manager_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"371d63b2-765d-4a18-a4ac-b44365c8708a","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/managers/{{manager_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1869821,\n \"first_name\": \"API Support\",\n \"last_name\": \"Team\",\n \"full_name\": \"API Support Team\",\n \"group\": \"Property Manager\",\n \"email\": \"api.support@arthuronline.co.uk\",\n \"mobile\": \"\",\n \"phone_work\": \"\",\n \"phone_home\": \"\",\n \"created\": \"2023-01-16T16:52:06\",\n \"modified\": \"2023-01-16T16:52:42\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"0eb053e7-6981-40e9-9d16-810f94170936"},{"name":"🆕 Add Manager on Applicant","id":"abe85ac9-282c-411a-b35d-d96fa9501d55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/managers","description":"

Use this endpoint to assign managers to an applicant. The API will return the saved manager data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
person_id	158674	Integer	Yes

","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","managers"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"8ab76c82-369e-4264-9221-1e7b77c5163f","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"person_id\": 1869821\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1869821,\n \"first_name\": \"API Support\",\n \"last_name\": \"Team\",\n \"full_name\": \"API Support Team\",\n \"group\": \"Property Manager\",\n \"email\": \"api.support@arthuronline.co.uk\",\n \"mobile\": \"\",\n \"phone_work\": \"\",\n \"phone_home\": \"\",\n \"created\": \"2023-01-16T16:52:06\",\n \"modified\": \"2023-01-16T16:52:42\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"abe85ac9-282c-411a-b35d-d96fa9501d55"},{"name":"🆕 Delete Manager on Applicant","id":"88526c52-4e6c-49b4-95c5-08bf78eb0882","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/managers/{{manager_id}}","description":"

This endpoint deletes an existing assignee using the assigned manager id.

This section provides resources for dealing with assigned managers related to a applicant.

\n","_postman_id":"30811237-6e21-4a17-acba-f039cc1c5028"},{"name":"Credit Checks","item":[{"name":"🆕 List Credit Checks on Applicant","id":"b7f53184-6077-4a8e-a62d-1c61bb52dfbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/credit_checks","description":"

This endpoint retrieves a list of credit checks associated with the given applicant ID.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","credit_checks"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ac444c48-949b-46a3-9486-05c080a6b3b6","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 109,\n \"credit_score\": 800,\n \"credit_description\": \"Fair\",\n \"report_type\": \"Individual report\",\n \"credit_check_status\": \"Completed\",\n \"credit_check_provider\": \"CallCredit\",\n \"related_tenancy_id\": null,\n \"draft\": false,\n \"date_submitted\": \"2019-02-14T15:02:56\",\n \"created_by\": {\n \"id\": 41082,\n \"full_name\": \"API Support\"\n },\n \"created\": \"2019-02-14T15:02:46\",\n \"modified\": \"2019-02-14T15:02:57\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"b7f53184-6077-4a8e-a62d-1c61bb52dfbf"}],"id":"8a7be09a-cf09-4904-9eef-cc35d3df9884","description":"

This section provides resources for dealing with credit checks related to a applicant.

\n","_postman_id":"8a7be09a-cf09-4904-9eef-cc35d3df9884"},{"name":"Conversations","item":[{"name":"Conversation Recipients","item":[{"name":"Get Recipients for Applicant","id":"e3cf2356-421b-49a8-8f8c-97217ec9c576","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/conversation_recipients","description":"

This endpoint retrieves a list of conversation recipients associated with the given applicant ID.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","conversation_recipients"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"fcf467da-1733-4216-961a-6218675c7dd5","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/conversation_recipients"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Applicant\",\n \"first_name\": \"Henry\",\n \"last_name\": \"Williams\",\n \"group\": \"tenant\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n }\n ]\n}"}],"_postman_id":"e3cf2356-421b-49a8-8f8c-97217ec9c576"}],"id":"35a0fe95-62c7-435e-aafb-77fe73d6c411","description":"

This section provides resources for dealing with conversation recipients related to a applicant.

\n","_postman_id":"35a0fe95-62c7-435e-aafb-77fe73d6c411"},{"name":"List Conversations On Applicant","id":"c7608593-3318-450c-9674-79be2420110b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/conversations","description":"

This endpoint retrieves a list of conversations associated with the given applicant ID.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b62d0071-c17d-4d01-b8ad-951ec174e175","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"title\": \"Subject 1\",\n \"message_count\": 1,\n \"model\": \"Applicant\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Sure!\",\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"modified\": \"2020-04-22T12:03:28+01:00\"\n },\n {\n \"id\": 123,\n \"title\": \"Subject 2\",\n \"message_count\": 1,\n \"model\": \"Applicant\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Remember to clean on friday.\",\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"modified\": \"2020-04-30T11:49:54+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"c7608593-3318-450c-9674-79be2420110b"},{"name":"Create Conversation On Applicant","id":"23ed1df7-e28d-4751-8a49-cee2c0e1fda6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/conversations","description":"

Use this endpoint to create a new conversation related to a applicant. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
message	It's done	String	Yes
subject	Meeting tomorrow	String	Yes
person_ids	['1','2']	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"084e98b2-a800-4933-861a-b76b0ef7fdd8","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"message\":\"Please clean the house on friday.\",\n\t\"subject\":\"House duties\",\n\t\"person_ids\":[\"21\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"House duties\",\n \"message_count\": 1,\n \"model\": \"Property\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 2,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 21,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Please clean the house on friday.\",\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"modified\": \"2020-06-05T15:06:26+01:00\"\n }\n}"}],"_postman_id":"23ed1df7-e28d-4751-8a49-cee2c0e1fda6"}],"id":"e35c156d-6d13-4624-b3dd-e375eafe62d6","description":"

This section provides resources for dealing with conversations related to a applicant.

\n","_postman_id":"e35c156d-6d13-4624-b3dd-e375eafe62d6"},{"name":"Viewings","item":[{"name":"List Viewings On Applicant","id":"6efa244f-fb42-464b-945b-6d685e5b6e82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/viewings","description":"

This endpoint retrieves a list of viewings associated with the given applicant ID.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","viewings"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter the viewings by status.

\n","type":"text/plain"},"key":"status","value":null},{"disabled":true,"description":{"content":"

Filter the viewings by assigned to ID.

\n","type":"text/plain"},"key":"assignedTo","value":null},{"disabled":true,"description":{"content":"

Filter the viewings by the date.

\n","type":"text/plain"},"key":"viewingDate","value":null}],"variable":[]}},"response":[{"id":"97661130-c70a-41af-9922-0e83f8bd76c4","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/viewings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"unit_id\": \"1\",\n \"applicant_id\":\"11\",\n \"viewing_status\": \"Confirmed\",\n \"viewing_date\": \"2019-05-28\",\n \"viewing_time\": \"12:30\",\n \"offer_amount\": \"500.00\",\n \"offer_frequency\": \"Weekly\",\n \"move_in_date\": \"2019-07-01\",\n \"assigned_to_ids\": [\n \"1234\"\n ],\n \"source\": \"my website\",\n \"notes\": \"this is an applicant\",\n\t \"modified\": \"2019-05-28T12:00:00+00:00\",\n\t \"created\": \"2019-05-28T12:00:00+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"6efa244f-fb42-464b-945b-6d685e5b6e82"},{"name":"Add Viewing On Applicant","id":"e4c7910d-c59d-439b-b163-792cd6633cab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/viewings","description":"

Use this endpoint to create a new viewing record for the applicant. The API will return the saved data and a unique applicant ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Default	Required?
unit_id	123	Integer		Yes
viewing_date	2019-05-28	Date		No
viewing_time	00:00	Time		No
offer_amount	250.00	Float		No
offer_frequency	Week	Enum	Month	No
move_in_date	2019-07-01	Date		No
assigned_to_ids	[123,124]	Array (Integer)		No
source	My website	Simple		No
notes	Landlord will be present for this viewing.	String		No

","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","viewings"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"dde21845-dec9-4f9c-98ff-38206992b846","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"unit_id\": \"12\",\n\t\"viewing_date\": \"2021-10-10\",\n \"viewing_time\": \"14:23\",\n\t\"offer_amount\": \"1512\",\n \"offer_frequency\": \"per week\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.arthuronline.co.uk/v2/applicants/123/viewings","protocol":"https","host":["api","arthuronline","co","uk"],"path":["v2","applicants","123","viewings"],"query":[{"key":"strict","value":"true","description":"Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"unit_id\": 12,\n \"unit_address\": \"Unit 1, White house, Ciechocinek, 80-809\",\n \"applicant\": {\n \"id\": 123,\n \"full_name\": \"Martin Gothic\"\n },\n \"applicants\": [\n {\n \"id\": 123,\n \"full_name\": \"Martin Gothic\"\n }\n ],\n \"viewing_status\": \"Enquired\",\n \"viewing_date\": \"2021-10-10\",\n \"viewing_time\": \"14:23\",\n \"viewing_datetime\": \"2021-10-10T14:23:00+00:00\",\n \"offer_amount\": \"1512\",\n \"offer_frequency\": \"per week\",\n \"duration\": 15,\n \"move_in_date\": \"2021-10-10\",\n \"unit_available_from\": \"2020-12-16\",\n \"unit_is_vacant\": false,\n \"assigned_to\": [\n {\n \"id\": 123,\n \"full_name\": \"Brian Shaw\"\n }\n ],\n \"tags\": [\n \"Cheap rent\"\n ],\n \"notes\": [],\n \"source\": \"new source\",\n \"viewing_notes\": \"viewing note\",\n \"modified\": \"2021-03-09T14:07:02+00:00\",\n \"created\": \"2021-03-09T14:07:02+00:00\",\n \"deleted\": false\n }\n}"}],"_postman_id":"e4c7910d-c59d-439b-b163-792cd6633cab"}],"id":"5f56b099-7312-4bdf-b59e-98bc4a8bad64","description":"

This section provides resources for dealing with Viewings related to a applicant. To update and view specific existing Viewings, please use the Viewings endpoint with its ID.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"95c8deff-a9a9-4c75-8849-92b3cc9c1967"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"52381741-af1d-46e8-8147-768d75c863b9"}}],"_postman_id":"5f56b099-7312-4bdf-b59e-98bc4a8bad64"},{"name":"Notes","item":[{"name":"🆕 List Notes On Applicant","id":"8b2b34db-71b7-4bca-8a43-3701362e10ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/notes","description":"

This endpoint retrieves a list of notes associated with the given applicant ID.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"929a1a83-8d01-4d8b-85c2-913991143a0d","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/notes"},"status":"List Notes On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [\n \t\t\t\"one\",\n \t\t\t\"two\"\n ],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-03-04T15:12:33+00:00\",\n \"modified\": \"2020-03-11T09:27:04+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n\n"}],"_postman_id":"8b2b34db-71b7-4bca-8a43-3701362e10ca"},{"name":"🆕 View Note On Applicant","id":"f08498c3-d60a-4857-9bcf-8d60d45ebc8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/notes/{{note_id}}","description":"

This API endpoint retrieves the details of a single note, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"3d43361f-ad10-42e2-b1f2-fddd82f1d235","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/notes/{{note_id}}"},"status":"View Note On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Interesting\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": null,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T12:02:34+01:00\"\n }\n}\n"}],"_postman_id":"f08498c3-d60a-4857-9bcf-8d60d45ebc8f"},{"name":"🆕 Add Note On Applicant","id":"e4e99bba-ddfd-43f5-ac78-ef554028b1c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/notes","description":"

Use this endpoint to create a new note record for the applicant. The API will return the saved data and a unique note ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	Yes

","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e1cc35e3-e3a6-4021-b7bc-83d7b2c04856","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\":\"Remember this note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/notes/{{note_id}}"},"status":"Add Note On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": null,\n \"full_name\": null\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": null,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"e4e99bba-ddfd-43f5-ac78-ef554028b1c3"},{"name":"🆕 Update Note On Applicant","id":"caf56892-120b-4ab8-8f0d-e0b6133f053a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/notes/{{note_id}}","description":"

This endpoint updates an existing note using the same fields as the 'Add Note' endpoint. The API will return the updated data for the note in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	No

","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"73daf1c9-4940-4825-bee7-778487e3a350","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\":\"Updated Note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/notes/{{note_id}}"},"status":"Update Note On Property","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Updated Note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": null,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T12:02:34+01:00\"\n }\n}"}],"_postman_id":"caf56892-120b-4ab8-8f0d-e0b6133f053a"},{"name":"🆕 Delete Note On Applicant","id":"2d847016-90d4-415f-90a5-cba2b3507a66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/notes/{{note_id}}","description":"

This endpoint deletes an existing note using the note id.

This section provides resources for dealing with notes related to a applicant.

\n","_postman_id":"5f83d29e-31a7-44b4-b1c8-219692baa085"},{"name":"Tags","item":[{"name":"🆕 List Tags on Applicant","id":"295bd9e9-8457-484e-8848-4841cd182dd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/tags","description":"

This endpoint retrieves a list of tags associated with the given applicant ID.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b9ad19b9-29db-4530-b51a-c26e4a1ec403","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 33843,\n \"name\": \"1000 spend limit\",\n \"color\": \"blue\"\n },\n {\n \"id\": 49572,\n \"name\": \"benefits lapsed\",\n \"color\": \"blue\"\n }\n ]\n}"}],"_postman_id":"295bd9e9-8457-484e-8848-4841cd182dd1"},{"name":"Tag Applicant","id":"5510c7e4-5f95-4fdc-9aa1-8ce1c780aa01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/tags","description":"

Use this endpoint to create a new tag record for the applicant. The API will return the saved data and a unique tag ID.

Supported Fields

The following fields are supported for the request body
Tag field should be a valid tag ID or name.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	[\"123\"]	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a31063ae-605d-4b68-88a0-aa02e240039e","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":[\"1234\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/tags"},"status":"Tag Applicant","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1234,\n \"name\": \"Tag one\",\n \"color\": \"orange\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 12,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"5510c7e4-5f95-4fdc-9aa1-8ce1c780aa01"},{"name":"Untag Applicant","id":"fc292124-772a-43df-9982-4459909c2287","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/untag","description":"

Use this endpoint to unassign tag record from the applicant. The API will return the saved data and a unique applicant ID. Tag field should be a valid tag ID or name.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	\"1234\"	String	Yes

","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","untag"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"37070b01-fe6d-4cc6-a2b8-05f70a45e250","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":\"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/untag"},"status":"Untag Applicant","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 12,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"fc292124-772a-43df-9982-4459909c2287"},{"name":"Untag All Applicant Tags","id":"d638cb70-a3c9-49cb-b99d-a929f80b9694","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/untag_all","description":"

Use this endpoint to unassign all tags from the applicant.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}","untag_all"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b4733685-32b2-4c8b-9987-0994b690af7d","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}/untag_all"},"status":"Untag All Applicant Tags","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"d638cb70-a3c9-49cb-b99d-a929f80b9694"}],"id":"b7193a6e-3ca1-479e-8ad4-fcf066791d07","description":"

This section provides resources for dealing with Tags related to a applicant.

\n","_postman_id":"b7193a6e-3ca1-479e-8ad4-fcf066791d07"},{"name":"List Applicants","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"c0d3e7de-5b83-4718-9098-5c084471cead"}}],"id":"d23b857d-d09d-4dca-a313-7d588f2e954e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants","description":"

This endpoint retrieves a list of applicants. The enterprise package is required to view/edit the matched_unit_ids array list.

See available filters below to customize the list of applicants returned.

\n","urlObject":{"protocol":"https","path":["v2","applicants"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by applicant email

\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"

Filter by status (Tenant, Active, Inactive or custom created statuses)

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by pre-defined conditions (with-viewing, without-viewing, empty)

\n","type":"text/plain"},"key":"conditions","value":""},{"disabled":true,"description":{"content":"

Filter by tags associated with the applicant, which should be provided as a comma-separated list

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filters applicants by the created date, starting from the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"created_date_from","value":""},{"disabled":true,"description":{"content":"

Filters applicants by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"created_date_to","value":""},{"disabled":true,"description":{"content":"

To display only recent applicants, set this to true

\n","type":"text/plain"},"key":"new_applicants_today","value":""},{"disabled":true,"description":{"content":"

Filter applicants by the number of sharers

\n","type":"text/plain"},"key":"number_of_sharers","value":""},{"disabled":true,"description":{"content":"

Filter list by applicant source name

\n","type":"text/plain"},"key":"source","value":""},{"disabled":true,"description":{"content":"

Filter list by Manager ID

\n","type":"text/plain"},"key":"assign_to","value":""},{"disabled":true,"description":{"content":"

Filter list by a keyword

\n","type":"text/plain"},"key":"_q","value":""}],"variable":[]}},"response":[{"id":"4f8dfb14-6a0a-4072-9024-418c33202466","name":"Example","originalRequest":{"method":"GET","header":[{"key":"X-EntityID","value":"","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/applicants"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n\t\"data\": [\n\t\t{\n\t \"id\": \"146187\",\n\t \"title\": \"Mr\",\n\t \"applicant_status\": \"Undecided\",\n\t \"first_name\": \"John\",\n\t \"last_name\": \"Doe\",\n\t \"date_of_birth\": \"1970-01-01\",\n\t \"gender\": \"Male\",\n\t \"citizen_type\": \"UK Citizen\",\n \"latest_credit_score\": 0,\n \"latest_credit_description\": \"\",\n\t \"email\": \"sales@arthuronline.co.uk\",\n\t \"company_name\": \"Doe Industries\",\n\t \"company_address_name\": \"Main Office\",\n\t \"company_address1\": \"Fake House\",\n\t \"company_address2\": \"123 Fake Street\",\n\t \"company_city\": \"London\",\n\t \"company_postcode\": \"ABC 123\",\n\t \"company_county\": \"\",\n\t \"company_country\": \"United Kingdom\",\n\t \"phone_home\": \"01234 567899\",\n\t \"phone_work\": \"01234 567898\",\n\t \"mobile\": \"07777 777777\",\n\t \"residential_number\": \"1234567890\",\n\t \"visa_number\": \"\",\n\t \"visa_years\": \"5\",\n\t \"visa_type\": \"Tier 1\",\n\t \"country_of_origin\": \"UK\",\n\t \"ni_number\": \"12 34 56 78\",\n\t \"kin_first_name\": \"Jennifer\",\n\t \"kin_last_name\": \"Doe\",\n\t \"kin_mobile\": \"0788 888888\",\n\t \"kin_phone_work\": \"09876 543211\",\n\t \"student_status\": \"full time\",\n\t \"university\": \"University of Doe\",\n\t \"course_name\": \"Doe Studies\",\n\t \"course_id\": \"1234\",\n\t \"course_year\": \"2\",\n\t \"employment_company_name\": \"Arthur Online\",\n\t \"employment_address1\": \"Unit 2 Iron Bridge House\",\n\t \"employment_address2\": \"Bridge Approach\",\n\t \"employment_city\": \"London\",\n\t \"employment_postcode\": \"NW1 8BD\",\n\t \"employment_county\": \"Greater London\",\n\t \"employment_contact_name\": \"Alice Doe\",\n\t \"employment_contact_number\": \"+44(0)207 112 4860\",\n\t \"employment_salary\": \"100000\",\n\t \"employment_length\": \"1 year\",\n\t \"housing_benefit_council\": \"Doe Council\",\n\t \"housing_benefit_number\": \"1234567\",\n\t \"guarantor_first_name\": \"Jason\",\n\t \"guarantor_last_name\": \"Doe\",\n\t \"guarantor_date_of_birth\": \"1968-05-08\",\n\t \"guarantor_address1\": \"123 Fake Street\",\n\t \"guarantor_address2\": \"\",\n\t \"guarantor_city\": \"Notreal City\",\n\t \"guarantor_postcode\": \"ABC 123\",\n\t \"guarantor_county\": \"Doeshire\",\n\t \"guarantor_country\": \"United Kingdom\",\n\t \"guarantor_phone_home\": \"12345 678900\",\n\t \"guarantor_phone_work\": \"01234 567890\",\n\t \"guarantor_mobile\": \"07000 000000\",\n\t \"guarantor_email\": \"example@email.com\",\n\t \"guarantor_relation\": \"Father\",\n\t \"guarantor_home_owner\": \"Home Owner Outright\",\n\t \"guarantor_profession\": \"Professional\",\n\t \"bank_name\": \"Doe Bank\",\n\t \"bank_address1\": \"99 Bank Street\",\n\t \"bank_address2\": \"\",\n\t \"bank_city\": \"Bank City\",\n\t \"bank_county\": \"Bankshire\",\n\t \"bank_postcode\": \"B4N K99\",\n\t \"ref_name\": \"Referee Ali\",\n\t \"ref_address1\": \"Unit 3 Referee House\",\n\t \"ref_address2\": \"123 Referee Street\",\n\t \"ref_city\": \"Ref City\",\n\t \"ref_county\": \"Refshire\",\n\t \"ref_postcode\": \"ZXY 987\",\n\t \"ref_contact_number\": \"07788 888777\",\n\t \"ref_relation\": \"Friend\",\n\t \"number_of_sharers\": \"3\",\n\t \"source\": \"My website\",\n\t \"applicant_note\": \"I would like a brand new 1 bed flat somewhere within 1 mile of the station.\",\n\t \"manager_note\": \"This applicant has called 15 times this week!\",\n \"tags\":[\n \"tag1\"\n ],\n \"matched_unit_ids\": [\n \"418024\",\n \"80062\"\n ],\n \"image_urls\":[],\n \"custom_fields\":[],\n\t \"modified\": \"2019-05-28T12:00:00+00:00\",\n\t \"created\": \"2019-05-28T12:00:00+00:00\"\n\t }\n\t],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n\n"}],"_postman_id":"d23b857d-d09d-4dca-a313-7d588f2e954e"},{"name":"View Applicant","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"c3bd755b-7b15-4464-b1b3-480f7c7cb01d"}}],"id":"6d4cde5b-4a9d-483a-ab76-4bd689a90109","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}","description":"

This API endpoint retrieves the details of a single applicant, identified by its unique applicant_id.

Use this endpoint to view the specific details of a applicant.

\n","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a77eb0bd-97b0-40f8-bfbd-0dfc54cf8ba9","name":"Example","originalRequest":{"method":"GET","header":[{"key":"X-EntityID","type":"text","value":""},{"key":"Authorization","type":"text","value":"Bearer ","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": \"146187\",\n \"title\": \"Mr\",\n \"applicant_status\": \"Undecided\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1970-01-01\",\n \"gender\": \"Male\",\n \"citizen_type\": \"UK Citizen\",\n \"latest_credit_score\": 0,\n \"latest_credit_description\": \"\",\n \"email\": \"sales@arthuronline.co.uk\",\n \"company_name\": \"Doe Industries\",\n \"company_address_name\": \"Main Office\",\n \"company_address1\": \"Fake House\",\n \"company_address2\": \"123 Fake Street\",\n \"company_city\": \"London\",\n \"company_postcode\": \"ABC 123\",\n \"company_county\": \"\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"01234 567899\",\n \"phone_work\": \"01234 567898\",\n \"mobile\": \"07777 777777\",\n \"residential_number\": \"1234567890\",\n \"visa_number\": \"\",\n \"visa_years\": \"5\",\n \"visa_type\": \"Tier 1\",\n \"country_of_origin\": \"UK\",\n \"ni_number\": \"12 34 56 78\",\n \"kin_first_name\": \"Jennifer\",\n \"kin_last_name\": \"Doe\",\n \"kin_mobile\": \"0788 888888\",\n \"kin_phone_work\": \"09876 543211\",\n \"student_status\": \"full time\",\n \"university\": \"University of Doe\",\n \"course_name\": \"Doe Studies\",\n \"course_id\": \"1234\",\n \"course_year\": \"2\",\n \"employment_company_name\": \"Arthur Online\",\n \"employment_address1\": \"Unit 2 Iron Bridge House\",\n \"employment_address2\": \"Bridge Approach\",\n \"employment_city\": \"London\",\n \"employment_postcode\": \"NW1 8BD\",\n \"employment_county\": \"Greater London\",\n \"employment_contact_name\": \"Alice Doe\",\n \"employment_contact_number\": \"+44(0)207 112 4860\",\n \"employment_salary\": \"100000\",\n \"employment_length\": \"1 year\",\n \"housing_benefit_council\": \"Doe Council\",\n \"housing_benefit_number\": \"1234567\",\n \"guarantor_first_name\": \"Jason\",\n \"guarantor_last_name\": \"Doe\",\n \"guarantor_date_of_birth\": \"1968-05-08\",\n \"guarantor_address1\": \"123 Fake Street\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"Notreal City\",\n \"guarantor_postcode\": \"ABC 123\",\n \"guarantor_county\": \"Doeshire\",\n \"guarantor_country\": \"United Kingdom\",\n \"guarantor_phone_home\": \"12345 678900\",\n \"guarantor_phone_work\": \"01234 567890\",\n \"guarantor_mobile\": \"07000 000000\",\n \"guarantor_email\": \"example@email.com\",\n \"guarantor_relation\": \"Father\",\n \"guarantor_home_owner\": \"Home Owner Outright\",\n \"guarantor_profession\": \"Professional\",\n \"bank_name\": \"Doe Bank\",\n \"bank_address1\": \"99 Bank Street\",\n \"bank_address2\": \"\",\n \"bank_city\": \"Bank City\",\n \"bank_county\": \"Bankshire\",\n \"bank_postcode\": \"B4N K99\",\n \"ref_name\": \"Referee Ali\",\n \"ref_address1\": \"Unit 3 Referee House\",\n \"ref_address2\": \"123 Referee Street\",\n \"ref_city\": \"Ref City\",\n \"ref_county\": \"Refshire\",\n \"ref_postcode\": \"ZXY 987\",\n \"ref_contact_number\": \"07788 888777\",\n \"ref_relation\": \"Friend\",\n \"number_of_sharers\": \"3\",\n \"source\": \"My website\",\n \"applicant_note\": \"I would like a brand new 1 bed flat somewhere within 1 mile of the station.\",\n \"manager_note\": \"This applicant has called 15 times this week!\",\n \"tags\":[\n \"tag1\"\n ],\n \"matched_unit_ids\": [\n \"418024\",\n \"80062\"\n ],\n \"image_urls\":[],\n \"custom_fields\":[],\n \"modified\": \"2019-05-28T12:00:00+00:00\",\n \"created\": \"2019-05-28T12:00:00+00:00\"\n }\n}"}],"_postman_id":"6d4cde5b-4a9d-483a-ab76-4bd689a90109"},{"name":"Add Applicant","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"97fa2772-fd09-4b74-95dc-45bc78d9b331"}}],"id":"100b37e1-cb75-4498-8b44-2c501c4507ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicants","description":"

Use this endpoint to create a new applicant. The API will return the saved data and a unique Applicant ID.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Default	Required?
applicant_status	Active	String		No
title	Mr	Enum	Mr	No
first_name	Ryan	String		No
last_name	Cullen	String		No
date_of_birth	1995-05-28	Date		No
gender	Other	Enum	Male	No
citizen_type	UK Citizen	Enum		No
email	myemail@example.com	Email		No
company_name	Arthur Online	String		No
company_address_name	Arthur Main Office	String		No
company_address1	comp line 1	String		No
company_address2	comp line 2	String		No
company_city	compcity	String		No
company_postcode	C0MP 123	String		No
company_county	comp hertfordshire	String		No
company_country	51	Enum		No
phone_home	13597352	String		No
phone_work	0159876589	String		No
mobile	07726895134	String		No
residential_number	11236659	String		No
visa_number	1346dq89	String		No
visa_years	3	String		No
visa_type	Tier 2	Enum		No
country_of_origin	original country	String		No
ni_number	ab 12 34 5f	String		No
housing_benefit_council	herts council	String		No
housing_benefit_number	1346	String		No
bank_name	bnk name	String		No
bank_address1	bank line 1	String		No
bank_address2	bank line 2	String		No
bank_city	bankcity	String		No
bank_county	bank herts	String		No
bank_postcode	B4N K12	String		No
kin_first_name	next-of	String		No
kin_last_name	kin	String		No
kin_mobile	4512325178	String		No
kin_phone_work	996832145	String		No
student_status	full time	Enum	Full Time	No
university	viking university	String		No
course_name	viking studies	String		No
course_id	MC1685	String		No
course_year	3	String		No
employment_company_name	emp company name	String		No
employment_address1	emp line 1	String		No
employment_address2	emp line 2	String		No
employment_city	emp city	String		No
employment_postcode	3MP C0NT	String		No
employment_county	emp herts	String		No
employment_contact_name	employed contact	String		No
employment_contact_number	968235174	String		No
employment_salary	21000	String		No
employment_length	3 years	String		No
guarantor_first_name	Jason	String		No
guarantor_last_name	Doe	String		No
guarantor_date_of_birth	1968-05-08	String		No
guarantor_address1	123 Fake Street	String		No
guarantor_address2	123 Fake Street	String		No
guarantor_city	Notreal	String		No
guarantor_postcode	ABC 123	String		No
guarantor_county	Doeshire	String		No
guarantor_country	United Kingdom	String		No
guarantor_phone_home	12345 678900	String		No
guarantor_phone_work	01234 567890	String		No
guarantor_mobile	07000 000000	String		No
guarantor_email	example@email.com	String		No
guarantor_relation	Father	String		No
guarantor_home_owner	Home Owner Outright	String		No
guarantor_profession	Professional	String		No
ref_name	ref name	String		No
ref_address1	ref line 1	String		No
ref_address2	ref line 2	String		No
ref_city	ref Stevenage	String		No
ref_county	ref Hertfordshire	String		No
ref_postcode	R3F 8AW	String		No
ref_contact_number	134679825	String		No
ref_relation	mother	String		No
number_of_sharers	3	String		No
source	3	Simple		No
manager_note	MANAGER NOTES	String		No
applicant_note	TEST NOTE	String		No
tags	[\"tag1\"]	Array(String)		No

","urlObject":{"protocol":"https","path":["v2","applicants"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source

\n","type":"text/plain"},"key":"strict","value":"true"}],"variable":[]}},"response":[{"id":"4aff9b78-c445-455c-ad04-c0db1fa2d5c6","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer ","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Mr\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1970-01-01\",\n \"gender\": \"Male\",\n \"citizen_type\": \"UK Citizen\",\n \"email\": \"sales@arthuronline.co.uk\",\n \"company_name\": \"Doe Industries\",\n \"company_address_name\": \"Main Office\",\n \"company_address1\": \"Fake House\",\n \"company_address2\": \"123 Fake Street\",\n \"company_city\": \"London\",\n \"company_postcode\": \"ABC 123\",\n \"company_county\": \"\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"01234 567899\",\n \"phone_work\": \"01234 567898\",\n \"mobile\": \"07777 777777\",\n \"residential_number\": \"1234567890\",\n \"visa_number\": \"\",\n \"visa_years\": \"5\",\n \"visa_type\": \"Tier 1\",\n \"country_of_origin\": \"UK\",\n \"ni_number\": \"12 34 56 78\",\n \"kin_first_name\": \"Jennifer\",\n \"kin_last_name\": \"Doe\",\n \"kin_mobile\": \"0788 888888\",\n \"kin_phone_work\": \"09876 543211\",\n \"student_status\": \"full time\",\n \"university\": \"University of Doe\",\n \"course_name\": \"Doe Studies\",\n \"course_id\": \"1234\",\n \"course_year\": \"2\",\n \"employment_company_name\": \"Arthur Online\",\n \"employment_address1\": \"Unit 2 Iron Bridge House\",\n \"employment_address2\": \"Bridge Approach\",\n \"employment_city\": \"London\",\n \"employment_postcode\": \"NW1 8BD\",\n \"employment_county\": \"Greater London\",\n \"employment_contact_name\": \"Alice Doe\",\n \"employment_contact_number\": \"+44(0)207 112 4860\",\n \"employment_salary\": \"100000\",\n \"employment_length\": \"1 year\",\n \"housing_benefit_council\": \"Doe Council\",\n \"housing_benefit_number\": \"1234567\",\n \"guarantor_first_name\": \"Jason\",\n \"guarantor_last_name\": \"Doe\",\n \"guarantor_date_of_birth\": \"1968-05-08\",\n \"guarantor_address1\": \"123 Fake Street\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"Notreal City\",\n \"guarantor_postcode\": \"ABC 123\",\n \"guarantor_county\": \"Doeshire\",\n \"guarantor_country\": \"United Kingdom\",\n \"guarantor_phone_home\": \"12345 678900\",\n \"guarantor_phone_work\": \"01234 567890\",\n \"guarantor_mobile\": \"07000 000000\",\n \"guarantor_email\": \"example@email.com\",\n \"guarantor_relation\": \"Father\",\n \"guarantor_home_owner\": \"Home owner outright\",\n \"guarantor_profession\": \"Professional\",\n \"bank_name\": \"Doe Bank\",\n \"bank_address1\": \"99 Bank Street\",\n \"bank_address2\": \"\",\n \"bank_city\": \"Bank City\",\n \"bank_county\": \"Bankshire\",\n \"bank_postcode\": \"B4N K99\",\n \"ref_name\": \"Referee Ali\",\n \"ref_address1\": \"Unit 3 Referee House\",\n \"ref_address2\": \"123 Referee Street\",\n \"ref_city\": \"Ref City\",\n \"ref_county\": \"Refshire\",\n \"ref_postcode\": \"ZXY 987\",\n \"ref_contact_number\": \"07788 888777\",\n \"ref_relation\": \"Friend\",\n \"number_of_sharers\": \"3\",\n \"source\": \"My website\",\n \"applicant_note\": \"I would like a brand new 1 bed flat somewhere within 1 mile of the station.\",\n \"manager_note\": \"This applicant has called 15 times this week!\",\n \"tags\": [\n \"tag1\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/applicants"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"Mr\",\n \"applicant_status\": \"Undecided\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1970-01-01\",\n \"gender\": \"Male\",\n \"citizen_type\": \"UK Citizen\",\n \"latest_credit_score\": 0,\n \"latest_credit_description\": \"\",\n \"email\": \"sales@arthuronline.co.uk\",\n \"company_name\": \"Doe Industries\",\n \"company_address_name\": \"Main Office\",\n \"company_address1\": \"Fake House\",\n \"company_address2\": \"123 Fake Street\",\n \"company_city\": \"London\",\n \"company_postcode\": \"ABC 123\",\n \"company_county\": \"\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"01234 567899\",\n \"phone_work\": \"01234 567898\",\n \"mobile\": \"07777 777777\",\n \"residential_number\": \"1234567890\",\n \"visa_number\": \"\",\n \"visa_years\": \"5\",\n \"visa_type\": \"Tier 1\",\n \"country_of_origin\": \"UK\",\n \"ni_number\": \"12 34 56 78\",\n \"kin_first_name\": \"Jennifer\",\n \"kin_last_name\": \"Doe\",\n \"kin_mobile\": \"0788 888888\",\n \"kin_phone_work\": \"09876 543211\",\n \"student_status\": \"full time\",\n \"university\": \"University of Doe\",\n \"course_name\": \"Doe Studies\",\n \"course_id\": \"1234\",\n \"course_year\": \"2\",\n \"employment_company_name\": \"Arthur Online\",\n \"employment_address1\": \"Unit 2 Iron Bridge House\",\n \"employment_address2\": \"Bridge Approach\",\n \"employment_city\": \"London\",\n \"employment_postcode\": \"NW1 8BD\",\n \"employment_county\": \"Greater London\",\n \"employment_contact_name\": \"Alice Doe\",\n \"employment_contact_number\": \"+44(0)207 112 4860\",\n \"employment_salary\": \"100000\",\n \"employment_length\": \"1 year\",\n \"housing_benefit_council\": \"Doe Council\",\n \"housing_benefit_number\": \"1234567\",\n \"guarantor_first_name\": \"Jason\",\n \"guarantor_last_name\": \"Doe\",\n \"guarantor_date_of_birth\": \"1968-05-08\",\n \"guarantor_address1\": \"123 Fake Street\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"Notreal City\",\n \"guarantor_postcode\": \"ABC 123\",\n \"guarantor_county\": \"Doeshire\",\n \"guarantor_country\": \"United Kingdom\",\n \"guarantor_phone_home\": \"12345 678900\",\n \"guarantor_phone_work\": \"01234 567890\",\n \"guarantor_mobile\": \"07000 000000\",\n \"guarantor_email\": \"example@email.com\",\n \"guarantor_relation\": \"Father\",\n \"guarantor_home_owner\": \"Home Owner Outright\",\n \"guarantor_profession\": \"Professional\",\n \"bank_name\": \"Doe Bank\",\n \"bank_address1\": \"99 Bank Street\",\n \"bank_address2\": \"\",\n \"bank_city\": \"Bank City\",\n \"bank_county\": \"Bankshire\",\n \"bank_postcode\": \"B4N K99\",\n \"ref_name\": \"Referee Ali\",\n \"ref_address1\": \"Unit 3 Referee House\",\n \"ref_address2\": \"123 Referee Street\",\n \"ref_city\": \"Ref City\",\n \"ref_county\": \"Refshire\",\n \"ref_postcode\": \"ZXY 987\",\n \"ref_contact_number\": \"07788 888777\",\n \"ref_relation\": \"Friend\",\n \"number_of_sharers\": \"3\",\n \"source\": \"My website\",\n \"applicant_note\": \"I would like a brand new 1 bed flat somewhere within 1 mile of the station.\",\n \"manager_note\": \"This applicant has called 15 times this week!\",\n \"tags\": [\n \"tag1\"\n ],\n \"matched_unit_ids\": [\n \"418024\",\n \"80062\"\n ],\n \"image_urls\": [],\n \"custom_fields\": [],\n \"modified\": \"2019-05-28T12:00:00+00:00\",\n \"created\": \"2019-05-28T12:00:00+00:00\"\n }\n}"}],"_postman_id":"100b37e1-cb75-4498-8b44-2c501c4507ae"},{"name":"Update Applicant","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"a466b003-252d-449b-b9dd-1fc968826577"}}],"id":"586f65fd-2bae-40d8-a213-017e28375713","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}","description":"

This endpoint updates an existing unit using the same fields as the 'Add Applicant' endpoint. Any fields that are not provided will not be changed. The API will return the updated data for the applicant in the response.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Default	Required?
title	Mr	Enum	Mr	No
first_name	Ryan	String		No
last_name	Cullen	String		No
date_of_birth	1995-05-28	Date		No
gender	Other	Enum	Male	No
citizen_type	UK Citizen	Enum		No
email	myemail@example.com	Email		No
company_name	Arthur Online	String		No
company_address_name	Arthur Main Office	String		No
company_address1	comp line 1	String		No
company_address2	comp line 2	String		No
company_city	compcity	String		No
company_postcode	C0MP 123	String		No
company_county	comp hertfordshire	String		No
company_country	51	Enum		No
phone_home	13597352	String		No
phone_work	0159876589	String		No
mobile	07726895134	String		No
residential_number	11236659	String		No
visa_number	1346dq89	String		No
visa_years	3	String		No
visa_type	Tier 2	Enum		No
country_of_origin	original country	String		No
ni_number	ab 12 34 5f	String		No
housing_benefit_council	herts council	String		No
housing_benefit_number	1346	String		No
bank_name	bnk name	String		No
bank_address1	bank line 1	String		No
bank_address2	bank line 2	String		No
bank_city	bankcity	String		No
bank_county	bank herts	String		No
bank_postcode	B4N K12	String		No
kin_first_name	next-of	String		No
kin_last_name	kin	String		No
kin_mobile	4512325178	String		No
kin_phone_work	996832145	String		No
student_status	full time	Enum	Full Time	No
university	viking university	String		No
course_name	viking studies	String		No
course_id	MC1685	String		No
course_year	3	String		No
employment_company_name	emp company name	String		No
employment_address1	emp line 1	String		No
employment_address2	emp line 2	String		No
employment_city	emp city	String		No
employment_postcode	3MP C0NT	String		No
employment_county	emp herts	String		No
employment_contact_name	employed contact	String		No
employment_contact_number	968235174	String		No
employment_salary	21000	String		No
employment_length	3 years	String		No
ref_name	ref name	String		No
ref_address1	ref line 1	String		No
ref_address2	ref line 2	String		No
ref_city	ref Stevenage	String		No
ref_county	ref Hertfordshire	String		No
ref_postcode	R3F 8AW	String		No
ref_contact_number	134679825	String		No
ref_relation	mother	String		No
number_of_sharers	3	String		No
source	3	Simple		No
manager_note	MANAGER NOTES	String		No
applicant_note	TEST NOTE	String		No
tags	[\"tag1\"]	Array(String)		No

","urlObject":{"protocol":"https","path":["v2","applicants","{{applicant_id}}"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source

\n","type":"text/plain"},"key":"strict","value":"true"}],"variable":[]}},"response":[{"id":"28f7bbb9-89bf-47b7-a976-4f5838d0a7f6","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer ","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"sales@arthuronlineUpdated.co.uk\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.arthuronline.co.uk/v2/applicants/{{applicant_id}}","protocol":"https","host":["api","arthuronline","co","uk"],"path":["v2","applicants","{{applicant_id}}"],"query":[{"key":"strict","value":"true","description":"Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"Mr\",\n \"applicant_status\": \"Undecided\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1970-01-01\",\n \"gender\": \"Male\",\n \"citizen_type\": \"UK Citizen\",\n \"latest_credit_score\": 0,\n \"latest_credit_description\": \"\",\n \"email\": \"sales@arthuronlineUpdated.co.uk\",\n \"company_name\": \"Doe Industries\",\n \"company_address_name\": \"Main Office\",\n \"company_address1\": \"Fake House\",\n \"company_address2\": \"123 Fake Street\",\n \"company_city\": \"London\",\n \"company_postcode\": \"ABC 123\",\n \"company_county\": \"\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"01234 567899\",\n \"phone_work\": \"01234 567898\",\n \"mobile\": \"07777 777777\",\n \"residential_number\": \"1234567890\",\n \"visa_number\": \"\",\n \"visa_years\": \"5\",\n \"visa_type\": \"Tier 1\",\n \"country_of_origin\": \"UK\",\n \"ni_number\": \"12 34 56 78\",\n \"kin_first_name\": \"Jennifer\",\n \"kin_last_name\": \"Doe\",\n \"kin_mobile\": \"0788 888888\",\n \"kin_phone_work\": \"09876 543211\",\n \"student_status\": \"full time\",\n \"university\": \"University of Doe\",\n \"course_name\": \"Doe Studies\",\n \"course_id\": \"1234\",\n \"course_year\": \"2\",\n \"employment_company_name\": \"Arthur Online\",\n \"employment_address1\": \"Unit 2 Iron Bridge House\",\n \"employment_address2\": \"Bridge Approach\",\n \"employment_city\": \"London\",\n \"employment_postcode\": \"NW1 8BD\",\n \"employment_county\": \"Greater London\",\n \"employment_contact_name\": \"Alice Doe\",\n \"employment_contact_number\": \"+44(0)207 112 4860\",\n \"employment_salary\": \"100000\",\n \"employment_length\": \"1 year\",\n \"housing_benefit_council\": \"Doe Council\",\n \"housing_benefit_number\": \"1234567\",\n \"guarantor_first_name\": \"Jason\",\n \"guarantor_last_name\": \"Doe\",\n \"guarantor_date_of_birth\": \"1968-05-08\",\n \"guarantor_address1\": \"123 Fake Street\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"Notreal City\",\n \"guarantor_postcode\": \"ABC 123\",\n \"guarantor_county\": \"Doeshire\",\n \"guarantor_country\": \"United Kingdom\",\n \"guarantor_phone_home\": \"12345 678900\",\n \"guarantor_phone_work\": \"01234 567890\",\n \"guarantor_mobile\": \"07000 000000\",\n \"guarantor_email\": \"example@email.com\",\n \"guarantor_relation\": \"Father\",\n \"guarantor_home_owner\": \"Home Owner Outright\",\n \"guarantor_profession\": \"Professional\",\n \"bank_name\": \"Doe Bank\",\n \"bank_address1\": \"99 Bank Street\",\n \"bank_address2\": \"\",\n \"bank_city\": \"Bank City\",\n \"bank_county\": \"Bankshire\",\n \"bank_postcode\": \"B4N K99\",\n \"ref_name\": \"Referee Ali\",\n \"ref_address1\": \"Unit 3 Referee House\",\n \"ref_address2\": \"123 Referee Street\",\n \"ref_city\": \"Ref City\",\n \"ref_county\": \"Refshire\",\n \"ref_postcode\": \"ZXY 987\",\n \"ref_contact_number\": \"07788 888777\",\n \"ref_relation\": \"Friend\",\n \"number_of_sharers\": \"3\",\n \"source\": \"My website\",\n \"applicant_note\": \"I would like a brand new 1 bed flat somewhere within 1 mile of the station.\",\n \"manager_note\": \"This applicant has called 15 times this week!\",\n \"tags\": [\n \"tag1\"\n ],\n \"matched_unit_ids\": [\n \"418024\",\n \"80062\"\n ],\n \"image_urls\": [],\n \"custom_fields\": [],\n \"modified\": \"2019-05-28T12:00:00+00:00\",\n \"created\": \"2019-05-28T12:00:00+00:00\"\n }\n}"}],"_postman_id":"586f65fd-2bae-40d8-a213-017e28375713"},{"name":"Update Applicant Status","id":"a70fa154-74b4-40f2-bef4-8bcfd063f7e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/applicant/{{applicant_id}}/status","description":"

This endpoint updates an existing applicants status. The API will return the updated data for the applicant in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
status	\"Tenant\"	String	Yes

","urlObject":{"protocol":"https","path":["v2","applicant","{{applicant_id}}","status"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source

\n","type":"text/plain"},"key":"strict","value":"true"}],"variable":[]}},"response":[{"id":"21328d9f-9a27-4f66-92e7-75ea3b2bbe6b","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","name":"Content-Type","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"status\":\"Undecided\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.arthuronline.co.uk/v2/applicant/1/status","protocol":"https","host":["api","arthuronline","co","uk"],"path":["v2","applicant","1","status"],"query":[{"key":"strict","value":"true","description":"Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"Mr\",\n \"applicant_status\": \"Undecided\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1970-01-01\",\n \"gender\": \"Male\",\n \"citizen_type\": \"UK Citizen\",\n \"latest_credit_score\": 0,\n \"latest_credit_description\": \"\",\n \"email\": \"sales@arthuronline.co.uk\",\n \"company_name\": \"Doe Industries\",\n \"company_address_name\": \"Main Office\",\n \"company_address1\": \"Fake House\",\n \"company_address2\": \"123 Fake Street\",\n \"company_city\": \"London\",\n \"company_postcode\": \"ABC 123\",\n \"company_county\": \"\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"01234 567899\",\n \"phone_work\": \"01234 567898\",\n \"mobile\": \"07777 777777\",\n \"residential_number\": \"1234567890\",\n \"visa_number\": \"\",\n \"visa_years\": \"5\",\n \"visa_type\": \"Tier 1\",\n \"country_of_origin\": \"UK\",\n \"ni_number\": \"12 34 56 78\",\n \"kin_first_name\": \"Jennifer\",\n \"kin_last_name\": \"Doe\",\n \"kin_mobile\": \"0788 888888\",\n \"kin_phone_work\": \"09876 543211\",\n \"student_status\": \"full time\",\n \"university\": \"University of Doe\",\n \"course_name\": \"Doe Studies\",\n \"course_id\": \"1234\",\n \"course_year\": \"2\",\n \"employment_company_name\": \"Arthur Online\",\n \"employment_address1\": \"Unit 2 Iron Bridge House\",\n \"employment_address2\": \"Bridge Approach\",\n \"employment_city\": \"London\",\n \"employment_postcode\": \"NW1 8BD\",\n \"employment_county\": \"Greater London\",\n \"employment_contact_name\": \"Alice Doe\",\n \"employment_contact_number\": \"+44(0)207 112 4860\",\n \"employment_salary\": \"100000\",\n \"employment_length\": \"1 year\",\n \"housing_benefit_council\": \"Doe Council\",\n \"housing_benefit_number\": \"1234567\",\n \"guarantor_first_name\": \"Jason\",\n \"guarantor_last_name\": \"Doe\",\n \"guarantor_date_of_birth\": \"1968-05-08\",\n \"guarantor_address1\": \"123 Fake Street\",\n \"guarantor_address2\": \"\",\n \"guarantor_city\": \"Notreal City\",\n \"guarantor_postcode\": \"ABC 123\",\n \"guarantor_county\": \"Doeshire\",\n \"guarantor_country\": \"United Kingdom\",\n \"guarantor_phone_home\": \"12345 678900\",\n \"guarantor_phone_work\": \"01234 567890\",\n \"guarantor_mobile\": \"07000 000000\",\n \"guarantor_email\": \"example@email.com\",\n \"guarantor_relation\": \"Father\",\n \"guarantor_home_owner\": \"Home Owner Outright\",\n \"guarantor_profession\": \"Professional\",\n \"bank_name\": \"Doe Bank\",\n \"bank_address1\": \"99 Bank Street\",\n \"bank_address2\": \"\",\n \"bank_city\": \"Bank City\",\n \"bank_county\": \"Bankshire\",\n \"bank_postcode\": \"B4N K99\",\n \"ref_name\": \"Referee Ali\",\n \"ref_address1\": \"Unit 3 Referee House\",\n \"ref_address2\": \"123 Referee Street\",\n \"ref_city\": \"Ref City\",\n \"ref_county\": \"Refshire\",\n \"ref_postcode\": \"ZXY 987\",\n \"ref_contact_number\": \"07788 888777\",\n \"ref_relation\": \"Friend\",\n \"number_of_sharers\": \"3\",\n \"source\": \"My website\",\n \"applicant_note\": \"I would like a brand new 1 bed flat somewhere within 1 mile of the station.\",\n \"manager_note\": \"This applicant has called 15 times this week!\",\n \"tags\": [\n \"tag1\"\n ],\n \"matched_unit_ids\": [\n \"418024\",\n \"80062\"\n ],\n \"image_urls\": [],\n \"custom_fields\": [],\n \"modified\": \"2019-05-28T12:00:00+00:00\",\n \"created\": \"2019-05-28T12:00:00+00:00\"\n }\n}"}],"_postman_id":"a70fa154-74b4-40f2-bef4-8bcfd063f7e7"}],"id":"8361ab49-1e6f-4981-bb02-56eb1229097f","description":"

Here you can find the full list of endpoints for the Applicants area of the system.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0db38a6d-7bcf-4e04-9976-74be66062b93"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0003dc48-e5d6-4a23-bcdb-22c35dea7c62"}}],"_postman_id":"8361ab49-1e6f-4981-bb02-56eb1229097f"},{"name":"Viewings","item":[{"name":"Applicants","item":[{"name":"List Applicants on Viewing","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"916a2895-7ee3-4103-99f1-c0b6c5df3b9e"}}],"id":"61466cc5-d829-4bc8-ba5a-b631519ca1c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/applicants","description":"

This retrieves a list of applicants on a viewing, identified by its unique viewing_id.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","applicants"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"6c439be7-b4ec-4e75-bc56-f0b0abf520f2","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/applicants"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n\t\"data\": [\n\t\t{\n\t \"id\": \"146187\",\n\t \"title\": \"Mr\",\n\t \"applicant_status\": \"Undecided\",\n\t \"first_name\": \"John\",\n\t \"last_name\": \"Doe\",\n\t \"date_of_birth\": \"1970-01-01\",\n\t \"gender\": \"Male\",\n\t \"citizen_type\": \"UK Citizen\",\n \"latest_credit_score\": 0,\n \"latest_credit_description\": \"\",\n\t \"email\": \"sales@arthuronline.co.uk\",\n\t \"company_name\": \"Doe Industries\",\n\t \"company_address_name\": \"Main Office\",\n\t \"company_address1\": \"Fake House\",\n\t \"company_address2\": \"123 Fake Street\",\n\t \"company_city\": \"London\",\n\t \"company_postcode\": \"ABC 123\",\n\t \"company_county\": \"\",\n\t \"company_country\": \"United Kingdom\",\n\t \"phone_home\": \"01234 567899\",\n\t \"phone_work\": \"01234 567898\",\n\t \"mobile\": \"07777 777777\",\n\t \"residential_number\": \"1234567890\",\n\t \"visa_number\": \"\",\n\t \"visa_years\": \"5\",\n\t \"visa_type\": \"Tier 1\",\n\t \"country_of_origin\": \"UK\",\n\t \"ni_number\": \"12 34 56 78\",\n\t \"kin_first_name\": \"Jennifer\",\n\t \"kin_last_name\": \"Doe\",\n\t \"kin_mobile\": \"0788 888888\",\n\t \"kin_phone_work\": \"09876 543211\",\n\t \"student_status\": \"full time\",\n\t \"university\": \"University of Doe\",\n\t \"course_name\": \"Doe Studies\",\n\t \"course_id\": \"1234\",\n\t \"course_year\": \"2\",\n\t \"employment_company_name\": \"Arthur Online\",\n\t \"employment_address1\": \"Unit 2 Iron Bridge House\",\n\t \"employment_address2\": \"Bridge Approach\",\n\t \"employment_city\": \"London\",\n\t \"employment_postcode\": \"NW1 8BD\",\n\t \"employment_county\": \"Greater London\",\n\t \"employment_contact_name\": \"Alice Doe\",\n\t \"employment_contact_number\": \"+44(0)207 112 4860\",\n\t \"employment_salary\": \"100000\",\n\t \"employment_length\": \"1 year\",\n\t \"housing_benefit_council\": \"Doe Council\",\n\t \"housing_benefit_number\": \"1234567\",\n\t \"guarantor_first_name\": \"Jason\",\n\t \"guarantor_last_name\": \"Doe\",\n\t \"guarantor_date_of_birth\": \"1968-05-08\",\n\t \"guarantor_address1\": \"123 Fake Street\",\n\t \"guarantor_address2\": \"\",\n\t \"guarantor_city\": \"Notreal City\",\n\t \"guarantor_postcode\": \"ABC 123\",\n\t \"guarantor_county\": \"Doeshire\",\n\t \"guarantor_country\": \"United Kingdom\",\n\t \"guarantor_phone_home\": \"12345 678900\",\n\t \"guarantor_phone_work\": \"01234 567890\",\n\t \"guarantor_mobile\": \"07000 000000\",\n\t \"guarantor_email\": \"example@email.com\",\n\t \"guarantor_relation\": \"Father\",\n\t \"guarantor_home_owner\": \"Home Owner Outright\",\n\t \"guarantor_profession\": \"Professional\",\n\t \"bank_name\": \"Doe Bank\",\n\t \"bank_address1\": \"99 Bank Street\",\n\t \"bank_address2\": \"\",\n\t \"bank_city\": \"Bank City\",\n\t \"bank_county\": \"Bankshire\",\n\t \"bank_postcode\": \"B4N K99\",\n\t \"ref_name\": \"Referee Ali\",\n\t \"ref_address1\": \"Unit 3 Referee House\",\n\t \"ref_address2\": \"123 Referee Street\",\n\t \"ref_city\": \"Ref City\",\n\t \"ref_county\": \"Refshire\",\n\t \"ref_postcode\": \"ZXY 987\",\n\t \"ref_contact_number\": \"07788 888777\",\n\t \"ref_relation\": \"Friend\",\n\t \"number_of_sharers\": \"3\",\n\t \"source\": \"My website\",\n\t \"applicant_note\": \"I would like a brand new 1 bed flat somewhere within 1 mile of the station.\",\n\t \"manager_note\": \"This applicant has called 15 times this week!\",\n \"tags\":[\n \"tag1\"\n ],\n \"image_urls\":[],\n \"custom_fields\":[],\n\t \"modified\": \"2019-05-28T12:00:00+00:00\",\n\t \"created\": \"2019-05-28T12:00:00+00:00\"\n\t }\n\t],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n\n"}],"_postman_id":"61466cc5-d829-4bc8-ba5a-b631519ca1c4"}],"id":"70de7919-dac7-4c0c-a341-954859d7af94","description":"

Here you can find the full list of endpoints for the Applicants area of the system under a Viewing record

\n","_postman_id":"70de7919-dac7-4c0c-a341-954859d7af94"},{"name":"Assigned Managers","item":[{"name":"🆕 List Managers on Viewing","id":"9a0443d1-9dce-4744-839a-aaec4723bc83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/managers","description":"

This endpoint retrieves a list of assigned managers associated with the given viewing ID.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","managers"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"6fd6578c-d2a1-47b7-acd0-93a93d918e3a","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 100569,\n \"first_name\": \"API\",\n \"last_name\": \"Support\",\n \"full_name\": \"API Support\",\n \"group\": \"Property Manager\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"mobile\": \"\",\n \"phone_work\": \"\",\n \"phone_home\": \"\",\n \"created\": \"2017-06-26T22:51:49\",\n \"modified\": \"2023-02-21T11:29:04\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"9a0443d1-9dce-4744-839a-aaec4723bc83"},{"name":"🆕 View Manager on Viewing","id":"b8cf7d2c-6e79-4cae-ad25-11e65449ebad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/managers/{{manager_id}}","description":"

This API endpoint retrieves the details of a single assigned manager, identified by its unique manager_id.

Use this endpoint to view the specific details of an assigned manager, on a viewing record.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","managers","{{manager_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ef209f63-4be4-4564-8348-32a99d1a3a5f","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/managers/{{manager_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 100569,\n \"first_name\": \"API\",\n \"last_name\": \"Support\",\n \"full_name\": \"API Support\",\n \"group\": \"Property Manager\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"mobile\": \"\",\n \"phone_work\": \"\",\n \"phone_home\": \"\",\n \"created\": \"2017-06-26T22:51:49\",\n \"modified\": \"2023-02-21T11:29:04\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"b8cf7d2c-6e79-4cae-ad25-11e65449ebad"},{"name":"🆕 Add Manager on Viewing","id":"909e362b-3844-4762-8d78-8ca0845fadf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/managers","description":"

Use this endpoint to assign managers to a viewing. The API will return the saved manager data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
person_id	158674	Integer	Yes

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","managers"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a555fdc5-74c5-4d5a-8009-5cde68fd57c0","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"person_id\": 100569\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 100569,\n \"first_name\": \"API\",\n \"last_name\": \"Support\",\n \"full_name\": \"API Support\",\n \"group\": \"Property Manager\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"mobile\": \"\",\n \"phone_work\": \"\",\n \"phone_home\": \"\",\n \"created\": \"2017-06-26T22:51:49\",\n \"modified\": \"2023-02-21T11:29:04\"\n }\n}"}],"_postman_id":"909e362b-3844-4762-8d78-8ca0845fadf9"},{"name":"🆕 Delete Manager on Viewing","id":"f259e159-56bd-4803-a0f9-a484f71bf855","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/managers/{{manager_id}}","description":"

This endpoint deletes an existing assignee using the assigned manager id, on a viewing record.

Here you can find the full list of endpoints for the Assigned Managers area of the system under a Viewing record.

\n","_postman_id":"13d39239-649f-470d-b2f3-bff64965eea3"},{"name":"Conversations","item":[{"name":"Conversation Recipients","item":[{"name":"Get Recipients for Viewing","id":"7a46fb2f-c102-47f5-88ba-0b087245622a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/conversation_recipients","description":"

This endpoint retrieves a list of conversation recipients on a viewing record, identified by its unique viewing_id.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","conversation_recipients"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"45139df1-2b4f-40d8-8c88-8fa3f0dc354f","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/conversation_recipients"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Applicant\",\n \"first_name\": \"Henry\",\n \"last_name\": \"Williams\",\n \"group\": \"tenant\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 2,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Mike\",\n \"last_name\": \"Marky\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 3,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Tenants\",\n \"first_name\": \"Josh\",\n \"last_name\": \"Jackson\",\n \"group\": \"tenant\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 4,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Tenants\",\n \"first_name\": \"Brian\",\n \"last_name\": \"Shaw\",\n \"group\": \"tenant\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 6,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Owner\",\n \"first_name\": \"Leon\",\n \"last_name\": \"Silva\",\n \"group\": \"owner\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:28:56+01:00\",\n \"modified\": \"2020-06-29T14:28:56+01:00\"\n }\n ]\n}"}],"_postman_id":"7a46fb2f-c102-47f5-88ba-0b087245622a"}],"id":"4035ea9f-7ca5-43c3-bf99-dd91768156f0","description":"

Here you can find the full list of endpoints for the Conversation Receipients area of the system, under a Viewing record

\n","_postman_id":"4035ea9f-7ca5-43c3-bf99-dd91768156f0"},{"name":"List Conversations On Viewing","id":"1a7900ed-2e15-45e4-a997-f113790899aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/conversations","description":"

This endpoint retrieves a list of conversations on a viewing, identified by its unique viewing_id.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"55846379-c18f-4cb7-9a3b-4a3920ed3362","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"title\": \"Subject 1\",\n \"message_count\": 1,\n \"model\": \"Viewing\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Sure!\",\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"modified\": \"2020-04-22T12:03:28+01:00\"\n },\n {\n \"id\": 123,\n \"title\": \"Subject 2\",\n \"message_count\": 1,\n \"model\": \"Viewing\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Remember to clean on friday.\",\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"modified\": \"2020-04-30T11:49:54+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"1a7900ed-2e15-45e4-a997-f113790899aa"},{"name":"Create Conversation On Viewing","id":"7f541e3d-52a1-4029-a843-4e6d28d0add9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/conversations","description":"

Use this endpoint to create a new conversation on a viewing record. The API will return the saved data and a unique Conversation ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
message	It's done	String	Yes
subject	Meeting tomorrow	String	Yes
person_ids	['1','2']	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"9dec9d60-304c-4ca1-9dbf-d6bc1a1664b0","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"message\":\"Please clean the house on friday.\",\n\t\"subject\":\"House duties\",\n\t\"person_ids\":[\"21\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"House duties\",\n \"message_count\": 1,\n \"model\": \"Viewing\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 2,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 21,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Please clean the house on friday.\",\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"modified\": \"2020-06-05T15:06:26+01:00\"\n }\n}"}],"_postman_id":"7f541e3d-52a1-4029-a843-4e6d28d0add9"}],"id":"a8a10b25-ada2-4129-949d-c1e64786e689","description":"

Here you can find the full list of endpoints for the Conversations area of the system, under a Viewing record.

\n","_postman_id":"a8a10b25-ada2-4129-949d-c1e64786e689"},{"name":"Tags","item":[{"name":"🆕 List Tags on Viewing","id":"967cebdc-831e-4a6d-a87f-194da83ca52e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/tags","description":"

This endpoint retrieves a list of tags associated with the given Viewing ID.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"335004bb-e32d-4302-b371-7623154b76f8","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 33843,\n \"name\": \"1000 spend limit\",\n \"color\": \"blue\"\n },\n {\n \"id\": 49572,\n \"name\": \"benefits lapsed\",\n \"color\": \"blue\"\n }\n ]\n}"}],"_postman_id":"967cebdc-831e-4a6d-a87f-194da83ca52e"},{"name":"Tag Viewing","id":"6e5ec7a6-62a3-4b15-9c5e-eebc36cf91b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/tags","description":"

Use this endpoint to create a new tag record for the viewing. The API will return the saved data and a unique tag ID.

Supported Fields

The following fields are supported for the request body
Tag field should be a valid tag ID or name.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	[\"123\"]	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"d7cd4628-38fa-4ae5-a123-c46269bb6587","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":[\"1234\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/tags"},"status":"Tag Viewing","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1234,\n \"name\": \"Tag one\",\n \"color\": \"orange\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 12,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"6e5ec7a6-62a3-4b15-9c5e-eebc36cf91b5"},{"name":"Untag Viewing","id":"c38917df-6e3a-42f0-b348-2550c735c573","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/untag","description":"

Use this endpoint to unassign tag record from the viewing. The API will return the saved data. Tag field should be a valid tag ID or name.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	\"123\"	String	Yes

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","untag"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"dad4a890-d094-4e66-b2f5-ef697ef82aaf","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":\"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/untag"},"status":"Untag Viewing","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"c38917df-6e3a-42f0-b348-2550c735c573"},{"name":"Untag All Viewing Tags","id":"5cd1b967-3d09-478d-9775-1607a1236bac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/untag_all","description":"

Use this endpoint to unassign all tags from the viewing.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","untag_all"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"4eba85fd-e67b-43ac-872c-f9f8a7cab036","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/untag_all"},"status":"Untag All Viewing Tags","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"5cd1b967-3d09-478d-9775-1607a1236bac"}],"id":"b64fe031-bcba-4b9c-baaa-62d3ada441dc","description":"

This section provides resources for dealing with Tags related to a viewing.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3fcbb92c-28d5-4eb6-b052-20fa5982fe45"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"64233d18-ec78-4c3c-8cce-d5d5d52e338f"}}],"_postman_id":"b64fe031-bcba-4b9c-baaa-62d3ada441dc"},{"name":"Notes","item":[{"name":"List Notes On Viewing","id":"04d2edd3-bd3f-4398-b8eb-2f4cfce13542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/notes","description":"

This endpoint retrieves a list of notes associated with the given viewing ID.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"07d9bba8-ed51-4a10-b08e-0446af1b43a1","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/notes"},"status":"List Notes On Viewing","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\"last_edited_by\": {\n \t\"id\": null,\n \t\"full_name\": null\n \t},\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \t\"modified\": \"2020-05-28T11:57:55+01:00\"\n },\n {\n \"id\": 1234,\n \"content\": \"Remember this note , please\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\"last_edited_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \t\"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n"}],"_postman_id":"04d2edd3-bd3f-4398-b8eb-2f4cfce13542"},{"name":"View Note On Viewing","id":"e938673a-3223-446c-a340-60d71821e021","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/notes/{{note_id}}","description":"

This API endpoint retrieves the details of a single note, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"285252d1-0e9f-489e-958a-dac142b20b9d","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tenancies/{{tenancy_id}}/notes/{{note_id}}"},"status":"View Note On Viewing","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Interesting\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}\n"}],"_postman_id":"e938673a-3223-446c-a340-60d71821e021"},{"name":"Add Note On Viewing","id":"56ecaf53-a4d1-48e9-adb1-4546a5febabd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/notes","description":"

Use this endpoint to create a new note record for the viewing. The API will return the saved data and a unique note ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	Yes
tags	['one','two']	Array(String)	No

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"d409e654-b0a1-4c9a-8788-8e31985d0fd0","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\":\"Remember this note\",\n\t\"tags\":[\"one\",\"two\"]\n\t\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/notes"},"status":"Add Note On Viewing","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": null,\n \"full_name\": null\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [\n {\n \"id\": 123,\n \"name\": \"one\"\n },\n {\n \"id\": 1234,\n \"name\": \"two\"\n }\n ],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"56ecaf53-a4d1-48e9-adb1-4546a5febabd"},{"name":"Update Note On Viewing","id":"c3f2065a-8b20-4909-952b-3b76011177a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/notes/{{note_id}}","description":"

This endpoint updates an existing note using the same fields as the 'Add Note' endpoint. The API will return the updated data for the note in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	No
tags	['one','two']	Array(String)	No

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a27c72ca-d785-428e-969c-71752dbd5183","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\":\"Updated Note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/notes/{{note_id}}"},"status":"Update Note On Viewing","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Updated Note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}\n"}],"_postman_id":"c3f2065a-8b20-4909-952b-3b76011177a1"},{"name":"Delete Note On Viewing","id":"718363c6-dade-4c55-810d-d8bfafd17704","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/notes/{{note_id}}","description":"

This endpoint deletes an existing note using the note id.

This section provides resources for dealing with notes related to a viewing.

\n","_postman_id":"655171af-3b1d-490b-8803-2617e0cb13a6"},{"name":"Tenancies","item":[{"name":"List Tenancies On Viewing","id":"4224a0cf-4c16-40ef-984e-a6178b8150d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/tenancies","description":"

This endpoint retrieves a list of tenancies associated with the given viewing ID.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","tenancies"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"6ceabeac-87ff-4008-89ef-cbcf922ad6fb","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","name":"Content-Type","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/tenancies"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": [\r\n \t{\r\n\t \"id\": 12345,\r\n \t\"property_id\": 11223,\r\n \t\"unit_id\": 22334,\r\n \t\"ref\": \"TE1001\",\r\n \t\"status\": \"Current\",\r\n \t\"full_address\": \"Flat 10, 2 Station Road, London, EN5 1QW\",\r\n \t\"unit_owner\": \"\",\r\n \t\"tenancy_type\": \"Commercial\",\r\n \t\"unit_assigned_managers\": \"\",\r\n \t\"main_tenant_name\": \"tenant one\",\r\n\t \"tenants\": [\r\n\t {\r\n\t \"id\": 12121,\r\n \t\"first_name\": \"tenant\",\r\n \t\"last_name\": \"one\",\r\n \t\"date_of_birth\": \"1980-05-06\",\r\n \t\"mobile\": \"07123456789\",\r\n \t\"phone_home\": \"\",\r\n \t\"phone_work\": \"\",\r\n \t\"email\": \"sales@arthuronline.co.uk\",\r\n \t\"lastest_credit_score\": \"0\",\r\n \t\"lastest_credit_description\": \"\",\r\n \t\"main_tenant\": true,\r\n \t\"move_in_date\": \"2019-01-01\",\r\n \t\"move_out_date\": \"2020-01-01\"\r\n\t }\r\n\t ],\r\n\t \"letting_agent\": {\r\n\t \"id\": 99999,\r\n\t \"first_name\": \"Arthur\",\r\n\t \"last_name\": \"Agency\",\r\n\t \"primary_phone\": \"\",\r\n\t \"primary_email\": \"sales+agent@arthuronline.co.uk\"\r\n\t },\r\n\t \"contract_type\": \"Company\",\r\n \t\"renter_company\": \"\",\r\n \t\"start_date\": \"2019-09-01\",\r\n \t\"end_date\": \"2020-09-01\",\r\n \t\"break_clause_date\": null,\r\n \t\"fixed_break_date\": \"2020-02-13\",\r\n \t\"rolling_break_date\": \"2019-09-18\",\r\n \t\"notice_period\": \"1 months\",\r\n \t\"issue_break_clause_to\": \"landlord\",\r\n \t\"move_in_date\": \"2019-01-02\",\r\n \t\"move_in_time\": \"12:00\",\r\n \t\"move_out_date\": null,\r\n \t\"move_out_time\": null,\r\n \t\"rent_amount\": 875,\r\n \t\"rent_frequency\": \"Monthly\",\r\n \t\"deposit_held_by\": \"\",\r\n \t\"deposit_registered\": false,\r\n \t\"deposit_registered_amount\": \"\",\r\n \t\"rent_review_date\": null,\r\n \t\"section_21_served\": false,\r\n\t \"rent_payment_bank\": {\r\n\t \"id\": 55555,\r\n\t \"bank_name\": \"\",\r\n\t \"bank_account\": \"Arthur default account\",\r\n\t \"account_number\": \"00000000\",\r\n\t \"sort_code\": \"000000\"\r\n\t },\r\n\t \"deposit payment bank\": {\r\n\t \"id\": 5556,\r\n\t \"bank_name\": \"\",\r\n\t \"bank_account\": \"Arthur default account\",\r\n\t \"account_number\": \"00000000\",\r\n\t \"sort_code\": \"000000\"\r\n\t },\r\n\t \"default_rent_payment_method\": \"Bank Transfer\",\r\n\t \"rent_insured\": false,\r\n\t\t\t\"tags\": [],\r\n \t\"notes\": [],\r\n\t \"modified\": \"2019-09-02T11:20:42+00:00\",\r\n\t \"created\": \"2019-09-02T11:20:42+00:00\"\r\n\t }\r\n ],\r\n \"pagination\": {\r\n \"page\": 1,\r\n \"current\": 1,\r\n \"count\": 1,\r\n \"pageCount\": 1,\r\n \"limit\": 20\r\n }\r\n}"}],"_postman_id":"4224a0cf-4c16-40ef-984e-a6178b8150d3"},{"name":"🆕 Add Tenancy On Viewing","id":"fbbc1163-bd28-4497-a45c-45d8526cfbdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/tenancies","description":"

Use this endpoint to create a new tenancy from a viewing. The API will return the saved data and a unique Tenancy ID.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Default	Required?
status	Current	Integer	Prospective	No
tenancy_type	Commercial	Integer	Residential	No
letting_agent_id	90909	Integer		No
contract_type	Company	String		No
renter_company	Renter Ltd.	String		No
start_date	2019-01-01	Date		Yes
end_date	2020-01-01	Date		No
break_clause_date	2019-06-01	Date		No
fixed_break_date	2019-06-01	Date		No
rolling_break_date	2019-09-18	Date		No
notice_period	2 months	String	1 months	No
issue_break_clause_to	landlord	String		No
move_in_date	2019-01-01	Date		No
move_in_time	12:00	Time		No
move_out_date	2020-01-01	Date		No
move_out_time	12:00	Time		No
rent_amount	875	Float		Yes
rent_frequency	Monthly	String		No
deposit_held_by	DPS	String		No
rent_payment_bank_id	1423	Integer		No
deposit_payment_bank_id	4132	Integer		No
default_rent_payment_method	Bank Transfer	String		No
rent_insured	false	Boolean		No
tags	[\"12 month contract\"]	Array (String)		No

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","tenancies"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"0cc21b46-1453-4b91-b141-118f95d4600c","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"Current\",\n \"tenancy_type\": \"Commercial\",\n \"start_date\": \"2019-01-01\",\n \"end_date\": \"2020-01-01\",\n \"break_clause_date\": \"2019-06-01\",\n \"fixed_break_date\": \"2019-06-01\",\n \"rolling_break_date\": \"2019-09-18\",\n \"move_in_date\": \"2019-01-01\",\n \"move_in_time\": \"12:00\",\n \"move_out_date\": \"2020-01-01\",\n \"move_out_time\": \"12:00\",\n \"deposit_held_by\": \"\",\n \"default_rent_payment_method\": \"Bank Transfer\",\n \"rent_insured\": false,\n \"tags\": [\n \t\"12 month contract\"\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/tenancies"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"property_id\": 2,\n \"unit_id\": 3,\n \"ref\": \"TE10\",\n \"status\": \"Current\",\n \"full_address\": \"unit address, London, MA918S\",\n \"unit_owner\": \"Ronnie Sherman\",\n \"tenancy_type\": \"Commercial\",\n \"tenancy_sub_type\": \"\",\n \"unit_assigned_managers\": \"Brian Shawn\",\n \"main_tenant_name\": \"\",\n \"tenants\": [],\n \"letting_agent\": {\n \"id\": 0,\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"primary_phone\": \"\",\n \"primary_email\": \"\"\n },\n \"contract_type\": \"\",\n \"renter_company\": \"\",\n \"start_date\": \"2019-01-01\",\n \"end_date\": \"2020-01-01\",\n \"break_clause_date\": \"2019-06-01\",\n \"fixed_break_date\": \"2019-06-01\",\n \"rolling_break_date\": \"2019-09-18\",\n \"notice_period\": \"\",\n \"issue_break_clause_to\": \"\",\n \"move_in_date\": \"2019-01-01\",\n \"move_in_time\": \"12:00\",\n \"move_out_date\": \"2020-01-01\",\n \"move_out_time\": \"12:00\",\n \"rent_amount\": 0,\n \"rent_frequency\": \"\",\n \"deposit_held_by\": \"\",\n \"deposit_scheme\": \"\",\n \"deposit_registered\": false,\n \"deposit_registered_amount\": \"0.00\",\n \"rent_review_date\": null,\n \"section_21_served\": false,\n \"rent_payment_bank\": {\n \"id\": 77775,\n \"bank_name\": \"Barclays\",\n \"bank_account\": \"deposit\",\n \"account_number\": \"123\",\n \"sort_code\": \"123\"\n },\n \"deposit payment bank\": {\n \"id\": 77775,\n \"bank_name\": \"Barclays\",\n \"bank_account\": \"deposit\",\n \"account_number\": \"123\",\n \"sort_code\": \"123\"\n },\n \"default_rent_payment_method\": \"Bank Transfer\",\n \"rent_insured\": false,\n \"tags\": [\n \"12 month contract\"\n ],\n \"notes\": [],\n \"custom_fields\": [],\n \"modified\": \"2020-10-29T11:24:20+00:00\",\n \"created\": \"2020-10-29T11:24:20+00:00\"\n }\n}"}],"_postman_id":"fbbc1163-bd28-4497-a45c-45d8526cfbdd"}],"id":"3eb0d08c-00dc-42d0-916b-954a5c7b1ab2","description":"

This section provides resources for dealing with Tenancies related to a viewing.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ed11e01c-429a-4405-ba36-2eb64a3eb2f2"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9510b4c3-7514-4988-9d95-805cd12a3218"}}],"_postman_id":"3eb0d08c-00dc-42d0-916b-954a5c7b1ab2"},{"name":"Offers","item":[{"name":"🆕 Submit Offer on Viewing","id":"514867c9-05f8-419f-949d-5e421a8585e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/submit_offer","description":"

This endpoint submits an offer to an existing viewing. Any fields that are not provided will not be changed. The API will return the updated data for the viewing in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
amount	1200	String	Yes
frequency	Month	String	Yes (Week, Month, or Year)

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","submit_offer"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"f3522003-5acd-4375-b585-2502193bb8e4","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"1200\",\n \"frequency\": \"Month\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/submit_offer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 633231,\n \"unit_id\": 599238,\n \"unit_address\": \"Unit 1 - Iron Bridge House, London, NW7 1JH\",\n \"lat\": 53.2457105,\n \"lng\": -2.5220604,\n \"applicant\": {\n \"id\": 1182293,\n \"full_name\": \"API Support\"\n },\n \"applicants\": [\n {\n \"id\": 1182293,\n \"full_name\": \"API Support\"\n }\n ],\n \"viewing_status\": \"Confirmed\",\n \"viewing_date\": \"2023-02-27\",\n \"viewing_time\": \"10:53\",\n \"viewing_datetime\": \"2023-02-27T10:53:00\",\n \"offer_amount\": \"1200.00\",\n \"offer_frequency\": \"Month\",\n \"duration\": 30,\n \"move_in_date\": null,\n \"unit_available_from\": null,\n \"unit_is_vacant\": true,\n \"assigned_to\": [\n {\n \"id\": 100569,\n \"full_name\": \"Max \"\n }\n ],\n \"relationships\": [\n {\n \"model\": \"Unit\",\n \"model_id\": \"599238\",\n \"ref\": \"Unit 1 - Iron Bridge House\"\n },\n {\n \"model\": \"Property\",\n \"model_id\": \"280736\",\n \"ref\": \"Iron Bridge House\"\n }\n ],\n \"tags\": [],\n \"notes\": [],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"modified\": \"2023-03-06T10:53:14\",\n \"created\": \"2023-02-14T10:12:25\",\n \"deleted\": false\n }\n}"}],"_postman_id":"514867c9-05f8-419f-949d-5e421a8585e8"}],"id":"db8bc178-4367-4120-957b-37d216887e10","description":"

This section provides resources for dealing with Offers related to a viewing.

\n","_postman_id":"db8bc178-4367-4120-957b-37d216887e10"},{"name":"List Viewings","id":"f30cb42f-2fb2-4a84-a0b6-104dea02296d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings","description":"

This endpoint retrieves a list of viewings.

See available filters below to customize the list of viewings returned.

\n","urlObject":{"protocol":"https","path":["v2","viewings"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by assigned unit

\n","type":"text/plain"},"key":"unit_id","value":""},{"disabled":true,"description":{"content":"

Filter viewings by status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter the viewings by assigned to ID.

\n","type":"text/plain"},"key":"assigned_to","value":""},{"disabled":true,"description":{"content":"

Filter viewings by tags

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

To display only viewings assigned to you, set this to true

\n","type":"text/plain"},"key":"assigned_to_me","value":""},{"disabled":true,"description":{"content":"

Filters viewings by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"date_from","value":""},{"disabled":true,"description":{"content":"

Filters viewings by the date, up to the specified date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"date_to","value":""},{"disabled":true,"description":{"content":"

Filter by a viewing date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"viewing_date","value":""},{"disabled":true,"description":{"content":"

Filter by the amount offered

\n","type":"text/plain"},"key":"offer_amount","value":""},{"disabled":true,"description":{"content":"

Filter by the amount offered frequency

\n","type":"text/plain"},"key":"offer_frequency","value":""},{"disabled":true,"description":{"content":"

Filter by a keyword

\n","type":"text/plain"},"key":"_q","value":null}],"variable":[]}},"response":[{"id":"add2d70a-51c5-4af6-889b-dbe0a3b565e8","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/viewings"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n\t\"data\": [\n\t\t {\n \"id\": 1,\n \"unit_id\": 12,\n \"unit_address\": \"Unit 1, White house, Ciechocinek, 80-809\",\n \"applicant\": {\n \"id\": 123,\n \"full_name\": \"Michael White\"\n },\n \"applicants\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael White\"\n }\n ],\n \"viewing_status\": \"Confirmed\",\n \"viewing_date\": \"2020-10-10\",\n \"viewing_time\": \"14:11\",\n \"viewing_datetime\": \"2020-10-10T14:11:00+00:00\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"\",\n \"duration\": 0,\n \"move_in_date\": null,\n \"unit_available_from\": \"2020-12-16\",\n \"unit_is_vacant\": false,\n \"assigned_to\": [],\n \"tags\": [],\n \"notes\": [],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"modified\": \"2020-02-18T09:43:45+00:00\",\n \"created\": \"2020-02-18T09:43:45+00:00\",\n \"deleted\": false\n },\n\t\t{\n \"id\": 1,\n \"unit_id\": 132,\n \"unit_address\": \"Unit 1, White house, Ciechocinek, 80-809\",\n \"applicant\": {\n \"id\": 123,\n \"full_name\": \"Michael White\"\n },\n \"applicants\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael White\"\n }\n ],\n \"viewing_status\": \"Confirmed\",\n \"viewing_date\": \"2020-10-10\",\n \"viewing_time\": \"14:11\",\n \"viewing_datetime\": \"2020-10-10T14:11:00+00:00\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"\",\n \"duration\": 0,\n \"move_in_date\": null,\n \"unit_available_from\": \"2020-12-16\",\n \"unit_is_vacant\": false,\n \"assigned_to\": [],\n \"tags\": [],\n \"notes\": [],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"modified\": \"2020-02-18T09:43:45+00:00\",\n \"created\": \"2020-02-18T09:43:45+00:00\",\n \"deleted\": false\n }\n\t],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"f30cb42f-2fb2-4a84-a0b6-104dea02296d"},{"name":"View Viewing","id":"ee9a3324-4b80-4d2b-b6c7-3fb784e1ab49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}","description":"

This API endpoint retrieves the details of a single viewing, identified by its unique viewing_id.

Use this endpoint to view the specific details of a viewing.

\n","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"2be365f2-566d-4a91-a384-e962ca76aec3","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"unit_id\": 12,\n \"unit_address\": \"Unit 1, White house, Ciechocinek, 80-809\",\n \"applicant\": {\n \"id\": 123,\n \"full_name\": \"Michael White\"\n },\n \"applicants\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael White\"\n }\n ],\n \"viewing_status\": \"Confirmed\",\n \"viewing_date\": \"2020-10-10\",\n \"viewing_time\": \"14:11\",\n \"viewing_datetime\": \"2020-10-10T14:11:00+00:00\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"\",\n \"duration\": 0,\n \"move_in_date\": null,\n \"unit_available_from\": \"2020-12-16\",\n \"unit_is_vacant\": false,\n \"assigned_to\": [],\n \"tags\": [],\n \"notes\": [],\n \"source\": \"\",\n \"viewing_notes\": \"\",\n \"modified\": \"2020-02-18T09:43:45+00:00\",\n \"created\": \"2020-02-18T09:43:45+00:00\",\n \"deleted\": false\n }\n}"}],"_postman_id":"ee9a3324-4b80-4d2b-b6c7-3fb784e1ab49"},{"name":"Add Viewing","id":"4c5a132e-abcb-4c0e-a031-388395973794","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arthuronline.co.uk/v2/viewings","description":"

Use this endpoint to create a new viewing record. The API will return the saved data and a unique viewing ID.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Default	Required?
applicant_id	123	Integer		Yes if applicant_ids not provided.
applicant_ids	[\"123\"]	Array(Strings)		Yes if applicant_id not provided.
unit_id	1234	Integer		Yes
viewing_date	\"1999-12-12\"	Date		No
viewing_time	\"14:31\"	Time		No
duration	15	Integer		No
offer_amount	1250.00	Float		No
move_in_date	\"1999-12-13\"	Date		No
assigned_to_ids	[\"123\",\"321\"]	Array(Strings)		No
tags	[\"cheap rent\"]	Array(Strings)		No
source	\"gumtree\"	String		No
viewing_notes	\"3 month contract\"	String		No
viewing_status	\"Confirmed\"	String	Confirmed	No

You can use the \"new_applicants\" object to simultaneously create or update applicants. This will replace the \"applicant_id\" and \"applicant_ids\" fields. Here's an example of how to use it:

To create a new applicant, include the following information within the \"new_applicants\" object:

\"new_applicants\": [\n    {\n        \"first_name\": \"Matej\",\n        \"last_name\": \"Cubbit\",\n        \"email\": \"matej123@gmail.com\"\n    }\n]\n\n

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
applicant_id	123	Integer	No
first_name	\"Michael\"	String	Yes / if applicant_id not provided
last_name	\"Cubitt\"	String	Yes / if applicant_id not provided
email	\"michael123@gmail.com	String	Yes / if applicant_id not provided
date_of_birth	\"1999-12-12\"	Date	No
mobile	\"0201230201\"	String	No
phone_home	\"0201230201\"	String	No
phone_work	\"0201230201\"	String	No
has_guarantor	true	Boolean	No
guarantor_first_name	\"Brian\"	String	No
guarantor_last_name	\"Oneil\"	String	No
guarantor_mobile	\"0201230201\"	String	No
guarantor_email	\"myguarantor@gmail.com	String	No

","urlObject":{"protocol":"https","path":["v2","viewings"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source

\n","type":"text/plain"},"key":"strict","value":"true"}],"variable":[]}},"response":[{"id":"60755ce8-d3a1-45d4-ac63-d44c89d9be54","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":" {\n \"unit_id\": 123,\n \"new_applicants\":[\n {\n // update existing one\n \"applicant_id\": 1234,\n \"first_name\":\"Martin\",\n \"last_name\":\"Gothic\",\n \"email\":\"loremipsum@gmail.com\"\n },\n {\n // new Applicant\n \"first_name\":\"Vladimir\",\n \"last_name\":\"O'Brian\",\n \"email\":\"vladObri@gmail.com\"\n }\n ],\n \"viewing_status\": \"Enquired\",\n \"viewing_date\": \"2021-10-10\",\n \"viewing_time\": \"14:23\",\n \"viewing_datetime\": \"2021-10-10T14:33:00+00:00\",\n \"offer_amount\": 15.12,\n \"offer_frequency\": \"per week\",\n \"duration\": 15,\n \"move_in_date\": \"2021-10-10\",\n \"assigned_to_ids\": [\"123\"],\n \"tags\": [\"Cheap rent\"],\n \"viewing_notes\": \"viewing note\",\n \"source\": \"new source\",\n \"modified\": \"2021-02-23T16:21:15+00:00\",\n \"created\": \"2021-02-18T09:50:18+00:00\",\n \"deleted\": false\n }","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.arthuronline.co.uk/v2/viewings","protocol":"https","host":["api","arthuronline","co","uk"],"path":["v2","viewings"],"query":[{"key":"strict","value":"true","description":"Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"unit_id\": 237983,\n \"unit_address\": \"Unit 1, White house, Ciechocinek, 80-809\",\n \"applicant\": {\n \"id\": 231887,\n \"full_name\": \"Martin Gothic\"\n },\n \"applicants\": [\n {\n \"id\": 1234,\n \"full_name\": \"Martin Gothic\"\n },\n {\n \"id\": 12345,\n \"full_name\": \"Vladimir O'Brian\"\n }\n ],\n \"viewing_status\": \"Enquired\",\n \"viewing_date\": \"2021-10-10\",\n \"viewing_time\": \"14:23\",\n \"viewing_datetime\": \"2021-10-10T14:23:00+00:00\",\n \"offer_amount\": \"15.12\",\n \"offer_frequency\": \"per week\",\n \"duration\": 15,\n \"move_in_date\": \"2021-10-10\",\n \"unit_available_from\": \"2020-12-16\",\n \"unit_is_vacant\": false,\n \"assigned_to\": [\n {\n \"id\": 123,\n \"full_name\": \"Brian Shaw\"\n }\n ],\n \"tags\": [\n \"Cheap rent\"\n ],\n \"notes\": [],\n \"source\": \"new source\",\n \"viewing_notes\": \"viewing note\",\n \"modified\": \"2021-03-09T14:07:02+00:00\",\n \"created\": \"2021-03-09T14:07:02+00:00\",\n \"deleted\": false\n }\n}"}],"_postman_id":"4c5a132e-abcb-4c0e-a031-388395973794"},{"name":"Update Viewing","id":"b37abdae-f344-4422-9e90-5ba8ecf7c557","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}","description":"

This endpoint updates an existing viewing using the same fields as the 'Add Viewing' endpoint, excluding unit_id and applicant_id. Any fields that are not provided will not be changed.

The API will return the updated data for the viewing in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
viewing_date	\"2020-10-10\"	Date	No
viewing_time	\"15:30\"	Time	No
duration	15	Integer	No
offer_amount	1050.30	float	No
offer_frequency	\"per week\"	string	No
move_in_date	\"2020-10-10\"	Date	No
assigned_to_ids	[\"12\"]	Array(Strings)	No
tags	[\"tag1\"]	Array(Strings)	No
source	facebook	String	No
viewing_notes	\"lorem ipsum\"	String	No
viewing_status	\"Confirmed\"	String	No

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source

\n","type":"text/plain"},"key":"strict","value":"true"}],"variable":[]}},"response":[{"id":"26cbad7b-81ff-48f1-abf0-e89e76d12404","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","name":"Content-Type","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"viewing_date\": \"2020-10-21\",\n\t\"viewing_time\": \"14:21\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}","protocol":"https","host":["api","arthuronline","co","uk"],"path":["v2","viewings","{{viewing_id}}"],"query":[{"key":"strict","value":"true","description":"Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"unit_id\": 2,\n \"unit_address\": \"lorem ipsum 1 , NW1WA1 , London\",\n \"applicant\": {\n \"id\": 3,\n \"full_name\": \"Daniel Janiczuk\"\n },\n \"applicants\": [\n {\n \"id\": 4,\n \"full_name\": \"Daniel Janiczuk\"\n }\n ],\n \"viewing_status\": \"Confitmed\",\n \"viewing_date\": \"2020-10-21\",\n \"viewing_time\": \"14:21\",\n \"viewing_datetime\": \"2020-10-21T14:21:00+00:00\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"per month\",\n \"duration\": 30,\n \"move_in_date\": null,\n \"unit_available_from\": null,\n \"unit_is_vacant\": true,\n \"assigned_to\": [\n {\n \"id\": 1,\n \"full_name\": \"Michael Obrian\"\n }\n ],\n \"tags\": [],\n \"notes\": [],\n \"source\": \"\",\n \"viewing_notes\": \"lorem ipsum\",\n \"modified\": \"2021-03-18T12:18:31+00:00\",\n \"created\": \"2020-08-14T10:06:11+00:00\",\n \"deleted\": false\n }\n}"}],"_postman_id":"b37abdae-f344-4422-9e90-5ba8ecf7c557"},{"name":"Update Viewing Status","id":"76f85092-cf1e-4a50-9fcc-80ee801b00e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"viewing_date\": \"\",\n\t\"viewing_time\": \"\",\n\t\"offer_amount\": \"\",\n\t\"offer_frequency\": \"\",\n\t\"move_in_date\": \"\",\n\t\"assigned_to_ids\": [\n\t\t\"1234\"\n\t],\n\t\"source\": \"\",\n\t\"notes\": \"\"\n}"},"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}/status","description":"

This endpoint updates an existing viewing status. The API will return the updated data for the viewing in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
status	\"Confirmed\"	String	Yes

","urlObject":{"protocol":"https","path":["v2","viewings","{{viewing_id}}","status"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source

\n","type":"text/plain"},"key":"strict","value":"true"}],"variable":[]}},"response":[{"id":"b878a1b3-f1af-4331-9b20-ba876b5de98c","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","name":"Content-Type","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"status\":\"Confitmed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.arthuronline.co.uk/v2/viewings/1/status","protocol":"https","host":["api","arthuronline","co","uk"],"path":["v2","viewings","1","status"],"query":[{"key":"strict","value":"true","description":"Any simple fields that cannot be found will return a validation error, instead of creating a new value. E.g. source","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"unit_id\": 2,\n \"unit_address\": \"lorem ipsum 1 , NW1WA1 , London\",\n \"applicant\": {\n \"id\": 3,\n \"full_name\": \"Daniel Janiczuk\"\n },\n \"applicants\": [\n {\n \"id\": 4,\n \"full_name\": \"Daniel Janiczuk\"\n }\n ],\n \"viewing_status\": \"Confitmed\",\n \"viewing_date\": \"2020-08-14\",\n \"viewing_time\": \"11:21\",\n \"viewing_datetime\": \"2020-08-14T14:33:00+00:00\",\n \"offer_amount\": \"\",\n \"offer_frequency\": \"per month\",\n \"duration\": 30,\n \"move_in_date\": null,\n \"unit_available_from\": null,\n \"unit_is_vacant\": true,\n \"assigned_to\": [\n {\n \"id\": 1,\n \"full_name\": \"Michael Obrian\"\n }\n ],\n \"tags\": [],\n \"notes\": [],\n \"source\": \"\",\n \"viewing_notes\": \"lorem ipsum\",\n \"modified\": \"2021-03-18T12:18:31+00:00\",\n \"created\": \"2020-08-14T10:06:11+00:00\",\n \"deleted\": false\n }\n}"}],"_postman_id":"76f85092-cf1e-4a50-9fcc-80ee801b00e9"},{"name":"Delete Viewing","id":"e20edcea-85ec-4995-86ed-af06b44905e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/viewings/{{viewing_id}}","description":"

This endpoint deletes an existing viewing record using the viewing id.

Here you can find the full list of endpoints for the Viewings area of the system.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"6ab5513c-6b31-4f04-b149-53828e3706f3"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e10989ad-85a8-4958-83ae-d8d754f22f4f"}}],"_postman_id":"d89b0106-5d0a-46f2-b0d4-4b036cd598ae"},{"name":"Maintenance","item":[{"name":"Tasks","item":[{"name":"Subtasks","item":[{"name":"List Subtasks on Task","id":"86d6be4b-ad76-44a5-9ebe-0d7b3babc61f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/subtasks","description":"

This endpoint retrieves a list of subtasks associated with the given task ID.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","subtasks"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"478e811a-79f2-4500-9841-accde3575013","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/subtasks"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"task_id\": 123,\n \"ref\": \"TA123\",\n \"description\": \"subtask description\",\n \"due_date\": \"2020-11-20\",\n \"completed\": false,\n \"last_updated_by\": {\n \"id\": 123,\n \"full_name\": \"Brian O'Connor\",\n \"action\": \"added\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Brian O'Connor\"\n },\n \"modified\": \"2020-04-10T10:38:12+01:00\",\n \"created\": \"2020-08-10T10:38:12+01:00\"\n },\n {\n \"id\": 132,\n \"task_id\": 123,\n \"ref\": \"TA132\",\n \"description\": \"subtask description\",\n \"due_date\": null,\n \"completed\": false,\n \"last_updated_by\": {\n \"id\": 132,\n \"full_name\": \"Brian O'Connor\",\n \"action\": \"added\"\n },\n \"created_by\": {\n \"id\": 132,\n \"name\": \"Brian O'Connor\"\n },\n \"modified\": \"2020-08-10T10:32:36+01:00\",\n \"created\": \"2020-08-10T10:32:36+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"86d6be4b-ad76-44a5-9ebe-0d7b3babc61f"},{"name":"View Subtask On Task","id":"49ba5e44-e893-49b7-80fc-5e6982872ff7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/subtasks/{{subtask_id}}","description":"

This API endpoint retrieves the details of a single subtask, identified by its unique subtask_id.

Use this endpoint to view the specific details of a subtask on a task.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","subtasks","{{subtask_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"f658e3a2-04c8-4fdb-acf2-8f5cc1b15466","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/subtasks/{{subtask_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"task_id\": 123,\n \"ref\": \"TA1111\",\n \"description\": \"Subtask description\",\n \"due_date\": null,\n \"completed\": false,\n \"last_updated_by\": {\n \"id\": 123,\n \"full_name\": \"Michael Williams\",\n \"action\": \"added\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Michael Williams\"\n },\n \"modified\": \"2020-08-10T10:37:36+01:00\",\n \"created\": \"2020-08-10T10:37:36+01:00\"\n }\n}"}],"_postman_id":"49ba5e44-e893-49b7-80fc-5e6982872ff7"},{"name":"Create Subtask on Task","id":"2e352907-8a7d-41e7-8858-ce4ebe7d2c54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/subtasks","description":"

Use this endpoint to create a new subtask record for a task. The API will return the saved data and a unique subtask ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
description	subtask nb1	String	Yes
due_date	2020-09-22	Date	No
completed	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","subtasks"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"1c1ed92c-e220-4436-85d9-1024910039fb","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\":\"new subtask\",\n \"due_date\":\"2020-09-21\",\n \"completed\":false\n}\n ","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/subtasks"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"task_id\": 123,\n \"ref\": \"TA1111\",\n \"description\": \"new subtask\",\n \"due_date\": \"2020-09-21\",\n \"completed\": false,\n \"last_updated_by\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"action\": \"added\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Brian Jones\"\n },\n \"modified\": \"2020-08-10T10:37:36+01:00\",\n \"created\": \"2020-08-10T10:37:36+01:00\"\n }\n}"}],"_postman_id":"2e352907-8a7d-41e7-8858-ce4ebe7d2c54"},{"name":"Update Subtask On Task","id":"31bd55a9-3beb-4ea6-a81b-1b169a6926ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/subtasks/{{subtask_id}}","description":"

This endpoint updates an existing subtask on a task using the same fields as the 'Add Subtask' endpoint. The API will return the updated data for the note in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
description	subtask nb1	String	No
due_date	2020-09-22	Date	No
completed	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","subtasks","{{subtask_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"29eb5ba2-c440-4bfa-8250-1d21d071099e","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"completed\":true\n}\n ","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/subtasks/{{subtask_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"task_id\": 123,\n \"ref\": \"TA1111\",\n \"description\": \"Subtask description\",\n \"due_date\": null,\n \"completed\": true,\n \"last_updated_by\": {\n \"id\": 123,\n \"full_name\": \"Michael Williams\",\n \"action\": \"added\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Michael Williams\"\n },\n \"modified\": \"2020-08-10T10:37:36+01:00\",\n \"created\": \"2020-08-10T10:37:36+01:00\"\n }\n}"}],"_postman_id":"31bd55a9-3beb-4ea6-a81b-1b169a6926ba"},{"name":"Delete Subtask On Task","id":"fe89055d-34b7-4793-b4cb-16d93d214e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/subtasks/{{subtask_id}}","description":"

This endpoint deletes an existing subtask note using the subtask id.

This section provides resources for dealing with Subtasks related to a task.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"73be7f27-1a67-4fcf-9ff0-b53e1d372b94"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b4ae9827-d035-444d-b85f-9082d2a317de"}}],"_postman_id":"ba56594e-7aad-426f-81da-2003544b6869"},{"name":"Workorders","item":[{"name":"List Workorders On Task","id":"84ad4c62-b414-40b9-a996-eb9f396a7445","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/workorders","description":"

This endpoint retrieves a list of workorders associated with the given task ID.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","workorders"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"0975191b-da3e-4393-95f5-1a7a1b11f3ab","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/workorders"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"TASK 123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"84ad4c62-b414-40b9-a996-eb9f396a7445"},{"name":"View Workorder On Task","id":"a3af24c0-9b44-4353-a342-baded13debb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/workorders/{{workorder_id}}","description":"

This API endpoint retrieves the details of a single task workorder, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","workorders","{{workorder_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"8e4b5f65-51f1-41fd-860f-f15aeebfc65e","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/workorders/{{workorder_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"a3af24c0-9b44-4353-a342-baded13debb0"},{"name":"Create Workorder On Task","id":"fc38bbd9-a721-41f7-8c28-87a4c5defafd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/workorders","description":"

Use this endpoint to create a new workorder record for a task. The API will return the saved data and a unique workorder ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
title	workorder title	String	No
description	workorder description	String	No
invite_contractors	[123,1234]	Array(integer)	No
service_type	Carpet Layer	String	Yes
start_date	2020-02-20	Date	No
due_date	2020-02-20	Date	No
budget	1000,00	Float	No
allocated_time_hours	20	Float	No
actual_time_hours	20	Float	No
price_per_hour	7,90	Float	No
emergency	true	Boolean	No
quote_required	true	Boolean	No
share_assets	false	Boolean	No
hide_tenant_details	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","workorders"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"48e5c3f6-8d39-423c-be70-e0fc71bee7ec","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"service_type\":\"aerial-network-specialist\",\n \"title\":\"Workorder title\",\n \"description\":\"Workorder Description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/workorders"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Unit 123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 0,\n \"full_name\": \"\",\n \"status\": \"\"\n },\n \"invited_contractors\": [],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"unit address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"fc38bbd9-a721-41f7-8c28-87a4c5defafd"},{"name":"Update Workorder On Task","id":"3d06e8da-880a-4066-93ba-ebd112210696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/workorders/{{workorder_id}}","description":"

This endpoint updates an existing workorder on a task using the same fields as the 'Add Workorder' endpoint. The API will return the updated data for the tenancy in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
title	workorder title	String	No
description	workorder description	String	No
invite_contractors	[123,1234]	Array(integer)	No
service_type	Carpet Layer	String	No
start_date	2020-02-20	Date	No
due_date	2020-02-20	Date	No
budget	1000,00	Float	No
allocated_time_hours	20	Float	No
actual_time_hours	20	Float	No
price_per_hour	7,90	Float	No
emergency	true	Boolean	No
quote_required	true	Boolean	No
share_assets	false	Boolean	No
hide_tenant_details	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","workorders","{{workorder_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"244be93f-9eb6-4aa0-b86b-e04d8047c313","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\":\"Updated title\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/workorders/{{workorder_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Updated title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"unit address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"3d06e8da-880a-4066-93ba-ebd112210696"}],"id":"e703c27b-41cb-41ab-9eb0-20db3686c759","description":"

This section provides resources for dealing with Workorders related to a task.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c957daa3-f9df-4086-9472-472f64ee2b10"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e4e0f4f1-a761-4e9d-b282-e2d9e3bdfdfc"}}],"_postman_id":"e703c27b-41cb-41ab-9eb0-20db3686c759"},{"name":"Tags","item":[{"name":"List Tags on Task","id":"850881c1-1c82-4336-850e-44b9bfecddb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/tags","description":"

This endpoint retrieves a list of tags associated with the given Task ID.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"563bed86-5c0f-489a-8124-e16886999ac9","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"tag one\",\n \"color\": \"sky\"\n },\n {\n \"id\": 123,\n \"name\": \"tag two\",\n \"color\": \"lightgreen\"\n },\n {\n \"id\": 123,\n \"name\": \"tag three\",\n \"color\": \"purple\"\n }\n ]\n}"}],"_postman_id":"850881c1-1c82-4336-850e-44b9bfecddb7"},{"name":"Tag Task","id":"2e6b12d9-9e96-47e0-b4aa-18e3a2b3371b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/tags","description":"

Use this endpoint to create a new tag record for a task. The API will return the saved data and a unique tag ID.

Supported Fields

The following fields are supported for the request body
Tag field should be a valid tag ID or name.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	[\"123\"]	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"fa36d4f1-254a-4d46-8244-08ac62ac8437","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":[\"1234\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/tags"},"status":"Tag Task","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1234,\n \"name\": \"Tag one\",\n \"color\": \"orange\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 12,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"2e6b12d9-9e96-47e0-b4aa-18e3a2b3371b"},{"name":"Untag Task","id":"3fd257e4-6186-4171-be7b-bd202b241c9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/untag","description":"

Use this endpoint to unassign tag record from a task. The API will return the saved data. Tag field should be a valid tag ID or name.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	\"123\"	String	Yes

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","untag"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"591454e3-7ac0-4c7b-8d49-01a64dee1eb7","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":\"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/units/{{unit_id}}/untag"},"status":"Untag Unit","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"3fd257e4-6186-4171-be7b-bd202b241c9a"},{"name":"Untag All Task Tags","id":"6c42e4d7-89c3-41fb-8f3c-22833d686cef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/untag_all","description":"

Use this endpoint to unassign all tags from the task.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","untag_all"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"265cc41b-c0f5-4417-8621-2feb0b2051aa","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/untag_all"},"status":"Untag All Task Tags","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"6c42e4d7-89c3-41fb-8f3c-22833d686cef"}],"id":"16fafef3-607f-4b65-98e0-81010583ad02","description":"

This section provides resources for dealing with Tags related to a task.

\n","_postman_id":"16fafef3-607f-4b65-98e0-81010583ad02"},{"name":"Notes","item":[{"name":"List Notes on Task","id":"d11e7b4d-f200-4a27-85a4-541de5e9af38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/notes","description":"

This endpoint retrieves a list of notes associated with the given task ID.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"253a2332-9a66-43f7-bb5d-ba60c8b44180","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/notes"},"status":"List Notes On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\"last_edited_by\": {\n \t\"id\": null,\n \t\"full_name\": null\n \t},\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \t\"modified\": \"2020-05-28T11:57:55+01:00\"\n },\n {\n \"id\": 1234,\n \"content\": \"Remember this note , please\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\"last_edited_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \t\"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n"}],"_postman_id":"d11e7b4d-f200-4a27-85a4-541de5e9af38"},{"name":"View Note on Task","id":"871776d6-0fde-477f-a70b-a6d32ac390f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/notes/{{note_id}}","description":"

This API endpoint retrieves the details of a single task note, identified by its unique id

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"acd75ecc-e38a-402d-9f74-7b62e2b81724","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/notes/{{note_id}}"},"status":"View Note On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Interesting\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}\n"}],"_postman_id":"871776d6-0fde-477f-a70b-a6d32ac390f8"},{"name":"Create Note on Task","id":"43eb04d9-2608-4001-a32c-ee0c7a63c183","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/notes","description":"

Use this endpoint to create a new note record for a task. The API will return the saved data and a unique note ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	Yes
tags	['one','two']	Array(String)	No

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e0daf69f-10c0-4233-b3dd-a90966549335","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\":\"Remember this note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/notes"},"status":"Add Note On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": null,\n \"full_name\": null\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [\n {\n \"id\": 123,\n \"name\": \"one\"\n },\n {\n \"id\": 1234,\n \"name\": \"two\"\n }\n ],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"43eb04d9-2608-4001-a32c-ee0c7a63c183"},{"name":"Update Note on Task","id":"3d80faf0-8214-472b-8c4b-4bda21e23922","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/notes/{{note_id}}","description":"

This endpoint updates an existing note on a task using the same fields as the 'Add Note' endpoint. The API will return the updated data for the note in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	No
tags	['one','two']	Array(String)	No

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ebe4e011-7641-4860-827f-fe7207bf700d","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\":\"Updated Note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/notes/{{note_id}}"},"status":"Update Note On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Updated Note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}\n"}],"_postman_id":"3d80faf0-8214-472b-8c4b-4bda21e23922"},{"name":"Delete Note on Task","id":"e166dcb4-a3f0-4bbd-bcfb-fd7c1126e4dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/notes/{{note_id}}","description":"

This endpoint deletes an existing task note using the note id.

This section provides resources for dealing with Notes related to a task.

\n","_postman_id":"6c8dde66-1a34-4ca0-a5e8-f162d4f0e622"},{"name":"Conversations","item":[{"name":"Conversation Recipients","item":[{"name":"Get Recipients for Task","id":"b52ff3fb-de8b-437b-a60e-1205b8d7886b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/conversation_recipients","description":"

This endpoint retrieves a list of conversation recipients on a task record, identified by its unique task_id.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","conversation_recipients"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"334694ac-d3e1-4dce-94af-0e867a71f10f","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/conversation_recipients"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Henry\",\n \"last_name\": \"Williams\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 2,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Mike\",\n \"last_name\": \"Marky\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 3,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Tenants\",\n \"first_name\": \"Josh\",\n \"last_name\": \"Jackson\",\n \"group\": \"tenant\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 4,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Tenants\",\n \"first_name\": \"Brian\",\n \"last_name\": \"Shaw\",\n \"group\": \"tenant\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 5,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Guarantors\",\n \"first_name\": \"Jason\",\n \"last_name\": \"Doe\",\n \"group\": \"guarantor\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:28:56+01:00\",\n \"modified\": \"2020-06-29T14:28:56+01:00\"\n },\n {\n \"id\": 6,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Owner\",\n \"first_name\": \"Leon\",\n \"last_name\": \"Silva\",\n \"group\": \"owner\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:28:56+01:00\",\n \"modified\": \"2020-06-29T14:28:56+01:00\"\n }\n ]\n}"}],"_postman_id":"b52ff3fb-de8b-437b-a60e-1205b8d7886b"}],"id":"7c1e8447-efda-4c10-aa62-3706c3a77493","description":"

Here you can find the full list of endpoints for the Conversation Receipients area of the system, related to a Task record.

\n","_postman_id":"7c1e8447-efda-4c10-aa62-3706c3a77493"},{"name":"List Conversations on Task","id":"afcfb45d-e9ea-49dd-bae6-dee495ee05b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/conversations","description":"

This endpoint retrieves a list of conversations on a task, identified by its unique task_id.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"089205a4-6eb8-4783-878c-a202a2453d7a","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"title\": \"Subject 1\",\n \"message_count\": 1,\n \"model\": \"Tenancy\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Sure!\",\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"modified\": \"2020-04-22T12:03:28+01:00\"\n },\n {\n \"id\": 123,\n \"title\": \"Subject 2\",\n \"message_count\": 1,\n \"model\": \"Tenancy\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Remember to clean on friday.\",\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"modified\": \"2020-04-30T11:49:54+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"afcfb45d-e9ea-49dd-bae6-dee495ee05b7"},{"name":"Add Conversation on Task","id":"0bc53d93-d8ba-4e6e-8c72-1fcc163a22a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/conversations","description":"

Use this endpoint to create a new conversation on a task record. The API will return the saved data and a unique Conversation ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
message	It's done	String	Yes
subject	Meeting tomorrow	String	Yes
person_ids	['1','2']	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"998e4930-f033-4531-b81f-599e2d4c64e5","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"message\":\"Please clean the house on friday.\",\n\t\"subject\":\"House duties\",\n\t\"person_ids\":[\"21\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"House duties\",\n \"message_count\": 1,\n \"model\": \"Tenancy\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 2,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 21,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Please clean the house on friday.\",\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"modified\": \"2020-06-05T15:06:26+01:00\"\n }\n}"}],"_postman_id":"0bc53d93-d8ba-4e6e-8c72-1fcc163a22a8"}],"id":"d7fa4c85-47e1-40a6-91b6-f423ad55c99f","description":"

This section provides resources for dealing with Conversations related to a task.

\n","_postman_id":"d7fa4c85-47e1-40a6-91b6-f423ad55c99f"},{"name":"Assets","item":[{"name":"List Assets on Task","id":"a153ab61-5f55-49db-adf0-5963fbbace01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/assets","description":"

This endpoint retrieves a list of assets associated with the given task ID.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"59a74c95-e81a-4456-ac59-ed3717a0a0a2","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \" Inventory\",\n \"description\": \" Inventory\",\n \"created_by\": {\n \"full_name\": \"Brian Williams\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Inventory\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Inventory\",\n \"model_id\": 123\n },\n {\n \"id\": 123,\n \"model\": \"Tenancy\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-06-23T11:13:02+01:00\",\n \"modified\": \"2020-06-23T11:13:02+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"a153ab61-5f55-49db-adf0-5963fbbace01"},{"name":"View Asset on Task","id":"f9a4e6dc-9a79-4a85-8deb-e851bba628c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/assets/{{asset_id}}","description":"

This API endpoint retrieves the details of a single task asset, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","assets","{{asset_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"93362acb-4a12-472e-9143-e7e95f5924f3","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/assets/{{asset_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \" Inventory\",\n \"description\": \" Inventory\",\n \"created_by\": {\n \"full_name\": \"Brian Williams\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Inventory\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Inventory\",\n \"model_id\": 123\n },\n {\n \"id\": 123,\n \"model\": \"Tenancy\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-06-23T11:13:02+01:00\",\n \"modified\": \"2020-06-23T11:13:02+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"f9a4e6dc-9a79-4a85-8deb-e851bba628c2"}],"id":"1619b94a-295f-471c-a4ab-ab40c729cb05","description":"

This section provides resources for dealing with Assets related to a task.

\n","_postman_id":"1619b94a-295f-471c-a4ab-ab40c729cb05"},{"name":"Tenants","item":[{"name":"List Tenants on Task","id":"8888a4ee-9638-4260-a84b-4ac450372128","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/tenants","description":"

This retrieves a list of tenants related to a task

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","tenants"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"cecf9bb5-c5b8-4802-b485-65b0eb9d7bdc","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/tenants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 116731,\n \"tenancy_id\": 103430,\n \"unit_id\": 80048,\n \"property_id\": 36380,\n \"full_address\": \"orange way, 12 orange ways, London, BA2 3LH\",\n \"status\": \"active\",\n \"invite_code\": null,\n \"reset_password_code\": null,\n \"main_tenant\": true,\n \"title\": \"Mr\",\n \"first_name\": \"API\",\n \"last_name\": \"Support\",\n \"date_of_birth\": \"2002-07-02\",\n \"gender\": \"Male\",\n \"citizen\": \"\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"123 southwood\",\n \"company_address2\": \"hampstead\",\n \"company_city\": \"london\",\n \"company_county\": \"hampstead\",\n \"company_postcode\": \"n5 4rf\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"passport_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_phone_work\": \"\",\n \"kin_mobile\": \"\",\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_county\": \"\",\n \"employment_postcode\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"has_guarantor\": true,\n \"guarantor_first_name\": \"Arthur\",\n \"guarantor_last_name\": \"Guarantor\",\n \"guarantor_date_of_birth\": null,\n \"guarantor_address1\": \"125 lookman\",\n \"guarantor_address2\": \"tottenham\",\n \"guarantor_city\": \"london\",\n \"guarantor_county\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_profession\": \"\",\n \"guarantor_home_owner\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_sort_code\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"move_in_date\": null,\n \"move_out_date\": null,\n \"applicant_note\": \"\",\n \"manager_note\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"Name of House\",\n \"api_name\": \"name_of_house\",\n \"value\": \"\"\n },\n {\n \"name\": \"Company email\",\n \"api_name\": \"company_email\",\n \"value\": \"\"\n },\n {\n \"name\": \"Tenant Rating\",\n \"api_name\": \"tenant_rating\",\n \"value\": \"\"\n }\n ],\n \"latest_credit_score\": \"0\",\n \"latest_credit_description\": \"\",\n \"modified\": \"2019-07-19T12:36:02\",\n \"created\": \"2018-05-29T11:09:18\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"8888a4ee-9638-4260-a84b-4ac450372128"},{"name":"View Tenant on Task","id":"6adeb327-0f77-45b3-96e4-71c4ec11db0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/tenants/{{tenant_id}}","description":"

This API endpoint retrieves the details of a single tenant on a task, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","tenants","{{tenant_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"d754c3c9-877f-4625-b78c-ace889e4b7e5","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/tenants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 116731,\n \"tenancy_id\": 103430,\n \"unit_id\": 80048,\n \"property_id\": 36380,\n \"full_address\": \"orange way, 12 orange ways, London, BA2 3LH\",\n \"status\": \"active\",\n \"invite_code\": null,\n \"reset_password_code\": null,\n \"main_tenant\": true,\n \"title\": \"Mr\",\n \"first_name\": \"API\",\n \"last_name\": \"Support\",\n \"date_of_birth\": \"2002-07-02\",\n \"gender\": \"Male\",\n \"citizen\": \"\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"123 southwood\",\n \"company_address2\": \"hampstead\",\n \"company_city\": \"london\",\n \"company_county\": \"hampstead\",\n \"company_postcode\": \"n5 4rf\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"passport_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_phone_work\": \"\",\n \"kin_mobile\": \"\",\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_county\": \"\",\n \"employment_postcode\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"has_guarantor\": true,\n \"guarantor_first_name\": \"Arthur\",\n \"guarantor_last_name\": \"Guarantor\",\n \"guarantor_date_of_birth\": null,\n \"guarantor_address1\": \"125 lookman\",\n \"guarantor_address2\": \"tottenham\",\n \"guarantor_city\": \"london\",\n \"guarantor_county\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_profession\": \"\",\n \"guarantor_home_owner\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_sort_code\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"move_in_date\": null,\n \"move_out_date\": null,\n \"applicant_note\": \"\",\n \"manager_note\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"Name of House\",\n \"api_name\": \"name_of_house\",\n \"value\": \"\"\n },\n {\n \"name\": \"Company email\",\n \"api_name\": \"company_email\",\n \"value\": \"\"\n },\n {\n \"name\": \"Tenant Rating\",\n \"api_name\": \"tenant_rating\",\n \"value\": \"\"\n }\n ],\n \"latest_credit_score\": \"0\",\n \"latest_credit_description\": \"\",\n \"modified\": \"2019-07-19T12:36:02\",\n \"created\": \"2018-05-29T11:09:18\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"6adeb327-0f77-45b3-96e4-71c4ec11db0f"}],"id":"f9c04b7c-b37e-44fd-8c64-f2d2fa5a39c4","description":"

This section provides resources for dealing with Tenants related to a task.

\n","_postman_id":"f9c04b7c-b37e-44fd-8c64-f2d2fa5a39c4"},{"name":"List Tasks","id":"ff7c0a16-0d76-40d6-845b-80e4275bbbca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks","description":"

This retrieves a list of tasks.

See available filters below to customize the list of tasks returned.

\n","urlObject":{"protocol":"https","path":["v2","tasks"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by task status, which should be provided as a comma-separated list

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by assigned property manager name

\n","type":"text/plain"},"key":"assigned_to","value":""},{"disabled":true,"description":{"content":"

Filters tasks by the due date, starting from the specified date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"created_date_from","value":""},{"disabled":true,"description":{"content":"

Filters tasks by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"created_date_to","value":""},{"disabled":true,"description":{"content":"

Filters tasks by the due date, starting from the specified date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"due_date_from","value":""},{"disabled":true,"description":{"content":"

Filters tasks by the due date, up to the specified date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"due_date_to","value":""},{"disabled":true,"description":{"content":"

Filter tasks by type

\n","type":"text/plain"},"key":"task_type","value":""},{"disabled":true,"description":{"content":"

Filter by tags associated with the tasks, which should be provided as a comma-separated list

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter by a keyword

\n","type":"text/plain"},"key":"_q","value":""}],"variable":[]}},"response":[{"id":"c697410f-7492-4644-824f-e3238745c37e","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks"},"status":"List Tasks","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Need to paint the walls\",\n \"total_subtasks\": 2,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 123,\n \"name\": \"task type\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"http://arthur.localhost/img/xicons/task.svg\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Ryan \"\n },\n \"location\": \"Unit 1, White house , Swan Drive, Nw83AK\",\n \"related_to\": \"Tenancy (TE1111)\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [\n \"http://arthur.localhost/public/..\"\n ],\n \"document_urls\": [\n \"http://arthur.localhost/public/..\"\n ],\n \"tags\": [\n \"one\",\n \"two\"\n ],\n \"api_notes\": \"Note\",\n \"modified\": \"2020-02-24T17:14:54+00:00\",\n \"created\": \"2020-02-24T17:11:34+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"ff7c0a16-0d76-40d6-845b-80e4275bbbca"},{"name":"List Tasks By Status","id":"a2095bc0-1dd9-469f-912f-fbd5b24079f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{status}}","description":"

List all Task with status provided: live, pending, cancelled or completed

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{status}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"4fcbefb7-b5d1-4d78-b300-5f83ef206b1f","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{status_name}}"},"status":"List Tasks By Status","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"live\",\n \"description\": \"Need to paint the walls\",\n \"total_subtasks\": 2,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"\",\n \"related_to\": \"Tenancy (TE1011)\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [\n \"one\",\n \"two\"\n ],\n \"api_notes\": \"Api note\",\n \"modified\": \"2020-02-26T12:19:04+00:00\",\n \"created\": \"2020-02-26T11:24:50+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"a2095bc0-1dd9-469f-912f-fbd5b24079f6"},{"name":"View Task","id":"9b70c53d-8635-4324-a1cf-f56bd8f9d818","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}","description":"

This API endpoint retrieves the details of a single task, identified by its unique task_id.

Use this endpoint to view the specific details of a task.

\n","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"96bd386b-9f91-44ec-b3f7-666f06989766","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}"},"status":"View Task","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"pending\",\n \"description\": \"Please fix the boiler\",\n \"total_subtasks\": 2,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"\",\n \"related_to\": \"Tenancy (TE1111)\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [\n \"one\",\n \"two\"\n ],\n \"api_notes\": \"\",\n \"modified\": \"2020-03-02T11:42:31+00:00\",\n \"created\": \"2020-03-02T11:42:31+00:00\"\n }\n}"}],"_postman_id":"9b70c53d-8635-4324-a1cf-f56bd8f9d818"},{"name":"Update Task","id":"8d0b1e00-bc3f-4c20-b740-4431dc877d91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}","description":"

This endpoint updates an existing task. Any fields that are not provided will not be changed. The API will return the updated data for the task in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
task_type	Inspection	String	No
description	Radiator not working	String	No
tags	['one','two']	Array(String)	No
due_date	2020-10-11	Date	No
due_time	15:32	Time	No
assigned_managers	[123,1234]	Array(Integer)	No
emergency	True	Boolean	No
private	True	Boolean	No
api_notes	Landlord will be present	String	No

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"5cca87d6-9917-40b2-adbe-e49ee3f399d2","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"description\": \"Updated description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}"},"status":"Update Task","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"live\",\n \"description\": \"Updated description\",\n \"total_subtasks\": 2,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"\",\n \"related_to\": \"Tenancy (TE1111)\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [\n \"one\",\n \"two\"\n ],\n \"api_notes\": \"Landlord will be present\",\n \"modified\": \"2020-03-05T10:40:47+00:00\",\n \"created\": \"2020-03-02T11:42:31+00:00\"\n }\n}"}],"_postman_id":"8d0b1e00-bc3f-4c20-b740-4431dc877d91"},{"name":"Update Status On Task","id":"cc0cf4e4-4baa-433a-9979-6afe97ff4aa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/status","description":"

This endpoint updates an existing task status. The API will return the updated data for the task in the response.

Supported Fields

The following fields are supported for the request body
Status must be one of these: live, pending, cancelled, completed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
status	live	String	Yes

","urlObject":{"protocol":"https","path":["v2","tasks","{{task_id}}","status"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"7d56bf71-bb7d-47c0-86b0-cdf5dd7a7cdb","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\":\"live\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}/status"},"status":"Update Status On Task","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"TA123\",\n \"status\": \"live\",\n \"description\": \"\",\n \"total_subtasks\": 2,\n \"completed_subtasks\": 0,\n \"task_type\": {\n \"id\": 0,\n \"name\": \"\",\n \"icon_name\": \"\",\n \"icon_colour\": \"\",\n \"icon_image\": \"\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Author\"\n },\n \"location\": \"\",\n \"related_to\": \"Tenancy (TE1111)\",\n \"due_date\": \"2020-09-22\",\n \"due_time\": \"13:30\",\n \"private\": false,\n \"emergency\": false,\n \"assigned_managers (manager)\": \"Larry Wheels\",\n \"assigned_contractors (manager)\": \"\",\n \"image_urls\": [],\n \"document_urls\": [],\n \"tags\": [],\n \"api_notes\": \"\",\n \"modified\": \"2020-03-05T11:55:40+00:00\",\n \"created\": \"2020-03-02T11:42:31+00:00\"\n }\n}"}],"_postman_id":"cc0cf4e4-4baa-433a-9979-6afe97ff4aa4"},{"name":"Delete Task","id":"04644e05-995a-4789-9949-43593cf87819","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/tasks/{{task_id}}","description":"

This endpoint deletes an existing task using the task id.

Here you can find the full list of endpoints for the Tasks area of the system.

\n","_postman_id":"3a49ae86-0154-4585-8c22-972a2dd5f10d"},{"name":"Subtasks","item":[{"name":"List Subtasks","id":"2601cf64-9e3f-4101-9169-019b9c305520","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/subtasks","description":"

Get all Subtasks

\n","urlObject":{"protocol":"https","path":["v2","subtasks"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"3d04e8d8-1b96-4ba0-a47f-44e9a35d1ea7","name":"Get Subtasks","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/subtasks"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"task_id\": 123,\n \"ref\": \"TA123\",\n \"description\": \"subtask description\",\n \"due_date\": \"2020-11-20\",\n \"completed\": false,\n \"last_updated_by\": {\n \"id\": 123,\n \"full_name\": \"Brian O'Connor\",\n \"action\": \"added\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Brian O'Connor\"\n },\n \"modified\": \"2020-04-10T10:38:12+01:00\",\n \"created\": \"2020-08-10T10:38:12+01:00\"\n },\n {\n \"id\": 132,\n \"task_id\": 132,\n \"ref\": \"TA132\",\n \"description\": \"subtask description\",\n \"due_date\": null,\n \"completed\": false,\n \"last_updated_by\": {\n \"id\": 132,\n \"full_name\": \"Brian O'Connor\",\n \"action\": \"added\"\n },\n \"created_by\": {\n \"id\": 132,\n \"name\": \"Brian O'Connor\"\n },\n \"modified\": \"2020-08-10T10:32:36+01:00\",\n \"created\": \"2020-08-10T10:32:36+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"2601cf64-9e3f-4101-9169-019b9c305520"},{"name":"View Subtask","id":"84434b15-1b15-4564-bb49-d50aea321205","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/subtasks/{{subtask_id}}","description":"

Get Subtask

\n","urlObject":{"protocol":"https","path":["v2","subtasks","{{subtask_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"bf6941b3-aaaa-4c87-85e2-a95322f6d65c","name":"Get Subtask","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/subtasks/{{subtask_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"task_id\": 123,\n \"ref\": \"TA1170\",\n \"description\": \"subtask description\",\n \"due_date\": \"2020-10-20\",\n \"completed\": false,\n \"last_updated_by\": {\n \"id\": 123,\n \"full_name\": \"Brian O'Connor\",\n \"action\": \"added\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Brian O'Connor\"\n },\n \"modified\": \"2020-08-10T10:38:18+01:00\",\n \"created\": \"2020-08-10T10:38:18+01:00\"\n }\n}"}],"_postman_id":"84434b15-1b15-4564-bb49-d50aea321205"},{"name":"Update Subtask","id":"4285baeb-9955-48be-9f19-1c1bf71511c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/subtasks/{{subtask_id}}","description":"

Update Subtask

Supported Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
description	subtask nb1	String	No
due_date	2020-09-22	Date	No
completed	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","subtasks","{{subtask_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"75db559e-383e-4326-a8d7-c64d4f65c8e0","name":"Update Subtask","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\":\"updated description\",\n \"due_date\":\"2020-10-20\",\n \"completed\":\"false\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/subtasks/{{subtask_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"task_id\": 123,\n \"ref\": \"TA1111\",\n \"description\": \"updated description\",\n \"due_date\": \"2020-10-20\",\n \"completed\": false,\n \"last_updated_by\": {\n \"id\": 123,\n \"full_name\": \"Brian O'Connor\",\n \"action\": \"added\"\n },\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Brian O'Connor\"\n },\n \"modified\": \"2020-08-10T10:38:18+01:00\",\n \"created\": \"2020-08-10T10:38:18+01:00\"\n }\n}"}],"_postman_id":"4285baeb-9955-48be-9f19-1c1bf71511c3"},{"name":"Delete Subtask","id":"7ce6565c-f385-4876-972e-e775b4043c8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/subtasks/{{subtask_id}}","description":"

Delete Subtask

\n","urlObject":{"protocol":"https","path":["v2","subtasks","{{subtask_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"594213ef-ca25-4dcd-99a2-fde078867755","name":"Delete Subtask","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\":\"updated description\",\n \"due_date\":\"2020-10-20\",\n \"completed\":\"false\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/subtasks/{{subtask_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"7ce6565c-f385-4876-972e-e775b4043c8e"}],"id":"36529887-0928-4fe1-9c21-5fabefc8f9af","description":"

Here you can find the full list of endpoints for the Subtasks area of the system.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"47cc37f2-5962-4600-b688-592979929569"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b74fa364-caec-4402-80c6-8a6ba9b477db"}}],"_postman_id":"36529887-0928-4fe1-9c21-5fabefc8f9af"},{"name":"Workorders","item":[{"name":"Transactions","item":[{"name":"List Transactions On Workorder","id":"7d24e7c1-c688-480a-b66d-ccf8de57d81d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/transactions","description":"

This retrieves a list of transactions for a Workorder.

See available filters below to customize the list of transactions returned.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","transactions"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"statement","value":""},{"disabled":true,"description":{"content":"

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.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"date_from","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"date_to","value":""}],"variable":[]}},"response":[{"id":"b63e4570-0a0b-4ed7-af7c-f85f5ae5d3c9","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/transactions"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ref\": \"TR007\",\n \"transaction_type\": \"Registered Deposit Charge\",\n \"payment_type\": \"charge\",\n \"description\": \"Registered Deposit\",\n \"property_id\": 11,\n \"unit_id\": 22,\n \"tenancy_id\": 123,\n \"payee_group_id\": 10,\n \"invoice_ref\": \"\",\n \"payee_tenant_id\": 44,\n \"amount\": \"1500.00\",\n \"amount_charged\": \"1500.00\",\n \"amount_paid\": \"0.00\",\n \"amount_outstanding\": \"1500.00\",\n \"amount_net\": \"1500.00\",\n \"vat_code_id\": 4,\n \"source\": \"arthur\",\n \"created_by\": {\n \"id\": 11,\n \"full_name\": \"Brian Brown\"\n },\n \"payee_name\": \"Thomas Smith\",\n \"payee_person_id\": null,\n \"payee_entity_id\": 0,\n \"date\": \"2020-06-25\",\n \"due_date\": \"2020-06-25\",\n \"modified\": \"2020-06-25T15:35:01+01:00\",\n \"created\": \"2020-06-25T15:35:01+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"7d24e7c1-c688-480a-b66d-ccf8de57d81d"}],"id":"46297b0d-2eb8-4073-bd40-598ebb429a09","description":"

This section provides resources for dealing with Transactions related to a workorder.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4590b4fa-7bda-4d45-bc7e-71c8adaa07ce"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"cf08266c-28b4-42cd-8c29-149a7de833d7"}}],"_postman_id":"46297b0d-2eb8-4073-bd40-598ebb429a09"},{"name":"Certificates","item":[{"name":"List Certificates On Workorder","id":"98495d83-7563-473f-b3a3-1fc8f08145a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/certificates","description":"

This endpoint retrieves a list of certificates associated with the given workorder ID.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","certificates"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a6a70846-3217-4975-bc1c-cc32eb016197","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/certificates"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 12345,\n \"type\": \"Gas Safety\",\n \"expiry_date\": \"2021-06-06\",\n \"status\": \"Expired\",\n \"missing\": false,\n \"file\": {\n \"id\": 12345,\n \"download_url\": \"https://asset.arthuronline.co.uk/download/{uuid}\",\n \"mime_type\": \"image/jpeg\"\n },\n \"property\": {\n \"id\": 1234,\n \"address\": \"Multiple Unit Property, test, ABC 123\"\n },\n \"unit\": {\n \"id\": 123,\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"tenancy\": {\n \"id\": 123456,\n \"ref\": \"TE1000\",\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"notes\": \"My Certificate Notes\",\n \"share_manager\": true,\n \"share_tenant\": false,\n \"share_contractor\": true,\n \"share_owner\": false,\n \"created\": \"2021-01-01T12:00:00\",\n \"modified\": \"2021-01-01T12:00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"98495d83-7563-473f-b3a3-1fc8f08145a1"}],"id":"8da01efe-19a2-48e2-a21b-ca9198ff8e14","description":"

This section provides resources for dealing with Certificates related to a workorder.

\n","_postman_id":"8da01efe-19a2-48e2-a21b-ca9198ff8e14"},{"name":"Quotes","item":[{"name":"List Quotes On Workorder","id":"4600249e-9e4c-4c66-af9e-fffd462d3804","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/quotes","description":"

This endpoint retrieves a list of quotes associated with the given Workorder ID.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","quotes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"50b00975-afa1-4cc2-967a-b97d75e1517f","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorder/{{workorder_id}}/quotes"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"workorder_id\": 123,\n \"description\": \"Quote description\",\n \"amount\": \"150.00\",\n \"status\": \"accept\",\n \"quote_required\": false,\n \"owner_approval_required\": false,\n \"quote_accepted\": true,\n \"accepted_date\": \"2020-09-07\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Jackson\"\n },\n \"workorder\": {\n \"id\": 123,\n \"ref\": \"WO007\",\n \"title\": \"Workorder title\"\n },\n \"contractor\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Jackson\",\n \"status\": \"live\"\n },\n \"modified\": \"2020-09-07T15:38:18+01:00\",\n \"created\": \"2020-09-07T15:09:55+01:00\"\n },\n {\n \"id\": 123,\n \"workorder_id\": 123,\n \"description\": \"Quote description\",\n \"amount\": \"1230.00\",\n \"status\": \"pending\",\n \"quote_required\": true,\n \"owner_approval_required\": false,\n \"quote_accepted\": true,\n \"accepted_date\": null,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Michael Clifford\"\n },\n \"workorder\": {\n \"id\": 141166,\n \"ref\": \"WO1046\",\n \"title\": \"awaiting quote\"\n },\n \"contractor\": {\n \"id\": 123,\n \"full_name\": \"Michael Clifford\",\n \"status\": \"accepted\"\n },\n \"modified\": \"2020-08-07T12:20:35+01:00\",\n \"created\": \"2020-08-03T09:15:47+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"4600249e-9e4c-4c66-af9e-fffd462d3804"},{"name":"View Quote On Workorder","id":"7cc1a5f5-7b1c-426c-8902-771ab368402e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/quotes/{{quote_id}}","description":"

This API endpoint retrieves the details of a single quote, identified by its unique quote_id.

Use this endpoint to view the specific details of a quote on a workorder.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","quotes","{{quote_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"6fee56b4-aecb-4608-89db-b937f9d5245f","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/quotes/{{quote_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"workorder_id\": 123,\n \"description\": \"Quote description\",\n \"amount\": \"150.00\",\n \"status\": \"accept\",\n \"quote_required\": false,\n \"owner_approval_required\": false,\n \"quote_accepted\": true,\n \"accepted_date\": \"2020-09-07\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Jackson\"\n },\n \"workorder\": {\n \"id\": 123,\n \"ref\": \"WO007\",\n \"title\": \"Workorder title\"\n },\n \"contractor\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Jackson\",\n \"status\": \"live\"\n },\n \"modified\": \"2020-09-07T15:38:18+01:00\",\n \"created\": \"2020-09-07T15:09:55+01:00\"\n }\n}\n"}],"_postman_id":"7cc1a5f5-7b1c-426c-8902-771ab368402e"}],"id":"122ca5b6-d3c5-4736-af8f-d22858b7198c","description":"

This section provides resources for dealing with Quotes related to a workorder.

\n","_postman_id":"122ca5b6-d3c5-4736-af8f-d22858b7198c"},{"name":"Invoices","item":[{"name":"List Invoices On Workorder","id":"1f93f52a-ba28-48a2-a3f2-158346e4aa8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/invoices","description":"

This endpoint retrieves a list of contractor invoices associated with the given Workorder ID.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","invoices"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"230c4fbe-e42b-4b68-a3b7-9ae3cc4587eb","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorder/{{workorder_id}}/invoices"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"workorder_id\": 123,\n \"ref\": \"W0/000\",\n \"status\": \"unpaid\",\n \"location\": \"Property address\",\n \"amount\": \"1476.00\",\n \"amount_paid\": \"0.00\",\n \"amount_outstanding\": \"1476.00\",\n \"amount_vat\": \"246.00\",\n \"vat_percentage\": \"20.00\",\n \"paid_date\": null,\n \"submitted\": true,\n \"submitted_date\": \"2020-04-07T13:51:11+01:00\",\n \"completed_date\": null,\n \"invoice_items\": [\n {\n \"id\": 123,\n \"name\": \"Item name\",\n \"description\": \"Item description\",\n \"amount\": \"1230.00\",\n \"quantity\": 1\n }\n ],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Zoltan Chivay\"\n },\n \"workorder\": {\n \"id\": 123,\n \"ref\": \"WO000\",\n \"title\": \"Workorder title\"\n },\n \"contractor\": {\n \"id\": 123,\n \"full_name\": \"Zoltan Chivay\",\n \"status\": \"live\"\n },\n \"created\": \"2020-08-07T15:50:39+01:00\",\n \"modified\": \"2020-09-04T15:23:55+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"1f93f52a-ba28-48a2-a3f2-158346e4aa8a"},{"name":"View Invoice On Workorder","id":"77313105-6128-4e47-bf76-7cd4a26a2b70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/invoices/{{invoice_id}}","description":"

This API endpoint retrieves the details of a single invoice, identified by its unique invoice_id.

Use this endpoint to view the specific details of a contractor invoice on a workorder.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","invoices","{{invoice_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"4bb7206d-8fbb-4b4e-a6b3-aa249125f985","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/invoices/{{invoice_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"workorder_id\": 123,\n \"ref\": \"W0/000\",\n \"status\": \"unpaid\",\n \"location\": \"Property address\",\n \"amount\": \"1476.00\",\n \"amount_paid\": \"0.00\",\n \"amount_outstanding\": \"1476.00\",\n \"amount_vat\": \"246.00\",\n \"vat_percentage\": \"20.00\",\n \"paid_date\": null,\n \"submitted\": true,\n \"submitted_date\": \"2020-04-07T13:51:11+01:00\",\n \"completed_date\": null,\n \"invoice_items\": [\n {\n \"id\": 123,\n \"name\": \"Item name\",\n \"description\": \"Item description\",\n \"amount\": \"1230.00\",\n \"quantity\": 1\n }\n ],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Zoltan Chivay\"\n },\n \"workorder\": {\n \"id\": 123,\n \"ref\": \"WO000\",\n \"title\": \"Workorder title\"\n },\n \"contractor\": {\n \"id\": 123,\n \"full_name\": \"Zoltan Chivay\",\n \"status\": \"live\"\n },\n \"created\": \"2020-08-07T15:50:39+01:00\",\n \"modified\": \"2020-09-04T15:23:55+01:00\"\n }\n}"}],"_postman_id":"77313105-6128-4e47-bf76-7cd4a26a2b70"}],"id":"30b777ba-f241-4bec-93ef-1d539c76d2ad","description":"

This section provides resources for dealing with Invoices related to a workorder.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8610ae82-98b4-423a-a90c-901b8348d344"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"27ae6f38-5077-412a-baa2-01d508fb94e2"}}],"_postman_id":"30b777ba-f241-4bec-93ef-1d539c76d2ad"},{"name":"Assets","item":[{"name":"List Assets on Workorder","id":"ed43e4de-a4e7-49c6-9f45-e023263f0e01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/assets","description":"

This endpoint retrieves a list of assets associated with the given workorder ID.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"981f3072-4cc3-4e19-9ad9-f90210372246","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \" Inventory\",\n \"description\": \" Inventory\",\n \"created_by\": {\n \"full_name\": \"Brian Williams\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Inventory\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Inventory\",\n \"model_id\": 123\n },\n {\n \"id\": 123,\n \"model\": \"Tenancy\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-06-23T11:13:02+01:00\",\n \"modified\": \"2020-06-23T11:13:02+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"ed43e4de-a4e7-49c6-9f45-e023263f0e01"},{"name":"View Asset on Workorder","id":"a536dff9-19f0-4d89-bbaf-c8aeddeb9db0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/assets/{edge_id}","description":"

This API endpoint retrieves the details of a single asset, identified by its unique asset_id.

Use this endpoint to view the specific details of an asset on a workorder.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","assets","{edge_id}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"4d0829e6-e95f-4ab3-851e-d3e81113b138","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/assets/{{asset_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \" Inventory\",\n \"description\": \" Inventory\",\n \"created_by\": {\n \"full_name\": \"Brian Williams\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Inventory\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Inventory\",\n \"model_id\": 123\n },\n {\n \"id\": 123,\n \"model\": \"Tenancy\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-06-23T11:13:02+01:00\",\n \"modified\": \"2020-06-23T11:13:02+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"a536dff9-19f0-4d89-bbaf-c8aeddeb9db0"},{"name":"Create Asset on Workorder","id":"572f19e7-09f1-45a3-a8e9-cb185a2888dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/assets","description":"

Use this endpoint to create a new asset related to an workorder. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
asset_type	image	String	No
name	inventory	String	No
share_manager	true	Boolean	No
share_tenant	false	Boolean	No
share_contractor	true	Boolean	No
share_owner	true	Boolean	No
file	base64	String	Yes
mime_type	application/pdf	String	Yes
file_name	inventory	String	Yes

","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a298baae-e5e0-4087-af44-b11a3651230c","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset_type\":\"image\",\n\t\"name\":\"name of asset\",\n\t\"share_manager\":true,\n\t\"share_tenant\":true,\n\t\"share_owner\":true,\n\t\"share_contractor\":true,\n\t\"file\":\"pdf file converted to base64 string\",\n\t\"mime_type\":\"application/pdf\",\n\t\"file_name\":\"inventory\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"name of asset\",\n \"description\": null,\n \"created_by\": {\n \"full_name\": \"Brian Wilson\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Image\",\n \"share_manager\": true,\n \"share_owner\": true,\n \"share_tenant\": true,\n \"share_contractor\": true,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 123,\n \"model\": \"Tenancy\",\n \"model_id\": 123\n }\n ],\n \"created\": \"2020-07-03T09:25:52+01:00\",\n \"modified\": \"2020-07-03T09:25:52+01:00\"\n }\n}"}],"_postman_id":"572f19e7-09f1-45a3-a8e9-cb185a2888dd"}],"id":"064b0505-3bba-47d8-aa2b-2028af6c3695","description":"

This section provides resources for dealing with Assets related to a workorder.

\n","_postman_id":"064b0505-3bba-47d8-aa2b-2028af6c3695"},{"name":"Conversations","item":[{"name":"Conversation Recipients","item":[{"name":"Get Recipients for Workorder","id":"0869d42b-c6b1-435e-ad72-f8fa8dec5a7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/conversation_recipients","description":"

This endpoint retrieves a list of conversation recipients on a workorder record, identified by its unique workorder_id.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","conversation_recipients"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"98c1a5f5-cfbf-487d-91e8-6114c20b4d83","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/conversation_recipients"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Henry\",\n \"last_name\": \"Williams\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 2,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Managers\",\n \"first_name\": \"Mike\",\n \"last_name\": \"Marky\",\n \"group\": \"manager\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 3,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Tenants\",\n \"first_name\": \"Josh\",\n \"last_name\": \"Jackson\",\n \"group\": \"tenant\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 4,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Tenants\",\n \"first_name\": \"Brian\",\n \"last_name\": \"Shaw\",\n \"group\": \"tenant\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:10:02+01:00\",\n \"modified\": \"2020-06-29T14:10:02+01:00\"\n },\n {\n \"id\": 5,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Guarantors\",\n \"first_name\": \"Jason\",\n \"last_name\": \"Doe\",\n \"group\": \"guarantor\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:28:56+01:00\",\n \"modified\": \"2020-06-29T14:28:56+01:00\"\n },\n {\n \"id\": 6,\n \"ident\": \"fffafdd304f\",\n \"title\": \"Property Owner\",\n \"first_name\": \"Leon\",\n \"last_name\": \"Silva\",\n \"group\": \"owner\",\n \"unit_ref\": \"\",\n \"default\": false,\n \"locked\": false,\n \"created\": \"2020-06-29T14:28:56+01:00\",\n \"modified\": \"2020-06-29T14:28:56+01:00\"\n }\n ]\n}"}],"_postman_id":"0869d42b-c6b1-435e-ad72-f8fa8dec5a7e"}],"id":"7eb083b2-4440-4709-8db0-1d3da41b7bab","description":"

Here you can find the full list of endpoints for the Conversation Receipients area of the system, related to a Workorder record.

\n","_postman_id":"7eb083b2-4440-4709-8db0-1d3da41b7bab"},{"name":"List Conversations on Workorder","id":"210168bb-42ea-45ef-98e5-7b8d37fb4e83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/conversations","description":"

This endpoint retrieves a list of conversations on a workorder, identified by its unique workorder_id.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"27abfb6c-2a8d-43e1-b75d-05a71d0cb4c4","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"title\": \"Subject 1\",\n \"message_count\": 1,\n \"model\": \"Tenancy\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Sure!\",\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"modified\": \"2020-04-22T12:03:28+01:00\"\n },\n {\n \"id\": 123,\n \"title\": \"Subject 2\",\n \"message_count\": 1,\n \"model\": \"Tenancy\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Remember to clean on friday.\",\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"modified\": \"2020-04-30T11:49:54+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"210168bb-42ea-45ef-98e5-7b8d37fb4e83"},{"name":"Create Conversation on Workorder","id":"5a99be7a-1161-4ec5-9aa4-264c90c08e65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/conversations","description":"

Use this endpoint to create a new conversation on a workorder record. The API will return the saved data and a unique Conversation ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
message	It's done	String	Yes
subject	Meeting tomorrow	String	Yes
person_ids	['1','2']	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","conversations"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"f38918a6-3d5b-4c32-b7c5-1420a400bd8e","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"message\":\"Please clean the house on friday.\",\n\t\"subject\":\"House duties\",\n\t\"person_ids\":[\"21\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/conversations"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"House duties\",\n \"message_count\": 1,\n \"model\": \"Tenancy\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 2,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 21,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Please clean the house on friday.\",\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"full_name\": \"Ronnie Wilson\",\n \"sent_by_me\": true\n },\n \"created\": \"2020-06-05T15:06:26+01:00\",\n \"modified\": \"2020-06-05T15:06:26+01:00\"\n }\n}"}],"_postman_id":"5a99be7a-1161-4ec5-9aa4-264c90c08e65"}],"id":"5a3cb5b7-abba-48eb-983b-6576c7d626f9","description":"

This section provides resources for dealing with Conversations related to a workorder.

\n","_postman_id":"5a3cb5b7-abba-48eb-983b-6576c7d626f9"},{"name":"Notes","item":[{"name":"List Notes on Workorder","id":"60803195-a886-4fad-b4a1-a432ebfedfab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/notes","description":"

This endpoint retrieves a list of notes associated with the given workorder ID.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"2aca9a90-3db8-4048-9bda-b6594135271a","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/notes"},"status":"List Notes On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\"last_edited_by\": {\n \t\"id\": null,\n \t\"full_name\": null\n \t},\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \t\"modified\": \"2020-05-28T11:57:55+01:00\"\n },\n {\n \"id\": 1234,\n \"content\": \"Remember this note , please\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\"last_edited_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \t\"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n"}],"_postman_id":"60803195-a886-4fad-b4a1-a432ebfedfab"},{"name":"View Note on Workorder","id":"6862bfe3-3165-4c06-af46-3d8f27463a1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/notes/{edge_id}","description":"

This API endpoint retrieves the details of a single workorder note, identified by its unique id

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","notes","{edge_id}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"56ffb982-08d9-456f-b0e0-448e2abddfbc","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/notes/{{note_id}}"},"status":"View Note On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Interesting\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}\n"}],"_postman_id":"6862bfe3-3165-4c06-af46-3d8f27463a1b"},{"name":"Add Note on Workorder","id":"10a5fdfc-a9ef-4798-8fd1-804ecf97577c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/notes","description":"

Use this endpoint to create a new note record for a workorder. The API will return the saved data and a unique note ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	Yes
tags	['one','two']	Array(String)	No

","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"21da589e-af63-4d43-8d3c-08f10e1e69bf","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\":\"Remember this note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/notes"},"status":"Add Note On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": null,\n \"full_name\": null\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [\n {\n \"id\": 123,\n \"name\": \"one\"\n },\n {\n \"id\": 1234,\n \"name\": \"two\"\n }\n ],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"10a5fdfc-a9ef-4798-8fd1-804ecf97577c"},{"name":"Update Note on Workorder","id":"12cb2c06-2913-45d0-94dc-6da01678ec2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/notes/{{note_id}}","description":"

This endpoint updates an existing note on a workorder using the same fields as the 'Add Note' endpoint. The API will return the updated data for the note in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	No
tags	['one','two']	Array(String)	No

","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e8abf71f-ec09-40f8-b09c-6e4a513c662e","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"content\":\"Updated Note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/notes/{{note_id}}"},"status":"Update Note On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Updated Note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-04-20T11:59:42+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}\n"}],"_postman_id":"12cb2c06-2913-45d0-94dc-6da01678ec2e"},{"name":"Delete Note on Workorder","id":"0f34f9b2-52cd-4c1a-9412-1ea2a27f1b92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/notes/{{note_id}}","description":"

This endpoint deletes an existing workorder note using the note id.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"aaec2254-03ae-4c67-947c-480be6d21a12","name":"Example","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/notes/{{note_id}}"},"status":"Delete Note On Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"0f34f9b2-52cd-4c1a-9412-1ea2a27f1b92"}],"id":"e4e4ed16-a047-4917-b3cc-a09d3d6612be","description":"

This section provides resources for dealing with Notes related to a workorder.

\n","_postman_id":"e4e4ed16-a047-4917-b3cc-a09d3d6612be"},{"name":"Tags","item":[{"name":"List Tags on Workorder","id":"1f16d30f-1996-4406-a79a-23734810a86c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/tags","description":"

This endpoint retrieves a list of tags associated with the given Workorder ID.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"d91cf268-c841-4dda-88af-0f92baa0b62f","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"tag one\",\n \"color\": \"sky\"\n },\n {\n \"id\": 123,\n \"name\": \"tag two\",\n \"color\": \"lightgreen\"\n },\n {\n \"id\": 123,\n \"name\": \"tag three\",\n \"color\": \"purple\"\n }\n ]\n}"}],"_postman_id":"1f16d30f-1996-4406-a79a-23734810a86c"},{"name":"Tag Workorder","id":"0f65d0cc-94e3-4976-93d0-c3c698125271","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/tags","description":"

Use this endpoint to create a new tag record for a workorder. The API will return the saved data and a unique tag ID.

Supported Fields

The following fields are supported for the request body
Tag field should be a valid tag ID or name.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	[\"123\"]	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"05970b28-785d-473f-84eb-f73648608d6a","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":[\"1234\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/tags"},"status":"Tag Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1234,\n \"name\": \"Tag one\",\n \"color\": \"orange\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 12,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"0f65d0cc-94e3-4976-93d0-c3c698125271"},{"name":"Untag Workorder","id":"bc3c583d-ff36-496c-a041-5b0c4ebc5c9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/untag","description":"

Use this endpoint to unassign tag record from a workorder. The API will return the saved data. Tag field should be a valid tag ID or name.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	\"1234\"	String	Yes

","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","untag"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"704a6f6e-2bb3-4968-8299-1a9bae938be3","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":\"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/untag"},"status":"Untag Tenancy","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"bc3c583d-ff36-496c-a041-5b0c4ebc5c9e"},{"name":"Untag All Workorder Tags","id":"d60f36b8-3707-4bad-9e3f-f86042a15289","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/untag_all","description":"

Use this endpoint to unassign all tags from the workorder.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","untag_all"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b61eb200-3f7c-4b2a-9831-1d4d752f06be","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/untag_all"},"status":"Untag All Tenancy Tags","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"d60f36b8-3707-4bad-9e3f-f86042a15289"}],"id":"2d2defe7-3f57-4ed3-88b8-c7454cbef55b","description":"

This section provides resources for dealing with Tags related to a workorder.

\n","_postman_id":"2d2defe7-3f57-4ed3-88b8-c7454cbef55b"},{"name":"Contractors","item":[{"name":"List Contractors on Workorder","id":"e1f83b6a-2223-45e4-b638-6508cb45625f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/contractors","description":"

This endpoint retrieves a list of contractors associated with the given workorder ID.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","contractors"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e7f28ed3-be0c-410a-b4fa-aba898407791","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/contractors"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 574490,\n \"entity_id\": 85085,\n \"title\": \"Mr\",\n \"name\": \"API Support\",\n \"address\": \"32 Temple Fortune Lane, Picardy Road, London, Lancashire, SN4 7AB\",\n \"address_line_1\": \"32 Temple Fortune Lane\",\n \"address_line_2\": \"Picardy Road\",\n \"city\": \"London\",\n \"county\": \"Lancashire\",\n \"country\": \"\",\n \"postcode\": \"SN4 7AB\",\n \"website\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"phone_mobile\": \"\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"status\": \"pending\",\n \"company\": \"API Support\",\n \"vat_no\": \"\",\n \"contacts\": [\n {\n \"person_id\": 437322,\n \"title\": \"Mr\",\n \"name\": \"API Support\",\n \"main_contact\": true,\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"registration_status\": \"active\"\n }\n ],\n \"tags\": [],\n \"modified\": \"2022-02-22T16:31:21\",\n \"created\": \"2019-10-23T11:45:48\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"e1f83b6a-2223-45e4-b638-6508cb45625f"},{"name":"View Contractor on Workorder","id":"f6bea133-c45d-418a-bf7f-8b7a76afb8bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/contractors/{{contractor_id}}","description":"

This API endpoint retrieves the details of a single workorder, identified by its unique workorder_id.

Use this endpoint to view the specific details of a workorder.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","contractors","{{contractor_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"358d9a1b-3fbe-4a2a-8af7-76a2bbf124de","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/contractors/{{contractor_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 574490,\n \"entity_id\": 85085,\n \"title\": \"Mr\",\n \"name\": \"API Support\",\n \"address\": \"32 Temple Fortune Lane, Picardy Road, London, Lancashire, SN4 7AB\",\n \"address_line_1\": \"32 Temple Fortune Lane\",\n \"address_line_2\": \"Picardy Road\",\n \"city\": \"London\",\n \"county\": \"Lancashire\",\n \"country\": \"\",\n \"postcode\": \"SN4 7AB\",\n \"website\": \"\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"phone_mobile\": \"\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"status\": \"pending\",\n \"company\": \"API Support\",\n \"vat_no\": \"\",\n \"contacts\": [\n {\n \"person_id\": 437322,\n \"title\": \"Mr\",\n \"name\": \"API Support\",\n \"main_contact\": true,\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"registration_status\": \"active\"\n }\n ],\n \"tags\": [],\n \"modified\": \"2022-02-22T16:31:21\",\n \"created\": \"2019-10-23T11:45:48\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"f6bea133-c45d-418a-bf7f-8b7a76afb8bf"},{"name":"Delete Contractor on Workorder","id":"dd2e08c2-d79f-47ad-9a2b-12dc5df3013b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/contractors/{{contractor_id}}","description":"

This endpoint deletes an existing contractor related to the workorder using the contractor id.

This section provides resources for dealing with Contractors related to a workorder.

\n","_postman_id":"40b3f82a-61f7-42ed-aca8-61cf5363b6eb"},{"name":"Tenants","item":[{"name":"List Tenants on Workorder","id":"53bb134a-8350-41fa-8b00-0e51316f281f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/tenants","description":"

This endpoint retrieves a list of tenants associated with the given workorder ID.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","tenants"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"3803f4a0-cbd1-4fc8-a663-0b5dfd0b1234","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/tenants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 116731,\n \"tenancy_id\": 103430,\n \"unit_id\": 80048,\n \"property_id\": 36380,\n \"full_address\": \"orange way, 12 orange ways, London, BA2 3LH\",\n \"status\": \"active\",\n \"invite_code\": null,\n \"reset_password_code\": null,\n \"main_tenant\": true,\n \"title\": \"Mr\",\n \"first_name\": \"API\",\n \"last_name\": \"Support\",\n \"date_of_birth\": \"2002-07-02\",\n \"gender\": \"Male\",\n \"citizen\": \"\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"123 southwood\",\n \"company_address2\": \"hampstead\",\n \"company_city\": \"london\",\n \"company_county\": \"hampstead\",\n \"company_postcode\": \"n5 4rf\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"passport_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_phone_work\": \"\",\n \"kin_mobile\": \"\",\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_county\": \"\",\n \"employment_postcode\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"has_guarantor\": true,\n \"guarantor_first_name\": \"Arthur\",\n \"guarantor_last_name\": \"Guarantor\",\n \"guarantor_date_of_birth\": null,\n \"guarantor_address1\": \"125 lookman\",\n \"guarantor_address2\": \"tottenham\",\n \"guarantor_city\": \"london\",\n \"guarantor_county\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_profession\": \"\",\n \"guarantor_home_owner\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_sort_code\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"move_in_date\": null,\n \"move_out_date\": null,\n \"applicant_note\": \"\",\n \"manager_note\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"Name of House\",\n \"api_name\": \"name_of_house\",\n \"value\": \"\"\n },\n {\n \"name\": \"Company email\",\n \"api_name\": \"company_email\",\n \"value\": \"\"\n },\n {\n \"name\": \"Tenant Rating\",\n \"api_name\": \"tenant_rating\",\n \"value\": \"\"\n }\n ],\n \"latest_credit_score\": \"0\",\n \"latest_credit_description\": \"\",\n \"modified\": \"2019-07-19T12:36:02\",\n \"created\": \"2018-05-29T11:09:18\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"53bb134a-8350-41fa-8b00-0e51316f281f"},{"name":"View Tenant on Workorder","id":"da1a70c4-637b-4121-bb7c-08066f59ad7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/tenants/{{tenant_id}}","description":"

This API endpoint retrieves the details of a single tenant on a workorder, identified by its unique tenant_id.

Use this endpoint to view the specific details of a tenant on a workorder.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}","tenants","{{tenant_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"c6a69fa9-5201-4128-888a-50e4802ba714","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}/tenants/{{tenant_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 116731,\n \"tenancy_id\": 103430,\n \"unit_id\": 80048,\n \"property_id\": 36380,\n \"full_address\": \"orange way, 12 orange ways, London, BA2 3LH\",\n \"status\": \"active\",\n \"invite_code\": null,\n \"reset_password_code\": null,\n \"main_tenant\": true,\n \"title\": \"Mr\",\n \"first_name\": \"API\",\n \"last_name\": \"Support\",\n \"date_of_birth\": \"2002-07-02\",\n \"gender\": \"Male\",\n \"citizen\": \"\",\n \"email\": \"email-example@arthuronline.co.uk\",\n \"company_name\": \"\",\n \"company_address_name\": \"\",\n \"company_address1\": \"123 southwood\",\n \"company_address2\": \"hampstead\",\n \"company_city\": \"london\",\n \"company_county\": \"hampstead\",\n \"company_postcode\": \"n5 4rf\",\n \"company_country\": \"United Kingdom\",\n \"phone_home\": \"\",\n \"phone_work\": \"\",\n \"mobile\": \"\",\n \"passport_number\": \"\",\n \"visa_number\": \"\",\n \"visa_years\": \"\",\n \"visa_type\": \"\",\n \"country_of_origin\": \"\",\n \"ni_number\": \"\",\n \"kin_first_name\": \"\",\n \"kin_last_name\": \"\",\n \"kin_phone_work\": \"\",\n \"kin_mobile\": \"\",\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_county\": \"\",\n \"employment_postcode\": \"\",\n \"employment_contact_name\": \"\",\n \"employment_contact_number\": \"\",\n \"employment_salary\": \"\",\n \"employment_length\": \"\",\n \"housing_benefit_council\": \"\",\n \"housing_benefit_number\": \"\",\n \"has_guarantor\": true,\n \"guarantor_first_name\": \"Arthur\",\n \"guarantor_last_name\": \"Guarantor\",\n \"guarantor_date_of_birth\": null,\n \"guarantor_address1\": \"125 lookman\",\n \"guarantor_address2\": \"tottenham\",\n \"guarantor_city\": \"london\",\n \"guarantor_county\": \"\",\n \"guarantor_postcode\": \"\",\n \"guarantor_country\": \"\",\n \"guarantor_phone_home\": \"\",\n \"guarantor_phone_work\": \"\",\n \"guarantor_mobile\": \"\",\n \"guarantor_email\": \"\",\n \"guarantor_relation\": \"\",\n \"guarantor_profession\": \"\",\n \"guarantor_home_owner\": \"\",\n \"bank_name\": \"\",\n \"bank_address1\": \"\",\n \"bank_address2\": \"\",\n \"bank_city\": \"\",\n \"bank_county\": \"\",\n \"bank_postcode\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_sort_code\": \"\",\n \"ref_name\": \"\",\n \"ref_address1\": \"\",\n \"ref_address2\": \"\",\n \"ref_city\": \"\",\n \"ref_county\": \"\",\n \"ref_postcode\": \"\",\n \"ref_contact_number\": \"\",\n \"ref_relation\": \"\",\n \"move_in_date\": null,\n \"move_out_date\": null,\n \"applicant_note\": \"\",\n \"manager_note\": \"\",\n \"custom_fields\": [\n {\n \"name\": \"Name of House\",\n \"api_name\": \"name_of_house\",\n \"value\": \"\"\n },\n {\n \"name\": \"Company email\",\n \"api_name\": \"company_email\",\n \"value\": \"\"\n },\n {\n \"name\": \"Tenant Rating\",\n \"api_name\": \"tenant_rating\",\n \"value\": \"\"\n }\n ],\n \"latest_credit_score\": \"0\",\n \"latest_credit_description\": \"\",\n \"modified\": \"2019-07-19T12:36:02\",\n \"created\": \"2018-05-29T11:09:18\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"da1a70c4-637b-4121-bb7c-08066f59ad7d"}],"id":"4002b4d2-8fa9-4fad-b175-831bf2e1d5ad","description":"

This section provides resources for dealing with Tenants related to a workorder.

\n","_postman_id":"4002b4d2-8fa9-4fad-b175-831bf2e1d5ad"},{"name":"List Workorders","id":"84189d1b-7a08-4e3a-81cd-ece87b4fc236","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders","description":"

This retrieves a list of workorders.

See available filters below to customize the list of workorders returned.

\n","urlObject":{"protocol":"https","path":["v2","workorders"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter workorder by id

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter workorders by workorder reference number

\n","type":"text/plain"},"key":"ref","value":""},{"disabled":true,"description":{"content":"

Filter by workorder status (overdue, pending, live, completed, cancelled, onHold)

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter workorders by title

\n","type":"text/plain"},"key":"title","value":""},{"disabled":true,"description":{"content":"

Filter workorders by description

\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"

Filter by workorder service type

\n","type":"text/plain"},"key":"service_type","value":""},{"disabled":true,"description":{"content":"

Filters workorders by the start date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Filters workorders by the due date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"due_date","value":""},{"disabled":true,"description":{"content":"

Filters workorders by the contractor accepted date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"contractor_accepted_date","value":""},{"disabled":true,"description":{"content":"

Filter status by emergency status (Boolean)

\n","type":"text/plain"},"key":"emergency","value":""},{"disabled":true,"description":{"content":"

Filter workorders by budget

\n","type":"text/plain"},"key":"budget","value":""},{"disabled":true,"description":{"content":"

Filter by allocated time

\n","type":"text/plain"},"key":"allocated_time_hours","value":""},{"disabled":true,"description":{"content":"

Filter by actual time spent

\n","type":"text/plain"},"key":"actual_time_hours","value":""},{"disabled":true,"description":{"content":"

Filter by workorder price per hour

\n","type":"text/plain"},"key":"price_per_hour","value":""},{"disabled":true,"description":{"content":"

Filters workorders by the created date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"created","value":""},{"disabled":true,"description":{"content":"

Filters workorders by the modified date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"modified","value":""},{"disabled":true,"description":{"content":"

Filter by quote required status (Boolean)

\n","type":"text/plain"},"key":"quote_required","value":""},{"disabled":true,"description":{"content":"

Filter by assigned contractor

\n","type":"text/plain"},"key":"contractor","value":""},{"disabled":true,"description":{"content":"

Filter by conditions available on the web (emergency, related (brings back related task), quoted, approvalContractor (brings back awaiting sign-off), recurring, quoteRequired)

\n","type":"text/plain"},"key":"condition","value":""},{"disabled":true,"description":{"content":"

Filter by tags associated with the workorder, which should be provided as a comma-separated list

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter by a keyword

\n","type":"text/plain"},"key":"_q","value":""}],"variable":[]}},"response":[{"id":"280895f5-9782-42b4-8845-2feefa6a9722","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"TASK 123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"84189d1b-7a08-4e3a-81cd-ece87b4fc236"},{"name":"View Workorder","id":"0b5b339c-d2b8-4ff4-9663-b639f41669d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}","description":"

This API endpoint retrieves the details of a single workorder, identified by its unique workorder_id.

Use this endpoint to view the specific details of a workorder.

\n","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"2c80479a-0bff-4465-9e37-a7e63fe0cac4","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Workorder Title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"some address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"0b5b339c-d2b8-4ff4-9663-b639f41669d2"},{"name":"Update Workorder","id":"dcdee77d-888a-4549-abdb-5b0d752f6bb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}","description":"

This endpoint updates an existing workorder. Any fields that are not provided will not be changed. The API will return the updated data for the unit in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
title	workorder title	String	No
description	workorder description	String	No
invite_contractors	[123,1234]	Array(integer)	No
service_type	Carpet Layer	String	No
start_date	2020-02-20	Date	No
due_date	2020-02-20	Date	No
budget	1000,00	Float	No
allocated_time_hours	20	Float	No
actual_time_hours	20	Float	No
price_per_hour	7,90	Float	No
emergency	true	Boolean	No
quote_required	true	Boolean	No
share_assets	false	Boolean	No
hide_tenant_details	true	Boolean	No

","urlObject":{"protocol":"https","path":["v2","workorders","{{workorder_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"9c19cead-6410-4308-98f4-f1123f8950ce","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/workorders/{{workorder_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"ref\": \"WO123\",\n \"status\": \"live\",\n \"title\": \"Updated title\",\n \"description\": \"Workorder Description\",\n \"related_to\": \"Task TA123\",\n \"location\": \"Unit address\",\n \"assigned_contractor\": {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n },\n \"invited_contractors\": [\n {\n \"id\": 123,\n \"full_name\": \"Michael Smith\",\n \"status\": \"pending\"\n },\n {\n \"id\": 123,\n \"full_name\": \"Brian Jones\",\n \"status\": \"completed\"\n }\n ],\n \"service_type\": {\n \"id\": 1,\n \"alias\": \"aerial-network-specialist\"\n },\n \"start_date\": null,\n \"due_date\": null,\n \"contractor_accepted_date\": \"2020-08-11\",\n \"budget\": \"\",\n \"allocated_time_hours\": \"\",\n \"actual_time_hours\": \"\",\n \"price_per_hour\": \"0.00\",\n \"hide_tenant_details\": false,\n \"share_access_details\": false,\n \"emergency\": false,\n \"quote_required\": false,\n \"share_assets\": false,\n \"cancelled_notes\": \"\",\n \"property\": {\n \"id\": 123,\n \"full_address\": \"property address\"\n },\n \"unit\": {\n \"id\": 123,\n \"full_address\": \"unit address\"\n },\n \"tenancy\": {\n \"id\": 123,\n \"ref\": \"TE123\"\n },\n \"task\": {\n \"id\": 123,\n \"ref\": \"TA123\"\n },\n \"image_urls\": [],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"James Davies\"\n },\n \"tags\": [\n \"tag1\"\n ],\n \"share_owner\": false,\n \"share_tenant\": false,\n \"created\": \"2020-08-11T10:08:47+01:00\",\n \"modified\": \"2020-08-11T14:48:37+01:00\"\n }\n}"}],"_postman_id":"dcdee77d-888a-4549-abdb-5b0d752f6bb1"}],"id":"1564e56c-22a0-43d1-905f-ffc4c16af38a","description":"

Here you can find the full list of endpoints for the Workorders area of the system.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"84378cfb-aa20-493e-b250-740b0826df25"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8603ef84-138d-497b-9fc4-e2be2c4d337a"}}],"_postman_id":"1564e56c-22a0-43d1-905f-ffc4c16af38a"},{"name":"Quotes","item":[{"name":"List Quotes","id":"a42c4700-6dfe-417c-8cd8-be452fab30ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/quotes","description":"

This endpoint retrieves a list of quotes .

\n","urlObject":{"protocol":"https","path":["v2","quotes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"31aa7c2b-6528-47ad-8c28-ee1862469783","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/quotes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"workorder_id\": 123,\n \"description\": \"Quote description\",\n \"amount\": \"150.00\",\n \"status\": \"accept\",\n \"quote_required\": false,\n \"owner_approval_required\": false,\n \"quote_accepted\": true,\n \"accepted_date\": \"2020-09-07\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Jackson\"\n },\n \"workorder\": {\n \"id\": 123,\n \"ref\": \"WO007\",\n \"title\": \"Workorder title\"\n },\n \"contractor\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Jackson\",\n \"status\": \"live\"\n },\n \"modified\": \"2020-09-07T15:38:18+01:00\",\n \"created\": \"2020-09-07T15:09:55+01:00\"\n },\n {\n \"id\": 123,\n \"workorder_id\": 123,\n \"description\": \"Quote description\",\n \"amount\": \"1230.00\",\n \"status\": \"pending\",\n \"quote_required\": true,\n \"owner_approval_required\": false,\n \"quote_accepted\": true,\n \"accepted_date\": null,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Michael Clifford\"\n },\n \"workorder\": {\n \"id\": 141166,\n \"ref\": \"WO1046\",\n \"title\": \"awaiting quote\"\n },\n \"contractor\": {\n \"id\": 123,\n \"full_name\": \"Michael Clifford\",\n \"status\": \"accepted\"\n },\n \"modified\": \"2020-08-07T12:20:35+01:00\",\n \"created\": \"2020-08-03T09:15:47+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"a42c4700-6dfe-417c-8cd8-be452fab30ea"},{"name":"View Quote","id":"9464b48b-fd17-4cde-88ff-11476030aa62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/quotes/{{quote_id}}","description":"

View Quote related to your property manager account.

\n","urlObject":{"protocol":"https","path":["v2","quotes","{{quote_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"4d732df0-b31b-4438-b33c-e7b0fa304a9e","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/quotes/{{quote_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"workorder_id\": 123,\n \"description\": \"Quote description\",\n \"amount\": \"150.00\",\n \"status\": \"accept\",\n \"quote_required\": false,\n \"owner_approval_required\": false,\n \"quote_accepted\": true,\n \"accepted_date\": \"2020-09-07\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Jackson\"\n },\n \"workorder\": {\n \"id\": 123,\n \"ref\": \"WO007\",\n \"title\": \"Workorder title\"\n },\n \"contractor\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Jackson\",\n \"status\": \"live\"\n },\n \"modified\": \"2020-09-07T15:38:18+01:00\",\n \"created\": \"2020-09-07T15:09:55+01:00\"\n }\n}\n"}],"_postman_id":"9464b48b-fd17-4cde-88ff-11476030aa62"}],"id":"5f75c9cc-b7d7-49c0-bd97-a8138f5a77dd","description":"

This API endpoint retrieves the details of a single quote, identified by its unique id.

\n","_postman_id":"5f75c9cc-b7d7-49c0-bd97-a8138f5a77dd"}],"id":"6c6aa761-a82b-42ce-a151-2b6e13b0327b","_postman_id":"6c6aa761-a82b-42ce-a151-2b6e13b0327b","description":""},{"name":"Financials","item":[{"name":"Recurrings","item":[{"name":"List Recurrings","id":"84e87909-c57d-4017-8cf9-5cceeb62a842","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"8d897406-f339-49da-b125-72cf667f51b7","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"X-EntityId","value":"{{entityId}}","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/recurrings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1481960,\n \"tenancy_id\": 966665,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2025-01-31\",\n \"next_collection_date\": null,\n \"end_type\": \"tenancy-end\",\n \"end_date\": \"2025-01-29T00:00:00\",\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": false,\n \"created\": \"2025-01-29T12:49:28\",\n \"modified\": \"2025-01-29T12:59:49\"\n },\n {\n \"id\": 1477295,\n \"tenancy_id\": 963972,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2025-01-29\",\n \"next_collection_date\": \"2025-02-28\",\n \"end_type\": \"tenancy-end\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2025-01-21T11:38:05\",\n \"modified\": \"2025-01-21T11:38:05\"\n },\n {\n \"id\": 1473617,\n \"tenancy_id\": 831899,\n \"property_id\": 106845,\n \"unit_id\": 287890,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"2000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2025-01-15\",\n \"next_collection_date\": \"2025-02-15\",\n \"end_type\": \"\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2025-01-15T01:10:02\",\n \"modified\": \"2025-01-15T01:10:02\"\n },\n {\n \"id\": 1444861,\n \"tenancy_id\": 948899,\n \"property_id\": 36384,\n \"unit_id\": 80062,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-12-25\",\n \"next_collection_date\": \"2025-02-25\",\n \"end_type\": \"tenancy-end\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-27T11:28:48\",\n \"modified\": \"2024-11-27T11:28:48\"\n },\n {\n \"id\": 1441814,\n \"tenancy_id\": 946624,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Management Fee Charge\",\n \"description\": \"Mgmt. Fee\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"percentage-payment\",\n \"amount\": \"8.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 0,\n \"start_date\": null,\n \"next_collection_date\": null,\n \"end_type\": \"tenancy-end\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-22T14:32:19\",\n \"modified\": \"2024-11-22T14:32:19\"\n },\n {\n \"id\": 1441813,\n \"tenancy_id\": 946624,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Rent Charge\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-11-28\",\n \"next_collection_date\": \"2025-02-28\",\n \"end_type\": \"tenancy-end\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-22T14:32:18\",\n \"modified\": \"2024-11-22T14:32:18\"\n },\n {\n \"id\": 1439958,\n \"tenancy_id\": 945989,\n \"property_id\": 36380,\n \"unit_id\": 80048,\n \"transaction_type\": \"Management Fee Charge\",\n \"description\": \"Mgmt. Fee\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"percentage-payment\",\n \"amount\": \"7.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 0,\n \"start_date\": null,\n \"next_collection_date\": null,\n \"end_type\": \"tenancy-end\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-21T12:40:13\",\n \"modified\": \"2024-11-21T12:40:13\"\n },\n {\n \"id\": 1439957,\n \"tenancy_id\": 945989,\n \"property_id\": 36380,\n \"unit_id\": 80048,\n \"transaction_type\": \"Rent Charge\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-11-27\",\n \"next_collection_date\": \"2025-02-27\",\n \"end_type\": \"tenancy-end\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-21T12:40:10\",\n \"modified\": \"2024-11-21T12:40:10\"\n },\n {\n \"id\": 1432517,\n \"tenancy_id\": 942433,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Management Fee Charge\",\n \"description\": \"Mgmt. Fee\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"percentage-payment\",\n \"amount\": \"9.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 0,\n \"start_date\": null,\n \"next_collection_date\": null,\n \"end_type\": \"tenancy-end\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-13T12:50:36\",\n \"modified\": \"2024-11-13T12:50:36\"\n },\n {\n \"id\": 1432516,\n \"tenancy_id\": 942433,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Rent Charge\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-11-18\",\n \"next_collection_date\": \"2025-02-18\",\n \"end_type\": \"tenancy-end\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-13T12:50:31\",\n \"modified\": \"2024-11-13T12:50:31\"\n },\n {\n \"id\": 1431502,\n \"tenancy_id\": 941795,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Management Fee Charge\",\n \"description\": \"Mgmt. Fee\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"percentage-payment\",\n \"amount\": \"7.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 0,\n \"start_date\": null,\n \"next_collection_date\": null,\n \"end_type\": \"continual\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-12T11:42:58\",\n \"modified\": \"2024-11-12T11:42:58\"\n },\n {\n \"id\": 1431501,\n \"tenancy_id\": 941795,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Rent Charge\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-11-20\",\n \"next_collection_date\": \"2025-02-20\",\n \"end_type\": \"continual\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-12T11:42:57\",\n \"modified\": \"2024-11-12T11:42:57\"\n },\n {\n \"id\": 1424066,\n \"tenancy_id\": 938179,\n \"property_id\": 324912,\n \"unit_id\": 754028,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-11-04\",\n \"next_collection_date\": \"2025-02-04\",\n \"end_type\": \"continual\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-01T14:14:19\",\n \"modified\": \"2024-11-09T06:00:15\"\n },\n {\n \"id\": 1424010,\n \"tenancy_id\": 938129,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-11-04\",\n \"next_collection_date\": \"2025-02-04\",\n \"end_type\": \"continual\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-11-01T13:06:19\",\n \"modified\": \"2024-11-09T06:00:11\"\n },\n {\n \"id\": 1415905,\n \"tenancy_id\": 934120,\n \"property_id\": 36384,\n \"unit_id\": 80062,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"2000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-10-29\",\n \"next_collection_date\": \"2025-02-28\",\n \"end_type\": \"continual\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-10-22T11:42:56\",\n \"modified\": \"2024-12-22T06:00:12\"\n },\n {\n \"id\": 1407474,\n \"tenancy_id\": 802083,\n \"property_id\": 106845,\n \"unit_id\": 287890,\n \"transaction_type\": \"Rent Charge\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-10-08\",\n \"next_collection_date\": \"2025-02-08\",\n \"end_type\": \"\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-10-08T02:10:02\",\n \"modified\": \"2024-10-08T02:10:02\"\n },\n {\n \"id\": 1398520,\n \"tenancy_id\": 926096,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Rent Charge\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"50.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-01-01\",\n \"next_collection_date\": null,\n \"end_type\": \"continual\",\n \"end_date\": \"2024-09-26T01:00:00\",\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": false,\n \"created\": \"2024-09-26T12:13:01\",\n \"modified\": \"2024-09-26T12:14:59\"\n },\n {\n \"id\": 1390487,\n \"tenancy_id\": 813133,\n \"property_id\": 303691,\n \"unit_id\": 700324,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-09-16\",\n \"next_collection_date\": \"2025-02-16\",\n \"end_type\": \"\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-09-16T02:10:04\",\n \"modified\": \"2024-09-16T02:10:04\"\n },\n {\n \"id\": 1388397,\n \"tenancy_id\": 921239,\n \"property_id\": 296953,\n \"unit_id\": 686137,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2024-10-05\",\n \"next_collection_date\": \"2025-02-05\",\n \"end_type\": \"continual\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-09-11T13:50:06\",\n \"modified\": \"2024-10-22T14:26:05\"\n },\n {\n \"id\": 1371463,\n \"tenancy_id\": 907042,\n \"property_id\": 320808,\n \"unit_id\": 743362,\n \"transaction_type\": \"Management Fee Charge\",\n \"description\": \"Mgmt. Fee\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"percentage-charge\",\n \"amount\": \"7.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 0,\n \"start_date\": null,\n \"next_collection_date\": null,\n \"end_type\": \"tenancy-end\",\n \"end_date\": null,\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": true,\n \"created\": \"2024-08-16T12:58:41\",\n \"modified\": \"2024-08-16T12:58:41\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 20,\n \"count\": 291,\n \"pageCount\": 15,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"84e87909-c57d-4017-8cf9-5cceeb62a842"},{"name":"View Recurring","id":"c801afef-09ec-45ee-a4ea-7964b0cea6a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/recurrings/{{recurringId}}","urlObject":{"protocol":"https","path":["v2","recurrings","{{recurringId}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a2db9dcd-a72d-479e-a733-e78211d9017d","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"},{"key":"X-EntityId","value":"{{entityId}}","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/recurrings/{{recurringId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1481960,\n \"tenancy_id\": 966665,\n \"property_id\": 36378,\n \"unit_id\": 80046,\n \"transaction_type\": \"Direct Rent\",\n \"description\": \"Rent\",\n \"description_format_id\": 1,\n \"at_remittance\": false,\n \"fee_type\": \"fixed\",\n \"amount\": \"1000.00\",\n \"currency\": \"GBP\",\n \"vat_code_id\": 4,\n \"frequency_id\": 1,\n \"start_date\": \"2025-01-31\",\n \"next_collection_date\": null,\n \"end_type\": \"tenancy-end\",\n \"end_date\": \"2025-01-29T00:00:00\",\n \"created_by\": {\n \"id\": 100569,\n \"full_name\": \"Max Mil\"\n },\n \"active\": false,\n \"created\": \"2025-01-29T12:49:28\",\n \"modified\": \"2025-01-29T12:59:49\"\n },\n \"pagination\": {\n \"page\": 1,\n \"current\": 20,\n \"count\": 291,\n \"pageCount\": 15,\n \"limit\": 20,\n \"queryScope\": null\n }\n}"}],"_postman_id":"c801afef-09ec-45ee-a4ea-7964b0cea6a0"}],"id":"ce9a474e-b376-4211-a8fb-600bc3fea4d4","_postman_id":"ce9a474e-b376-4211-a8fb-600bc3fea4d4","description":""},{"name":"Transactions","item":[{"name":"List Transactions","id":"0efc9848-f16a-4777-8de7-178d3ada3aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/transactions","description":"

This retrieves a list of transactions.

See available filters below to customize the list of transactions returned.

\n","urlObject":{"protocol":"https","path":["v2","transactions"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"statement","value":""},{"disabled":true,"description":{"content":"

Filter by transaction allocated from ID

\n","type":"text/plain"},"key":"allocated_from","value":""},{"disabled":true,"description":{"content":"

The status of the transaction. The available options are paid, unpaid, partpaid, outstanding, overdue, or voided. Use this parameter to filter transactions based on their payment status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by the ID of the transaction type or by its alias name (Obtained from the v2/transaction_types endpoint)

\n","type":"text/plain"},"key":"transaction_type","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the created date, starting from the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"date_from","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"date_to","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the modified date, starting from the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"modifiedFrom","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the modified date, up to the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"modifiedTo","value":""},{"disabled":true,"description":{"content":"

Filters the transactions by the date, starting from the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"transaction_date_from","value":null},{"disabled":true,"description":{"content":"

Filters the transactions by the date, up to the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"transaction_date_to","value":null}],"variable":[]}},"response":[{"id":"00c1dc5f-c733-4f7d-86cb-027504b86513","name":"List Transactions","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/transactions"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"ref\": \"TR007\",\n \"transaction_type\": \"Registered Deposit Charge\",\n \"payment_type\": \"charge\",\n \"description\": \"Registered Deposit\",\n \"property_id\": 11,\n \"unit_id\": 22,\n \"tenancy_id\": 33,\n \"payee_group_id\": 10,\n \"invoice_ref\": \"\",\n \"payee_tenant_id\": 44,\n \"amount\": \"1500.00\",\n \"amount_charged\": \"1500.00\",\n \"amount_paid\": \"0.00\",\n \"amount_outstanding\": \"1500.00\",\n \"amount_net\": \"1500.00\",\n \"vat_code_id\": 4,\n \"source\": \"arthur\",\n \"created_by\": {\n \"id\": 11,\n \"full_name\": \"Brian Brown\"\n },\n \"payee_name\": \"Thomas Smith\",\n \"payee_person_id\": null,\n \"payee_entity_id\": 0,\n \"date\": \"2020-06-25\",\n \"due_date\": \"2020-06-25\",\n \"modified\": \"2020-06-25T15:35:01+01:00\",\n \"created\": \"2020-06-25T15:35:01+01:00\"\n },\n {\n \"id\": 2,\n \"ref\": \"TR007\",\n \"transaction_type\": \"Registered Deposit Charge\",\n \"payment_type\": \"charge\",\n \"description\": \"Registered Deposit\",\n \"property_id\": 11,\n \"unit_id\": 22,\n \"tenancy_id\": 33,\n \"payee_group_id\": 10,\n \"invoice_ref\": \"\",\n \"payee_tenant_id\": 44,\n \"amount\": \"1500.00\",\n \"amount_charged\": \"1500.00\",\n \"amount_paid\": \"0.00\",\n \"amount_outstanding\": \"1500.00\",\n \"amount_net\": \"1500.00\",\n \"vat_code_id\": 4,\n \"source\": \"arthur\",\n \"created_by\": {\n \"id\": 11,\n \"full_name\": \"Brian Brown\"\n },\n \"payee_name\": \"Thomas Smith\",\n \"payee_person_id\": null,\n \"payee_entity_id\": 0,\n \"date\": \"2020-06-25\",\n \"due_date\": \"2020-06-25\",\n \"modified\": \"2020-06-25T15:35:01+01:00\",\n \"created\": \"2020-06-25T15:35:01+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"0efc9848-f16a-4777-8de7-178d3ada3aee"},{"name":"View Transaction","id":"9748b33a-68b7-434c-b5d4-631ac32ac833","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/transactions/{{transaction_id}}","description":"

This API endpoint retrieves the details of a single transaction, identified by its unique transaction_id.

Use this endpoint to view the specific details of a transaction.

\n","urlObject":{"protocol":"https","path":["v2","transactions","{{transaction_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"4e29e2c1-3afa-4de1-ae14-d9e84cc76194","name":"View Transaction","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/transactions/{{transaction_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": { \n \"id\": 1,\n \"ref\": \"TR007\",\n \"transaction_type\": \"Registered Deposit Charge\",\n \"payment_type\": \"charge\",\n \"description\": \"Registered Deposit\",\n \"property_id\": 11,\n \"unit_id\": 22,\n \"tenancy_id\": 33,\n \"payee_group_id\": 10,\n \"invoice_ref\": \"\",\n \"payee_tenant_id\": 44,\n \"amount\": \"1500.00\",\n \"amount_charged\": \"1500.00\",\n \"amount_paid\": \"0.00\",\n \"amount_outstanding\": \"1500.00\",\n \"amount_net\": \"1500.00\",\n \"vat_code_id\": 4,\n \"source\": \"arthur\",\n \"created_by\": {\n \"id\": 11,\n \"full_name\": \"Brian Brown\"\n },\n \"payee_name\": \"Thomas Smith\",\n \"payee_person_id\": null,\n \"payee_entity_id\": 0,\n \"date\": \"2020-06-25\",\n \"due_date\": \"2020-06-25\",\n \"modified\": \"2020-06-25T15:35:01+01:00\",\n \"created\": \"2020-06-25T15:35:01+01:00\"\n } \n}"}],"_postman_id":"9748b33a-68b7-434c-b5d4-631ac32ac833"},{"name":"🆕 Payoff Transaction","id":"d2ca1972-04b4-4435-a148-237ba72f9f89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/transactions/{{transaction_id}}/payoff","description":"

This API endpoint allows the user to payoff a transaction with a payment. The transaction is identified by its unique transaction_id and the payment details are included in the optional request body.

If no request body is included, the endpoint will pay off the full charge.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
description	string	A description of the payoff receipt.
payment_method_id	integer	The ID of the payment method used to pay off the transaction.
amount	float	The amount paid towards the transaction.

","urlObject":{"protocol":"https","path":["v2","transactions","{{transaction_id}}","payoff"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"80ef8f25-cc2a-4353-a1a2-046c6c7d0a44","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/transactions/{{transaction_id}}/payoff"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 22386790,\n \"recurring_id\": null,\n \"parent_id\": 22350765,\n \"ref\": \"TR13434\",\n \"transaction_type\": \"Tenancy Receipt\",\n \"payment_type\": \"payment\",\n \"description\": \"Paid - Rent, (Arthur), TE1158, Arthur (26th Feb 2023 - 25th Mar 2023)\",\n \"property_id\": 106845,\n \"unit_id\": 287886,\n \"tenancy_id\": 484937,\n \"payee_group_id\": 10,\n \"invoice_ref\": \"\",\n \"payee_tenant_id\": 588463,\n \"amount\": \"600.00\",\n \"amount_charged\": \"0.00\",\n \"amount_paid\": \"600.00\",\n \"amount_outstanding\": \"0.00\",\n \"amount_net\": \"600.00\",\n \"amount_vat\": \"0.00\",\n \"vat_code_id\": 0,\n \"source\": \"arthur\",\n \"created_by\": {\n \"id\": 1817080,\n \"full_name\": \"API Documentation\"\n },\n \"payee_name\": \"\",\n \"payee_person_id\": null,\n \"payee_entity_id\": null,\n \"date\": \"2023-02-27\",\n \"due_date\": null,\n \"charged_to_date\": null,\n \"expected_payment_date\": null,\n \"allocated_from\": null,\n \"is_overdue\": false,\n \"is_outstanding\": false,\n \"modified\": \"2023-02-27T13:32:23\",\n \"created\": \"2023-02-27T13:32:23\"\n }\n}"}],"_postman_id":"d2ca1972-04b4-4435-a148-237ba72f9f89"}],"id":"189fad1e-aba4-416c-baf4-e73bc1a87dd3","description":"

This folder provides endpoints to retrieve a list of transactions and to pay them off using the API.

It is recommended to look at the parent folders instead if looking for transactions on a specific property, unit, tenancy, or work order.

\n","_postman_id":"189fad1e-aba4-416c-baf4-e73bc1a87dd3"},{"name":"Contractor Invoices","item":[{"name":"List Invoices","id":"8941a0d6-689c-4e70-a140-75cad6427322","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/invoices","description":"

This retrieves a list of invoices.

\n","urlObject":{"protocol":"https","path":["v2","invoices"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by the connected workorder ID

\n","type":"text/plain"},"key":"workorder_id","value":""},{"disabled":true,"description":{"content":"

Filter by invoice status (paid, unpaid, pending, cancelled)

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by invoice amount

\n","type":"text/plain"},"key":"amount","value":""},{"disabled":true,"description":{"content":"

Filter by invoice amount outstanding

\n","type":"text/plain"},"key":"amount_outstanding","value":""},{"disabled":true,"description":{"content":"

Filter by VAT amount

\n","type":"text/plain"},"key":"amount_vat","value":""},{"disabled":true,"description":{"content":"

Filter by the percentage of VAT

\n","type":"text/plain"},"key":"vat_percentage","value":""},{"disabled":true,"description":{"content":"

Filters the contractor invoices by the paid date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"paid_date","value":""},{"disabled":true,"description":{"content":"

To show only submitted invoices, set submitted flag to true

\n","type":"text/plain"},"key":"submitted","value":""},{"disabled":true,"description":{"content":"

Filters the contractor invoices by the completed date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"completed_date","value":""}],"variable":[]}},"response":[{"id":"320c32a0-0a2f-43c3-9e2b-8873593350c5","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/invoices"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"workorder_id\": 123,\n \"ref\": \"W0/000\",\n \"status\": \"unpaid\",\n \"location\": \"Property address\",\n \"amount\": \"1476.00\",\n \"amount_paid\": \"0.00\",\n \"amount_outstanding\": \"1476.00\",\n \"amount_vat\": \"246.00\",\n \"vat_percentage\": \"20.00\",\n \"paid_date\": null,\n \"submitted\": true,\n \"submitted_date\": \"2020-04-07T13:51:11+01:00\",\n \"completed_date\": null,\n \"invoice_items\": [\n {\n \"id\": 123,\n \"name\": \"Item name\",\n \"description\": \"Item description\",\n \"amount\": \"1230.00\",\n \"quantity\": 1\n }\n ],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Zoltan Chivay\"\n },\n \"workorder\": {\n \"id\": 123,\n \"ref\": \"WO000\",\n \"title\": \"Workorder title\"\n },\n \"contractor\": {\n \"id\": 123,\n \"full_name\": \"Zoltan Chivay\",\n \"status\": \"live\"\n },\n \"created\": \"2020-08-07T15:50:39+01:00\",\n \"modified\": \"2020-09-04T15:23:55+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"8941a0d6-689c-4e70-a140-75cad6427322"},{"name":"View Invoices","id":"73f9cdb2-0b7f-4616-ac2c-148fd7da0475","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/invoices/{{invoice_id}}","description":"

This API endpoint retrieves the details of a single invoice, identified by its unique invoice_id.

Use this endpoint to view the specific details of an invoice.

\n","urlObject":{"protocol":"https","path":["v2","invoices","{{invoice_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ea2d94bb-9336-43e9-b19c-16e206f9254d","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/invoices/{{invoice_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"workorder_id\": 123,\n \"ref\": \"W0/000\",\n \"status\": \"unpaid\",\n \"location\": \"Property address\",\n \"amount\": \"1476.00\",\n \"amount_paid\": \"0.00\",\n \"amount_outstanding\": \"1476.00\",\n \"amount_vat\": \"246.00\",\n \"vat_percentage\": \"20.00\",\n \"paid_date\": null,\n \"submitted\": true,\n \"submitted_date\": \"2020-04-07T13:51:11+01:00\",\n \"completed_date\": null,\n \"invoice_items\": [\n {\n \"id\": 123,\n \"name\": \"Item name\",\n \"description\": \"Item description\",\n \"amount\": \"1230.00\",\n \"quantity\": 1\n }\n ],\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Zoltan Chivay\"\n },\n \"workorder\": {\n \"id\": 123,\n \"ref\": \"WO000\",\n \"title\": \"Workorder title\"\n },\n \"contractor\": {\n \"id\": 123,\n \"full_name\": \"Zoltan Chivay\",\n \"status\": \"live\"\n },\n \"created\": \"2020-08-07T15:50:39+01:00\",\n \"modified\": \"2020-09-04T15:23:55+01:00\"\n }\n}"}],"_postman_id":"73f9cdb2-0b7f-4616-ac2c-148fd7da0475"}],"id":"afedc953-7b2b-4fa1-be39-7e5c2e4b47a1","description":"

Here you can find the full list of endpoints for the Invoices area of the Contractor system.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8ef75ea6-e9de-4526-8b51-4cbc4fa6e4fb"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"985d031c-714a-4449-9036-9961ec9d0d76"}}],"_postman_id":"afedc953-7b2b-4fa1-be39-7e5c2e4b47a1"}],"id":"5e7aa2f6-8d34-48f0-8186-0b54439848ae","_postman_id":"5e7aa2f6-8d34-48f0-8186-0b54439848ae","description":""},{"name":"Assets","item":[{"name":"List Assets","id":"7b211eec-2dab-4623-96e7-37db39f763f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/assets","description":"

This retrieves a list of assets.

See available filters below to customize the list of properties returned.

\n","urlObject":{"protocol":"https","path":["v2","assets"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by asset type (image, notimage, document, other)

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

To display only main images, set this to true

\n","type":"text/plain"},"key":"main_image","value":""},{"disabled":true,"description":{"content":"

Filters assets by the created date, starting from the specified date. Use the format yyyy-mm-dd to input the date

\n","type":"text/plain"},"key":"created_from","value":""},{"disabled":true,"description":{"content":"

Filters assets by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"created_to","value":""},{"disabled":true,"description":{"content":"

Filter by attachment type (Property, Unit, Tenancy, Transaction)

\n","type":"text/plain"},"key":"model","value":null}],"variable":[]}},"response":[{"id":"df94cbef-d583-4e95-80d0-63c375cf1cb5","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"IMG_123_123.jpg\",\n \"description\": null,\n \"created_by\": {\n \"full_name\": \"Brian Shawn\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"Image\",\n \"mime_type\": \"image/jpeg\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Contract\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 1,\n \"model\": \"Unit\",\n \"model_id\": 2\n }\n ],\n \"created\": \"2020-06-30T15:31:29+01:00\",\n \"modified\": \"2020-06-30T15:31:42+01:00\"\n },\n {\n \"id\": 123,\n \"name\": \"123_123.pdf\",\n \"description\": null,\n \"created_by\": {\n \"full_name\": \"Brian Shawn\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Unit Report\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 1,\n \"model\": \"Unit\",\n \"model_id\": 2\n }\n ],\n \"created\": \"2020-06-30T15:30:58+01:00\",\n \"modified\": \"2020-06-30T15:31:05+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"7b211eec-2dab-4623-96e7-37db39f763f8"},{"name":"View Asset","id":"2b48929d-6e9c-441f-9dab-b6200384dd67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/assets/{{asset_id}}","description":"

This API endpoint retrieves the details of a single asset, identified by its unique asset_id.

Use this endpoint to view the specific details of an asset.

\n","urlObject":{"protocol":"https","path":["v2","assets","{{asset_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b5403445-d7fa-4858-a4cf-e3259317db4a","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"IMG_123_123.jpg\",\n \"description\": null,\n \"created_by\": {\n \"full_name\": \"Brian Shawn\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"Image\",\n \"mime_type\": \"image/jpeg\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Contract\",\n \"share_manager\": true,\n \"share_owner\": false,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [\n {\n \"id\": 1,\n \"model\": \"Unit\",\n \"model_id\": 2\n }\n ],\n \"created\": \"2020-06-30T15:31:29+01:00\",\n \"modified\": \"2020-06-30T15:31:42+01:00\"\n }\n}"}],"_postman_id":"2b48929d-6e9c-441f-9dab-b6200384dd67"},{"name":"Create Asset","id":"700c7adf-6145-466a-bde5-44ea10042065","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/assets","description":"

Use this endpoint to create a new asset. The API will return the saved data and a unique Asset ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
asset_type	image	String	No
name	Inventory	String	No
share_manager	true	Boolean	No
share_tenant	false	Boolean	No
share_contractor	true	Boolean	No
share_owner	true	Boolean	No
file	base64	String	Yes
mime_type	application/pdf	String	Yes
file_name	inventory	String	Yes

","urlObject":{"protocol":"https","path":["v2","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a00ab032-3d78-445b-acbf-8cc7caeebb51","name":"Example - Upload pdf","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset_type\":\"image\",\n\t\"name\":\"name of asset\",\n\t\"share_manager\":true,\n\t\"share_tenant\":true,\n\t\"share_owner\":true,\n\t\"share_contractor\":true,\n\t\"file\":\"pdf file converted to base64 string\",\n\t\"mime_type\":\"application/pdf\",\n\t\"file_name\":\"inventory\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"name of asset\",\n \"description\": null,\n \"created_by\": {\n \"full_name\": \"Brian Willson\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Image\",\n \"share_manager\": true,\n \"share_owner\": true,\n \"share_tenant\": true,\n \"share_contractor\": true,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [],\n \"created\": \"2020-07-03T09:25:52+01:00\",\n \"modified\": \"2020-07-03T09:25:52+01:00\"\n }\n}"},{"id":"cfe9b61d-8036-415b-a39f-e1a771678a97","name":"Example - Upload Image","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset_type\":\"image\",\n\t\"name\":\"name of asset\",\n\t\"share_manager\":true,\n\t\"share_tenant\":true,\n\t\"share_owner\":true,\n\t\"share_contractor\":true,\n\t\"file\":\"jpeg file converted to base64 string\",\n\t\"mime_type\":\"image/jpeg\",\n\t\"file_name\":\"image\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/assets"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"name of asset\",\n \"description\": null,\n \"created_by\": {\n \"full_name\": \"Brian Willson\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"Image\",\n \"mime_type\": \"image/jpeg\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Image\",\n \"share_manager\": true,\n \"share_owner\": true,\n \"share_tenant\": true,\n \"share_contractor\": true,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [],\n \"created\": \"2020-07-03T09:25:52+01:00\",\n \"modified\": \"2020-07-03T09:25:52+01:00\"\n }\n}"}],"_postman_id":"700c7adf-6145-466a-bde5-44ea10042065"},{"name":"Update Asset","id":"760acc8c-2958-4ff7-bc2f-00d59335da02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/assets/{{asset_id}}","description":"

This endpoint updates an existing asset using the same fields as the 'Add Asset' endpoint. Any fields that are not provided will not be changed. The API will return the updated data for the asset in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
asset_type	image	String	No
name	inventory	String	No
share_manager	true	Boolean	No
share_tenant	false	Boolean	No
share_contractor	true	Boolean	No
share_owner	true	Boolean	No
file	base64	String	No
mime_type	application/pdf	String	No
file_name	inventory	String	No

","urlObject":{"protocol":"https","path":["v2","assets","{{asset_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"16043f42-2bc9-4ba0-a8bc-39a0de05bcda","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset_type\":\"image\",\n\t\"name\":\"name of updated asset\",\n\t\"share_manager\":true,\n\t\"share_tenant\":false,\n\t\"share_owner\":true,\n\t\"share_contractor\":true,\n\t\"file\":\"pdf file converted to base64 string\",\n\t\"mime_type\":\"application/pdf\",\n\t\"file_name\":\"inventory\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/assets/{{asset_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"name of updated asset\",\n \"description\": null,\n \"created_by\": {\n \"name\": \"Brian Williams\",\n \"company\": \"Superfarm\"\n },\n \"file_type\": \"PDF\",\n \"mime_type\": \"application/pdf\",\n \"is_image\": false,\n \"main_image\": false,\n \"asset_type\": \"Image\",\n \"share_manager\": true,\n \"share_owner\": true,\n \"share_tenant\": false,\n \"share_contractor\": true,\n \"download_url\": \"https://api.arthuronline.co.uk/public/assets/download/123123\",\n \"view_url\": \"https://api.arthuronline.co.uk/public/assets/view/123123\",\n \"attachments\": [],\n \"created\": \"2020-07-03T09:25:52+01:00\",\n \"modified\": \"2020-07-07T13:03:57+01:00\"\n }\n}"}],"_postman_id":"760acc8c-2958-4ff7-bc2f-00d59335da02"},{"name":"Delete Asset","id":"950a3372-9aed-4380-9bdf-48b5925af52e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/assets/{{asset_id}}","description":"

This endpoint deletes an existing asset record using the asset id.

Here you can find the full list of endpoints for the Assets area of the system.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0520ede0-c641-47b4-b2b0-b7d357d5ffff"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d7c859c5-a583-42d1-9c9d-c1c454b77879"}}],"_postman_id":"cfcd20ee-68fd-4ffd-a2f9-216e14818ac2"},{"name":"Utilities","item":[{"name":"Readings","item":[{"name":"List Readings","id":"c0c931b7-3695-4cfd-9a17-6d56e69df9c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}/readings","description":"

This endpoint retrieves a list of readings associated with the given utility ID.

\n","urlObject":{"protocol":"https","path":["v2","utilities","{{utility_id}}","readings"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ce9cf468-129b-4ee4-bb98-0abfe594bbaa","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}/readings"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 2,\n \"meter_reading\": \"1234\",\n \"reading_date\": \"2020-10-27\",\n \"taken_by\": \"\",\n \"notes\": \"\",\n \"utility_id\": 3\n },\n {\n \"id\": 1,\n \"meter_reading\": \"123\",\n \"reading_date\": \"2020-08-26\",\n \"taken_by\": \"\",\n \"notes\": \"\",\n \"utility_id\": 3\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"c0c931b7-3695-4cfd-9a17-6d56e69df9c7"},{"name":"View Reading","id":"5ac39950-3072-40b9-b016-613140dbda5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}/readings/{{reading_id}}","description":"

This API endpoint retrieves the details of a single reading, identified by its unique id related to a reading.

\n","urlObject":{"protocol":"https","path":["v2","utilities","{{utility_id}}","readings","{{reading_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a6752f4a-aba1-41ef-a15a-6b3d2765279b","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}/readings/{{reading_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 2,\n \"meter_reading\": \"1234\",\n \"reading_date\": \"2020-10-27\",\n \"taken_by\": \"\",\n \"notes\": \"\",\n \"utility_id\": 3\n }\n}"}],"_postman_id":"5ac39950-3072-40b9-b016-613140dbda5e"},{"name":"Create Reading","id":"6c93dd03-9a65-4208-9c83-2a7bd11516b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}/readings","description":"

Use this endpoint to create a new reading record for the utility. The API will return the saved data and a unique reading ID.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
reading_value	21021	String	Yes
reading_date	2020-10-21	Date	Yes
taken_by	Brian Smith	String	No
notes	reading notes	string	No

","urlObject":{"protocol":"https","path":["v2","utilities","{{utility_id}}","readings"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"114aced0-f758-40d9-ac46-7838d0baf3bb","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reading_value\": \"123\",\n \"reading_date\": \"2020-10-21\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}/readings"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"meter_reading\": \"123\",\n \"reading_date\": \"2020-10-21\",\n \"taken_by\": \"\",\n \"notes\": \"\",\n \"utility_id\": 2\n }\n}"}],"_postman_id":"6c93dd03-9a65-4208-9c83-2a7bd11516b9"},{"name":"Update Reading","id":"93dd62b1-aa7c-4fae-a9b7-99e347bb464a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}/readings/{{reading_id}}","description":"

This endpoint updates an existing reading using the same fields as the 'Add Reading' endpoint. The API will return the updated data for the reading in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
reading_value	21021	String	No
reading_date	2020-10-21	Date	No
taken_by	Brian Smith	String	No
notes	reading notes	string	No

","urlObject":{"protocol":"https","path":["v2","utilities","{{utility_id}}","readings","{{reading_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"49e1db1f-6f53-4369-b735-b7d9cb37eaeb","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reading_value\":\"12345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}/readings/{{reading_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 2,\n \"meter_reading\": \"12345\",\n \"reading_date\": \"2020-10-27\",\n \"taken_by\": \"\",\n \"notes\": \"\",\n \"utility_id\": 3\n }\n}"}],"_postman_id":"93dd62b1-aa7c-4fae-a9b7-99e347bb464a"},{"name":"Delete Reading","id":"6e030fc9-1ffc-42dc-8706-5a7a7f723f9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}/readings/{{reading_id}}","description":"

This endpoint deletes an existing reading using the reading id related to a utility.

\n","urlObject":{"protocol":"https","path":["v2","utilities","{{utility_id}}","readings","{{reading_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"3966186a-564b-4589-9335-17251d568e7f","name":"Example","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}/readings/{{reading_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"6e030fc9-1ffc-42dc-8706-5a7a7f723f9a"}],"id":"d208b36f-b785-4278-b0f7-c0299f579e47","description":"

This section provides resources for dealing with readings related to a Utility.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7036e609-8b80-451b-98db-edc12216d21d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"28e088cd-82b6-4103-9e6d-ed6fa7bcb344"}}],"_postman_id":"d208b36f-b785-4278-b0f7-c0299f579e47"},{"name":"List Utilities","id":"6946a730-f459-4039-80f6-9679cf95ad5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/utilities","description":"

This retrieves a list of utilities.

See available filters below to customize the list of utilities returned.

\n","urlObject":{"protocol":"https","path":["v2","utilities"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by type (e.g. gas, water, eletric)

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Filter by serial number

\n","type":"text/plain"},"key":"serial_number","value":null},{"disabled":true,"description":{"content":"

Filter by account number

\n","type":"text/plain"},"key":"account_number","value":null},{"disabled":true,"description":{"content":"

Filter by provider

\n","type":"text/plain"},"key":"provider","value":null},{"disabled":true,"description":{"content":"

Filter by the created date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"created","value":null},{"disabled":true,"description":{"content":"

Filter by the modified date. Use the format yyyy-mm-dd to input the date.

\n","type":"text/plain"},"key":"modified","value":null}],"variable":[]}},"response":[{"id":"76fe7d73-74e1-4f68-913d-f6e9fdd2aa62","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/utilities"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 16016,\n \"type\": \"Broadband\",\n \"serial_number\": \"321K123AmX\",\n \"account_number\": \"39102712\",\n \"provider\": \"\",\n \"last_reading_value\": null,\n \"last_reading_date\": null,\n \"notes\": \"\",\n \"created_by\": {\n \"id\": 1,\n \"full_name\": \"Martin Zelazny\"\n },\n \"created\": \"2020-10-27T10:24:30+00:00\",\n \"modified\": \"2020-10-27T10:24:30+00:00\"\n },\n {\n \"id\": 16015,\n \"type\": \"Electric\",\n \"serial_number\": \"321K123AmX\",\n \"account_number\": \"39102712\",\n \"provider\": \"\",\n \"last_reading_value\": \"89212\",\n \"last_reading_date\": \"2020-10-27\",\n \"notes\": \"\",\n \"created_by\": {\n \"id\": 1,\n \"full_name\": \"Martin Zelazny\"\n },\n \"created\": \"2020-10-27T10:14:16+00:00\",\n \"modified\": \"2020-10-27T10:14:16+00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"6946a730-f459-4039-80f6-9679cf95ad5f"},{"name":"View Utility","id":"92f76953-8a46-4aa7-8ce3-02c63076c61a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}","description":"

This API endpoint retrieves the details of a single utility, identified by its unique utility_id.

Use this endpoint to view the specific details of a utility record.

\n","urlObject":{"protocol":"https","path":["v2","utilities","{{utility_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ccfb6e11-11c5-4a9d-9066-17009f2a0175","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"type\": \"Broadband\",\n \"serial_number\": \"JaSA102D\",\n \"account_number\": \"12344321\",\n \"provider\": \"\",\n \"last_reading_value\": null,\n \"last_reading_date\": null,\n \"notes\": \"\",\n \"created_by\": {\n \"id\": 1,\n \"full_name\": \"Brian Shawn\"\n },\n \"created\": \"2020-10-27T10:24:30+00:00\",\n \"modified\": \"2020-10-27T10:24:30+00:00\"\n }\n}"}],"_postman_id":"92f76953-8a46-4aa7-8ce3-02c63076c61a"},{"name":"Update Utility","id":"44894766-3ff0-4f1e-bb5c-2e03ab7783a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}","description":"

This endpoint updates an existing utility. The API will return the updated data for the utility in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
type	gas	String	No
notes	behind back doors	String	No
serial_number	GA212FP21	String	No
account_number	12344321	string	No
provider	company_name	string	No

","urlObject":{"protocol":"https","path":["v2","utilities","{{utility_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"e115bfdd-704f-4e28-baa9-63c4e6e123eb","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serial_number\":\"Updated serial number\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"type\": \"Broadband\",\n \"serial_number\":\"Updated serial number\",\n \"account_number\": \"12344321\",\n \"provider\": \"\",\n \"last_reading_value\": null,\n \"last_reading_date\": null,\n \"notes\": \"\",\n \"created_by\": {\n \"id\": 1,\n \"full_name\": \"Brian Shawn\"\n },\n \"created\": \"2020-10-27T10:24:30+00:00\",\n \"modified\": \"2020-10-27T10:24:30+00:00\"\n }\n}"}],"_postman_id":"44894766-3ff0-4f1e-bb5c-2e03ab7783a5"},{"name":"Delete Utility","id":"a6d2c357-4550-4d25-b7b0-00855ca0a958","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/utilities/{{utility_id}}","description":"

This endpoint deletes an existing utility using the utility id.

Here you can find the full list of endpoints for the Utilities area of the system.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2e1eef20-b5f1-4165-8ed1-639c9a82fdd5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"03073010-e53b-4d09-be24-92c9d7f8cdc1"}}],"_postman_id":"c41f6ff5-a15a-4920-a889-16dc55ee95a7"},{"name":"Certificates","item":[{"name":"List Certificates","id":"0c76b697-e681-4bc0-934e-a3894f84f1ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/certificates","description":"

This retrieves a list of certificates.

\n","urlObject":{"protocol":"https","path":["v2","certificates"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"f26aee0b-55a9-4207-b912-a4cbcc065074","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/certificates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 12345,\n \"type\": \"Gas Safety\",\n \"expiry_date\": \"2021-06-06\",\n \"status\": \"Expired\",\n \"missing\": false,\n \"file\": {\n \"id\": 12345,\n \"download_url\": \"https://asset.arthuronline.co.uk/download/{uuid}\",\n \"mime_type\": \"image/jpeg\"\n },\n \"property\": {\n \"id\": 1234,\n \"address\": \"Multiple Unit Property, test, ABC 123\"\n },\n \"unit\": {\n \"id\": 123,\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"tenancy\": {\n \"id\": 123456,\n \"ref\": \"TE1000\",\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"notes\": \"My Certificate Notes\",\n \"share_manager\": true,\n \"share_tenant\": false,\n \"share_contractor\": true,\n \"share_owner\": false,\n \"created\": \"2021-01-01T12:00:00\",\n \"modified\": \"2021-01-01T12:00:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 1,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"0c76b697-e681-4bc0-934e-a3894f84f1ba"},{"name":"View Certificate","id":"5ffac3e2-6eed-48cc-b57e-2b4aaa219fe1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/certificates/{{certificate_id}}","description":"

This API endpoint retrieves the details of a single certificate, identified by its unique certificate_id.

Use this endpoint to view the specific details of a certificate.

\n","urlObject":{"protocol":"https","path":["v2","certificates","{{certificate_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"fe758578-d214-42de-a6c2-765008191366","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/certificates/{{certificate_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 12345,\n \"type\": \"Gas Safety\",\n \"expiry_date\": \"2021-06-06\",\n \"status\": \"Expired\",\n \"missing\": false,\n \"file\": {\n \"id\": 12345,\n \"download_url\": \"https://asset.arthuronline.co.uk/download/{uuid}\",\n \"mime_type\": \"image/jpeg\"\n },\n \"property\": {\n \"id\": 1234,\n \"address\": \"Multiple Unit Property, test, ABC 123\"\n },\n \"unit\": {\n \"id\": 123,\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"tenancy\": {\n \"id\": 123456,\n \"ref\": \"TE1000\",\n \"address\": \"Unit 1, test, ABC 123\"\n },\n \"notes\": \"My Certificate Notes\",\n \"share_manager\": true,\n \"share_tenant\": false,\n \"share_contractor\": true,\n \"share_owner\": false,\n \"created\": \"2021-01-01T12:00:00\",\n \"modified\": \"2021-01-01T12:00:00\"\n }\n}"}],"_postman_id":"5ffac3e2-6eed-48cc-b57e-2b4aaa219fe1"},{"name":"Update Certificate","id":"6c5db534-cda8-4da0-9d40-e6d2f0dabe9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/certificates/{{certificate_id}}","description":"

This endpoint updates an existing certificate using the same fields as the 'Add Certificate' endpoint found under Properties, Units, Tenancies and Workorders. Any fields that are not provided will not be changed. The API will return the updated data for the asset in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
type	Boiler Service	String	Yes
expiry_date	2023-12-05	String	No
notes	Fully assessed	String	No
file	Base64	String	No
mime_type	application/pdf	String	No (Required if File field is present)
file_name	Certificate Document	string	No (Required if File field is present)

","urlObject":{"protocol":"https","path":["v2","certificates","{{certificate_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a276404c-47c5-4942-80df-3f5b4d6861c3","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\" : \"Boiler Service\",\n \"expiry_date\" : \"2022-02-28\",\n \"notes\" : \"Fully assessed\",\n \"file\" : \"JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjE2Ljg5NjAgVGQNCiggdGV4dC4gQW5kIG1vcmUgdGV4dC4gQm9yaW5nLCB6enp6ei4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjA0Ljk0NDAgVGQNCiggbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDU5Mi45OTIwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTY5LjA4ODAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NTcuMTM2MCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBFdmVuIG1vcmUuIENvbnRpbnVlZCBvbiBwYWdlIDIgLi4uKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjYgMCBvYmoNCjw8DQovVHlwZSAvUGFnZQ0KL1BhcmVudCAzIDAgUg0KL1Jlc291cmNlcyA8PA0KL0ZvbnQgPDwNCi9GMSA5IDAgUiANCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBTaW1wbGUgUERGIEZpbGUgMiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIC4uLmNvbnRpbnVlZCBmcm9tIHBhZ2UgMS4gWWV0IG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NzYuNjU2MCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY2NC43MDQwIFRkDQooIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiBCdXQgbm90IGFzIGJvcmluZyBhcyB3YXRjaGluZyApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY1Mi43NTIwIFRkDQooIHBhaW50IGRyeS4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NDAuODAwMCBUZA0KKCBCb3JpbmcuICBNb3JlLCBhIGxpdHRsZSBtb3JlIHRleHQuIFRoZSBlbmQsIGFuZCBqdXN0IGFzIHdlbGwuICkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo4IDAgb2JqDQpbL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZVwpKQ0KL1Byb2R1Y2VyIChOZXZyb25hIERlc2lnbnMpDQovQ3JlYXRpb25EYXRlIChEOjIwMDYwMzAxMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQowIDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgbg0KMDAwMDAwMDA5MyAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg==\",\n \"mime_type\" : \"application/pdf\",\n \"file_name\" : \"Document name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/certificates/{{certificate_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Mar 2023 13:10:12 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"max-age=1"},{"key":"Expires","value":"Thu, 02 Mar 2023 13:10:13 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policy","value":"master-only"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=vTdI2a5sEUzplCS8uG%2BDH%2F4%2BwAN%2Fh%2F1cNYdrk3RNsM2kS1H51Or1eezdfmyS9ka7Mf1RTbPa75npcDwfHB1FCbGIKILb46OX0r2JLdiwkvCQGHbTRQV%2BuAEEl9Zo7%2FxDGvQXNBaY3s5nS1s%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7a19e0e59b7bdc93-LHR"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 714251,\n \"type\": \"Boiler Service \",\n \"expiry_date\": \"2022-02-28\",\n \"status\": \"Expired\",\n \"missing\": false,\n \"file\": {\n \"id\": 5758396,\n \"download_url\": \"https://asset.arthuronline.co.uk/download/5b339fad-59d0-412e-a4bb-5809802d6832\",\n \"mime_type\": \"application/pdf\"\n },\n \"property\": {\n \"id\": 51784,\n \"address\": \"2 Trainstation Road, London, WE14 6TR\"\n },\n \"unit\": {\n \"id\": 0,\n \"address\": \"\"\n },\n \"tenancy\": {\n \"id\": null,\n \"ref\": null,\n \"address\": null\n },\n \"notes\": \"Fully assessed\",\n \"share_manager\": true,\n \"share_tenant\": false,\n \"share_contractor\": false,\n \"share_owner\": false,\n \"created\": \"2022-10-05T12:09:45\",\n \"modified\": \"2023-03-02T13:10:12\"\n }\n}"}],"_postman_id":"6c5db534-cda8-4da0-9d40-e6d2f0dabe9e"},{"name":"Delete Certificate","id":"546254a8-6959-41fc-a823-dd0eaa5fd2b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/certificates/{{certificate_id}}","description":"

This endpoint deletes an existing ceriticate record using the certificate id.

\n","urlObject":{"protocol":"https","path":["v2","certificates","{{certificate_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b335cb5a-f95b-467b-b68e-28dee27457e5","name":"Example","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/certificates/{{certificate_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Mar 2023 13:10:12 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"max-age=1"},{"key":"Expires","value":"Thu, 02 Mar 2023 13:10:13 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policy","value":"master-only"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=vTdI2a5sEUzplCS8uG%2BDH%2F4%2BwAN%2Fh%2F1cNYdrk3RNsM2kS1H51Or1eezdfmyS9ka7Mf1RTbPa75npcDwfHB1FCbGIKILb46OX0r2JLdiwkvCQGHbTRQV%2BuAEEl9Zo7%2FxDGvQXNBaY3s5nS1s%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7a19e0e59b7bdc93-LHR"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Certificate deleted successfully.\"\n}"}],"_postman_id":"546254a8-6959-41fc-a823-dd0eaa5fd2b4"}],"id":"07a6f3aa-bd1c-4f6c-b6eb-e8baf8817d83","description":"

Here you can find the full list of endpoints for the Certificates area of the system.

\n","_postman_id":"07a6f3aa-bd1c-4f6c-b6eb-e8baf8817d83"},{"name":"Entities","item":[{"name":"List Entities","id":"75281203-1966-4ec3-8286-d29d74401077","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/entities","description":"

This endpoint retrieves a list of entities.

\n","urlObject":{"protocol":"https","path":["v2","entities"],"host":["api","arthuronline","co","uk"],"query":[{"disabled":true,"description":{"content":"

Filter by type of service

\n","type":"text/plain"},"key":"service","value":null}],"variable":[]}},"response":[{"id":"652d52ff-becb-437c-97fd-31650e6e8367","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/entities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"\",\n \"name\": \"Company\",\n \"address\": \"Address name, Address line 1, Address line 2, City, County, POSTCODE, Country\",\n \"address_line_1\": \"Address line 1\",\n \"address_line_2\": \"Address line 2\",\n \"city\": \"City\",\n \"county\": \"County\",\n \"country\": \"United Kingdom\",\n \"postcode\": \"POSTCODE\",\n \"website\": \"Company website\",\n \"phone_home\": \"123\",\n \"phone_work\": \"123\",\n \"phone_mobile\": \"123\",\n \"email\": \"companyEmail@gmail.com\",\n \"registration_status\": \"active\",\n \"company\": \"Company name\",\n \"vat_no\": 1,\n \"contacts\": [\n {\n \"id\": 2,\n \"name\": \"Company Owner\",\n \"main_contact\": true,\n \"phone_home\": \"132\",\n \"phone_work\": \"132\",\n \"phone_mobile\": \"132\",\n \"email\": \"contactemail@gmail.com\",\n \"registration_status\": \"active\"\n }\n ],\n \"tags\": [],\n \"modified\": \"2020-06-26T14:09:12+01:00\",\n \"created\": \"2020-06-26T13:01:15+01:00\"\n },\n {\n \"id\": 4,\n \"title\": \"\",\n \"name\": \"Company\",\n \"address\": \"Address name, Address line 1, Address line 2, City, County, POSTCODE, Country\",\n \"address_line_1\": \"Address line 1\",\n \"address_line_2\": \"Address line 2\",\n \"city\": \"City\",\n \"county\": \"County\",\n \"country\": \"United Kingdom\",\n \"postcode\": \"POSTCODE\",\n \"website\": \"Company website\",\n \"phone_home\": \"123\",\n \"phone_work\": \"123\",\n \"phone_mobile\": \"123\",\n \"email\": \"companyEmail@gmail.com\",\n \"registration_status\": \"active\",\n \"company\": \"Company name\",\n \"vat_no\": 1,\n \"contacts\": [\n {\n \"id\": 5,\n \"name\": \"Company Owner\",\n \"main_contact\": true,\n \"phone_home\": \"132\",\n \"phone_work\": \"132\",\n \"phone_mobile\": \"132\",\n \"email\": \"contactemail@gmail.com\",\n \"registration_status\": \"active\"\n }\n ],\n \"tags\": [],\n \"modified\": \"2020-06-26T14:09:12+01:00\",\n \"created\": \"2020-06-26T13:01:15+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"75281203-1966-4ec3-8286-d29d74401077"},{"name":"View Entity","id":"399c0bc9-e40c-4e78-9bf5-5b75146374f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/entities/{{entity_id}}","description":"

This API endpoint retrieves the details of a single entity, identified by its unique entity_id.

Use this endpoint to view the specific details of a entity.

\n","urlObject":{"protocol":"https","path":["v2","entities","{{entity_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"46ce0a4e-b5f7-4dfb-ad6d-f57d56cfe989","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/entities/{{entity_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"\",\n \"name\": \"Company\",\n \"address\": \"Address name, Address line 1, Address line 2, City, County, POSTCODE, United Kingdom\",\n \"address_line_1\": \"Address line 1\",\n \"address_line_2\": \"Address line 2\",\n \"city\": \"City\",\n \"county\": \"County\",\n \"country\": \"United Kingdom\",\n \"postcode\": \"POSTCODE\",\n \"website\": \"Company website\",\n \"phone_home\": \"123\",\n \"phone_work\": \"123\",\n \"phone_mobile\": \"123\",\n \"email\": \"companyEmail@gmail.com\",\n \"registration_status\": \"active\",\n \"company\": \"Company name\",\n \"vat_no\": 1,\n \"contacts\": [\n {\n \"id\": 2,\n \"name\": \"Company Owner\",\n \"main_contact\": true,\n \"phone_home\": \"132\",\n \"phone_work\": \"132\",\n \"phone_mobile\": \"132\",\n \"email\": \"contactemail@gmail.com\",\n \"registration_status\": \"active\"\n }\n ],\n \"tags\": [],\n \"modified\": \"2020-06-26T14:09:12+01:00\",\n \"created\": \"2020-06-26T13:01:15+01:00\"\n }\n}"}],"_postman_id":"399c0bc9-e40c-4e78-9bf5-5b75146374f8"},{"name":"Create Entity","id":"fb83de88-0f18-477f-aad6-7079955108ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/entities","description":"

Use this endpoint to create a new entity. The API will return the saved data and a unique Entity ID.

\n
Currently only supports creating landlords and agents
\n

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Required?
company	company ltd	String	No
email	company@email.com	String	Yes
first_name	Brian	String	Yes
last_name	Jackson	String	No
title	Mr	String	No
phone_work	12345	String	No
phone_home	12345	String	No
mobile	12345	String	No
group	Owner	String	Yes
vat_no	1	String	No
website	www.yourwebsite.com	String	No
invite_existing	true	Boolean	No
address_name	Queens road	String	No
address_line_1	42 Raven drive	String	No
address_line_2	3 Swan court	String	No
city	London	String	No
county	Greater London	String	No
country	United Kingdom	String	No
postcode	NW14DG	String	No

","urlObject":{"protocol":"https","path":["v2","entities"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"bfa982dd-e7e2-4ff4-aeea-2deee214dc71","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"title\":\"Mr\",\n\t\"first_name\":\"Michael\",\n\t\"last_name\":\"Brian\",\n\t\"company\":\"My Company\",\n\t\"address_name\":\"My Favourite One\",\n\t\"address_line_1\":\"31 Eagle Road\",\n\t\"address_line_2\":\"5 Raven Court\",\n\t\"city\":\"London\",\n\t\"county\":\"Greater London\",\n\t\"country\":\"United Kingdom\",\n\t\"postcode\":\"NW14SA\",\n\t\"website\":\"www.arthuronline.co.uk\",\n\t\"phone_work\":\"123\",\n\t\"phone_home\":\"1234\",\n\t\"mobile\":\"12345\",\n\t\"email\":\"emailCompany@gmail.com\",\n\t\"vat_no\":\"1\",\n \"group\":\"Owner\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/entities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"Mr\",\n \"name\": \"My Company\",\n \"address\": \"My Favourite One, 31 Eagle Road, 5 Raven Court, London, Greater London, NW14SA, United Kingdom\",\n \"address_line_1\": \"31 Eagle Road\",\n \"address_line_2\": \"5 Raven Court\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"country\": \"United Kingdom\",\n \"postcode\": \"NW14SA\",\n \"website\": \"companyWebsite@gmail.com\",\n \"phone_home\": \"1234\",\n \"phone_work\": \"123\",\n \"phone_mobile\": \"12345\",\n \"email\": \"emailCompany@gmail.com\",\n \"registration_status\": \"invited\",\n \"company\": \"My Company\",\n \"vat_no\": 0,\n \"contacts\": [\n {\n \"id\": 2,\n \"name\": \"Michael O'Brian\",\n \"main_contact\": true,\n \"phone_home\": \"1234\",\n \"phone_work\": \"123\",\n \"phone_mobile\": \"12345\",\n \"email\": \"emailCompany@gmail.com\",\n \"registration_status\": \"invited\"\n }\n ],\n \"tags\": [],\n \"modified\": \"2020-06-30T10:55:22+01:00\",\n \"created\": \"2020-06-30T10:55:22+01:00\"\n }\n}"}],"_postman_id":"fb83de88-0f18-477f-aad6-7079955108ae"},{"name":"Update Entity","id":"7b274cd0-022f-4974-96c0-4be28ea27d6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/entities/{{entity_id}}","description":"

This endpoint updates an existing entity using the same fields as the 'Add Entity' endpoint. Any fields that are not provided will not be changed. The API will return the updated data for the entity in the response.

Supported Fields

The following fields are supported for the request body

Field	Example	Type	Required?
company	company ltd	String	No
email	company@email.com	String	No
first_name	Brian	String	No
last_name	Jackson	String	No
title	Mr	String	No
phone_work	12345	String	No
phone_home	12345	String	No
mobile	12345	String	No
vat_no	20	Integer	No
website	www.yourwebsite.com	String	No
address_name	Queens road	String	No
address_line_1	42 Raven drive	String	No
address_line_2	3 Swan court	String	No
city	London	String	No
county	Greater London	String	No
country	United Kingdom	String	No
postcode	NW14DG	String	No

","urlObject":{"protocol":"https","path":["v2","entities","{{entity_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ebf74de3-5b12-4e04-b8cf-b2bcbe190065","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"city\":\"Kent\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/entities/{{entity_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 1,\n \"title\": \"Mr\",\n \"name\": \"My Company\",\n \"address\": \"My Favourite One, 31 Eagle Road, 5 Raven Court, Kent, Greater London, NW14SA, United Kingdom\",\n \"address_line_1\": \"31 Eagle Road\",\n \"address_line_2\": \"5 Raven Court\",\n \"city\": \"Kent\",\n \"county\": \"Greater London\",\n \"country\": \"United Kingdom\",\n \"postcode\": \"NW14SA\",\n \"website\": \"companyWebsite@gmail.com\",\n \"phone_home\": \"1234\",\n \"phone_work\": \"123\",\n \"phone_mobile\": \"12345\",\n \"email\": \"emailCompany@gmail.com\",\n \"registration_status\": \"invited\",\n \"company\": \"My Company\",\n \"vat_no\": 0,\n \"contacts\": [\n {\n \"id\": 2,\n \"name\": \"Michael O'Brian\",\n \"main_contact\": true,\n \"phone_home\": \"1234\",\n \"phone_work\": \"123\",\n \"phone_mobile\": \"12345\",\n \"email\": \"emailCompany@gmail.com\",\n \"registration_status\": \"invited\"\n }\n ],\n \"tags\": [],\n \"modified\": \"2020-06-30T10:55:22+01:00\",\n \"created\": \"2020-06-30T10:55:22+01:00\"\n }\n}"}],"_postman_id":"7b274cd0-022f-4974-96c0-4be28ea27d6f"},{"name":"🆕 Delete Entity","id":"fe93a1dd-3679-41b6-85fa-b1af9febe84c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/entities/{{entity_id}}","description":"

This endpoint deletes an existing entity using the entity id.

Here you can find the full list of endpoints for the Entities area of the system

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8d9dbf2f-e9bd-4b1e-a305-b88f0b9efc2b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"41fc879d-d2e6-490e-91fb-f144fdf97fad"}}],"_postman_id":"8d530c07-974e-48fc-a762-f540443a282a"},{"name":"Conversations","item":[{"name":"Assets","item":[{"name":"List Assets on Conversation","id":"0bc650f8-b2e3-499b-acc5-37671a039a74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/conversations/{{conversation_id}}/assets","description":"

This endpoint retrieves a list of assets associated with the given conversation ID.

\n","urlObject":{"protocol":"https","path":["v2","conversations","{{conversation_id}}","assets"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"0bc650f8-b2e3-499b-acc5-37671a039a74"}],"id":"9123580e-65e9-412e-9845-f67373291f52","description":"

Here you can find the full list of endpoints for the Assets area of the system related to a conversation.

\n","_postman_id":"9123580e-65e9-412e-9845-f67373291f52"},{"name":"Messages","item":[{"name":"List Messages Related To Conversation","id":"2454ace0-f099-4c3a-8a11-50536c3a05fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/conversations/{{conversation_id}}/messages","description":"

This retrieves a list of messages related to a conversation id.

\n","urlObject":{"protocol":"https","path":["v2","conversations","{{conversation_id}}","messages"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"ff842a97-f1ac-41eb-bbb2-528c065c3d05","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/conversations/{{conversation_id}}/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"conversation_id\": 2,\n \"title\": \"subject\",\n \"message\": \"Hello\",\n \"sent_by_me\": true,\n \"model\": \"Property\",\n \"model_id\": 3,\n \"parent_id\": 4,\n \"is_group\": false,\n \"total_replies\": 2,\n \"created_by\": {\n \"id\": 5,\n \"name\": \"Brian Acton\",\n \"group\": \"manager\"\n },\n \"recipients\": [\n {\n \"id\": 6,\n \"full_name\": \"Dan Dudley\",\n \"is_read\": false\n }\n ],\n \"sent_by\": {\n \"id\": 5,\n \"name\": \"Brian Acton\"\n },\n \"created\": \"2020-06-04T14:29:14+01:00\",\n \"modified\": \"2020-06-04T14:29:14+01:00\"\n },\n {\n \"id\": 12,\n \"conversation_id\": 2,\n \"title\": \"subject\",\n \"message\": \"Hello\",\n \"sent_by_me\": true,\n \"model\": \"Property\",\n \"model_id\": 3,\n \"parent_id\": 1,\n \"is_group\": false,\n \"total_replies\": 2,\n \"created_by\": {\n \"id\": 5,\n \"name\": \"Brian Acton\",\n \"group\": \"manager\"\n },\n \"recipients\": [\n {\n \"id\": 6,\n \"full_name\": \"Dan Dudley\",\n \"is_read\": false\n }\n ],\n \"sent_by\": {\n \"id\": 6,\n \"name\": \"Dan Dudley\"\n },\n \"created\": \"2020-06-04T14:22:13+01:00\",\n \"modified\": \"2020-06-04T14:29:14+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"2454ace0-f099-4c3a-8a11-50536c3a05fa"},{"name":"🆕 View Message Related To Conversation","id":"806c9114-b472-4b97-bdee-946a36fe5dee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/conversations/{{conversation_id}}/messages/{{message_id}}","description":"

This API endpoint retrieves the details of a single message, identified by its unique message_id.

Use this endpoint to view the specific details of a message within a conversation.

\n","urlObject":{"protocol":"https","path":["v2","conversations","{{conversation_id}}","messages","{{message_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"cab46fcb-5327-4f53-8c9a-27e8f16f753f","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/conversations/{{conversation_id}}/messages/{{message_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"conversation_id\": 2,\n \"title\": \"subject\",\n \"message\": \"Hello\",\n \"sent_by_me\": true,\n \"model\": \"Property\",\n \"model_id\": 3,\n \"parent_id\": 4,\n \"is_group\": false,\n \"total_replies\": 2,\n \"created_by\": {\n \"id\": 5,\n \"name\": \"Brian Acton\",\n \"group\": \"manager\"\n },\n \"recipients\": [\n {\n \"id\": 6,\n \"full_name\": \"Dan Dudley\",\n \"is_read\": false\n }\n ],\n \"sent_by\": {\n \"id\": 5,\n \"name\": \"Brian Acton\"\n },\n \"created\": \"2020-06-04T14:29:14+01:00\",\n \"modified\": \"2020-06-04T14:29:14+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 2,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"806c9114-b472-4b97-bdee-946a36fe5dee"},{"name":"Add Messages Related To Conversation","id":"1f058746-d284-40f3-992d-2ed5b0fc83b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arthuronline.co.uk/v2/conversations/{{conversation_id}}/messages","description":"

Use this endpoint to add a new message related to a conversation. The API will return the saved data.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
message	It's done	String	Yes

","urlObject":{"protocol":"https","path":["v2","conversations","{{conversation_id}}","messages"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"3d1ffa4f-2277-4d7a-b0d0-5907cd271309","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"message\":\"No problem\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/conversations/{{conversation_id}}/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\"status\": 200,\n \"data\": {\n \"id\": 123,\n \"conversation_id\": 123,\n \"title\": \"Conversation Subject\",\n \"message\": \"No problem\",\n \"model\": \"Property\",\n \"model_id\": 123,\n \"parent_id\": 1234,\n \"is_group\": false,\n \"total_replies\": 1234,\n \"created_by\": {\n \"id\": 123,\n \"name\": \"Ronnie Wilson\",\n \"group\": \"manager\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\",\n \"entity_id\": 123,\n \"is_read\": true\n },\n {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\",\n \"entity_id\": 123,\n \"is_read\": false\n }\n ],\n \"sent_by\": {\n \"id\": 123,\n \"name\": \"Ronnie Wilson\"\n },\n \"created\": \"2020-06-02T14:29:14+01:00\",\n \"modified\": \"2020-06-02T14:29:14+01:00\"\n }\n}"}],"_postman_id":"1f058746-d284-40f3-992d-2ed5b0fc83b2"}],"id":"a91ec6cf-a54d-4b99-bc64-33987cf315e6","description":"

Here you can find the full list of endpoints for the Messages area of the system

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"fde4e33f-3192-4ddf-b7f2-3ea6f532ec0a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1e84215c-2608-4212-9130-77483ee7c2fa"}}],"_postman_id":"a91ec6cf-a54d-4b99-bc64-33987cf315e6"},{"name":"List Conversations","id":"38e24ad6-2645-4ec9-aff1-e1c178fab438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/conversations/{{conversation_id}}","description":"

This endpoint retrieves a list of conversations.

\n","urlObject":{"protocol":"https","path":["v2","conversations","{{conversation_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"6f5624ec-73cf-4cec-ab61-85fa191dea1c","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/conversations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"title\": \"Subject 1\",\n \"message_count\": 1,\n \"model\": \"\",\n \"model_id\": null,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Sure!\",\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"full_name\": \"Ronnie Wilson\"\n },\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"modified\": \"2020-04-22T12:03:28+01:00\"\n },\n {\n \"id\": 123,\n \"title\": \"Subject 2\",\n \"message_count\": 1,\n \"model\": \"Property\",\n \"model_id\": 1,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Remember to clean on friday.\",\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"full_name\": \"Ronnie Wilson\"\n },\n \"created\": \"2020-04-23T11:49:54+01:00\",\n \"modified\": \"2020-04-30T11:49:54+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 3,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"38e24ad6-2645-4ec9-aff1-e1c178fab438"},{"name":"🆕 View Conversation","id":"e89d3829-a640-4e1a-b393-46372be20839","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/conversations/{{conversation_id}}","description":"

This API endpoint retrieves the details of a single conversation, identified by its unique conversation_id.

Use this endpoint to view the specific details of a conversation.

\n","urlObject":{"protocol":"https","path":["v2","conversations","{{conversation_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a0e30b0c-04cc-457d-9575-d4dc5773a1f9","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/conversations/{{conversation_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"title\": \"Subject 1\",\n \"message_count\": 1,\n \"model\": \"\",\n \"model_id\": null,\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"recipients\": [\n {\n \"id\": 123,\n \"full_name\": \"Kevin Wilson\"\n }\n ],\n \"last_comment\": {\n \"message\": \"Sure!\",\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"full_name\": \"Ronnie Wilson\"\n },\n \"created\": \"2020-04-22T12:03:28+01:00\",\n \"modified\": \"2020-04-22T12:03:28+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 3,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}"}],"_postman_id":"e89d3829-a640-4e1a-b393-46372be20839"}],"id":"3924af96-5d3e-4e55-ba7d-04c22bf7236d","description":"

Here you can find the full list of endpoints for the Conversations area of the system including Messages

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b9b1ba1b-528e-4a65-8a5f-e56180a93c07"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"47e5494e-6a17-4e73-87ee-5175aee9437d"}}],"_postman_id":"3924af96-5d3e-4e55-ba7d-04c22bf7236d"},{"name":"Tags","item":[{"name":"List Tags On Resource","id":"9a83cc83-8e79-4fe4-a993-d1993df854c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tags/{{resource}}","description":"

This endpoint retrieves a list of tags related to the following resources:

Properties
Units
Tenancies
Tasks
Applicants
Viewings

\n","urlObject":{"protocol":"https","path":["v2","tags","{{resource}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"464892f1-caab-440d-81d5-334565f273d9","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tags/{{resource}}"},"status":"List Tags On Resource","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"tag one\",\n \"color\": \"sky\"\n },\n {\n \"id\": 123,\n \"name\": \"tag two\",\n \"color\": \"lightgreen\"\n },\n {\n \"id\": 123,\n \"name\": \"tag three\",\n \"color\": \"purple\"\n }\n ]\n}"}],"_postman_id":"9a83cc83-8e79-4fe4-a993-d1993df854c0"},{"name":"View Tag","id":"c7ba3f3f-bda1-4959-b7c5-bcddf3aae2a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/tags/{{tag_id}}","description":"

This API endpoint retrieves the details of a single tag, identified by its unique tag_id.

Use this endpoint to view the specific details of a tag.

\n","urlObject":{"protocol":"https","path":["v2","tags","{{tag_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"228aa7ee-f4db-41e7-ac7a-cf8e3b257caf","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tags/{{tag_id}}"},"status":"View Tag","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"Tag one\",\n \"color\": \"sky\"\n }\n}"}],"_postman_id":"c7ba3f3f-bda1-4959-b7c5-bcddf3aae2a7"},{"name":"Add Tag On Resource","id":"ab5da588-ec6e-4268-b165-85e9a5647ccb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/tags/{{resource}}","description":"

Use this endpoint to create a new tag record on a resource. The API will return the saved data and a unique tag ID.

\n
Tags can be added to resources such as tenancies, tasks, units, applicants, viewings, and properties.
If field color not provided it will select a random color.
\n

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
name	All fixed	String	Yes
color	Blue	String	No

","urlObject":{"protocol":"https","path":["v2","tags","{{resource}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"4da093c8-bf2c-4576-9e18-5a9a251f1fea","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Almost done\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tags/{{resource}}"},"status":"Add Tag On Resource","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"Almost done\",\n \"color\": \"red\"\n }\n}"}],"_postman_id":"ab5da588-ec6e-4268-b165-85e9a5647ccb"},{"name":"Update Tag","id":"eb9e02cd-7a3d-4526-9aa2-8c73cf11140c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tags/{{tag_id}}","description":"

This endpoint updates an existing tag using the same fields as the 'Add Tag' endpoint. The API will return the updated data for the tag in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
name	All fixed	String	No
color	Blue	String	No

","urlObject":{"protocol":"https","path":["v2","tags","{{tag_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"af540a49-095c-4434-a567-32ddca930c96","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Almost done updated\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/tags/{{tag_id}}"},"status":"Update Tag","_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"name\": \"Almost done updated\",\n \"color\": \"red\"\n }\n}"}],"_postman_id":"eb9e02cd-7a3d-4526-9aa2-8c73cf11140c"}],"id":"2bf5f5b4-ab7d-4fc5-8f81-39e41905fff8","description":"

Here you can find the full list of endpoints for the Tags area of the system.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"dfdf3041-e4d9-4eff-b5d7-bf2e8867bb08"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b721d059-5c41-46e3-aa57-2f4d7f0fcaec"}}],"_postman_id":"2bf5f5b4-ab7d-4fc5-8f81-39e41905fff8"},{"name":"Notes","item":[{"name":"Tags","item":[{"name":"🆕 List Tags on Note","id":"0dd52500-5797-42c6-b062-488b22726a34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}/tags","description":"

This endpoint retrieves a list of tags associated with the given note ID.

\n","urlObject":{"protocol":"https","path":["v2","notes","{{note_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"3e6761e4-70d2-45dc-89e4-619696ecd504","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 33843,\n \"name\": \"1000 spend limit\",\n \"color\": \"blue\"\n },\n {\n \"id\": 49572,\n \"name\": \"benefits lapsed\",\n \"color\": \"blue\"\n }\n ]\n}"}],"_postman_id":"0dd52500-5797-42c6-b062-488b22726a34"},{"name":"🆕 Tag Note","id":"1eaedf87-b361-4e09-8ab8-fa4b4ac111dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}/tags","description":"

Use this endpoint to create a new tag record for a note. The API will return the saved data and a unique note ID.

Supported Fields

The following fields are supported for the request body
Tag field should be a valid tag ID or name.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	[\"123\"]	Array(String)	Yes

","urlObject":{"protocol":"https","path":["v2","notes","{{note_id}}","tags"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"f440706e-f656-4b0d-89ff-eade52d941b7","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":[\"1234\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/applicants/{{note_id}}/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1234,\n \"name\": \"Tag one\",\n \"color\": \"orange\"\n },\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 12,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"1eaedf87-b361-4e09-8ab8-fa4b4ac111dc"},{"name":"🆕 Untag Note","id":"c646a992-d4a2-4f65-a35c-3ee33de15d8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}/untag","description":"

Use this endpoint to unassign tag record from the note. The API will return the saved data. Tag field should be a valid tag ID or name.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
tag	\"1234\"	String	Yes

","urlObject":{"protocol":"https","path":["v2","notes","{{note_id}}","untag"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"b16019b7-3be6-4e67-a53d-c995b9d1b672","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"tag\":\"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/nots/{{note_id}}/untag"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"Tag two\",\n \"color\": \"purple\"\n },\n {\n \"id\": 12,\n \"name\": \"Tag three\",\n \"color\": \"sky\"\n }\n ]\n}"}],"_postman_id":"c646a992-d4a2-4f65-a35c-3ee33de15d8a"},{"name":"🆕 Untag All Note Tags","id":"3b639465-8d24-49aa-a29b-5343f48f53ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}/untag_all","description":"

Use this endpoint to unassign all tags from a note.

\n","urlObject":{"protocol":"https","path":["v2","notes","{{note_id}}","untag_all"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"a6c6b787-45c0-4699-97aa-cbb9dfa80f66","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}/untag_all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": []\n}"}],"_postman_id":"3b639465-8d24-49aa-a29b-5343f48f53ae"}],"id":"5b7de06d-f47b-4a75-b1a2-d1825dae6508","description":"

This section provides resources for dealing with Tags related to a note.

\n","_postman_id":"5b7de06d-f47b-4a75-b1a2-d1825dae6508"},{"name":"List Notes","id":"08b069dd-3aab-4290-9ee6-570fb58e67b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/notes","description":"

This endpoint retrieves a list of notes .

\n","urlObject":{"protocol":"https","path":["v2","notes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"2ca49294-c30e-413a-841c-66666b1ac375","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":"https://api.arthuronline.co.uk/v2/notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\"last_edited_by\": {\n \t\"id\": null,\n \t\"full_name\": null\n \t},\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \t\"modified\": \"2020-05-28T11:57:55+01:00\"\n },\n {\n \"id\": 1234,\n \"content\": \"Remember this note , please\",\n \"created_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \t\"last_edited_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n \t},\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \t\"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"current\": 1,\n \"count\": 2,\n \"pageCount\": 1,\n \"limit\": 20\n }\n}\n"}],"_postman_id":"08b069dd-3aab-4290-9ee6-570fb58e67b0"},{"name":"View Note","id":"48a30226-419a-4a40-beed-e18bb8634119","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}","description":"

This API endpoint retrieves the details of a single note, identified by its unique id.

\n","urlObject":{"protocol":"https","path":["v2","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"004a60bc-2ae0-4407-8447-83038d8dbdef","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \t\"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \t\"id\": 123,\n \t\"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": 123,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"48a30226-419a-4a40-beed-e18bb8634119"},{"name":"Update Note","id":"68067f0f-94c7-44f1-8011-a404b3bd81de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}","description":"

This endpoint updates an existing note using the same fields. The API will return the updated data for the note in the response.

Supported Fields

The following fields are supported for the request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Example	Type	Required?
content	Moving away	String	No

","urlObject":{"protocol":"https","path":["v2","notes","{{note_id}}"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[{"id":"232db718-af68-4903-9430-06f99cf3d9e4","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"id\": 123,\n \"content\": \"Remember this note\",\n \"created_by\": {\n \"id\": 123,\n \"full_name\": \"Ronnie Wilson\"\n },\n \"last_edited_by\": {\n \"id\": null,\n \"full_name\": null\n },\n \"last_edited_date\": \"2020-05-28T11:57:56+01:00\",\n \"tags\": [\n \t\"one\",\n \t\"two\"\n ],\n \"property_id\": 123,\n \"unit_id\": 123,\n \"tenancy_id\": null,\n \"created\": \"2020-05-28T11:57:55+01:00\",\n \"modified\": \"2020-05-28T11:57:55+01:00\"\n }\n}"}],"_postman_id":"68067f0f-94c7-44f1-8011-a404b3bd81de"},{"name":"Delete Note","id":"6af655d6-accc-40bf-8f29-388e856acf50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.arthuronline.co.uk/v2/notes/{{note_id}}","description":"

This endpoint deletes an existing note using the note id.

Here you can find the full list of endpoints for the Notes area of the system.

\n","_postman_id":"ffe2f51c-9d82-4eb5-bd5a-5d6c933f9bf3"},{"name":"Types","item":[{"name":"Applicant","item":[{"name":"🆕 Applicant types","id":"6bf9c215-6c7f-442d-945f-31d6583e5a42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/applicant_types","urlObject":{"protocol":"https","path":["v2","applicant_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"6bf9c215-6c7f-442d-945f-31d6583e5a42"},{"name":"Citizen types","id":"4f5d6008-c0a6-4b0a-a446-a1891c0c66bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/citizen_types","urlObject":{"protocol":"https","path":["v2","citizen_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f5d6008-c0a6-4b0a-a446-a1891c0c66bf"},{"name":"Applicant statuses","id":"cac876df-d4a4-4cf1-9e39-b79f36ca31b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/applicant_statuses","urlObject":{"protocol":"https","path":["v2","applicant_statuses"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"cac876df-d4a4-4cf1-9e39-b79f36ca31b5"},{"name":"Visa types","id":"6ee4a896-96d1-48b9-b043-a3b14e35a85e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/visa_types","urlObject":{"protocol":"https","path":["v2","visa_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ee4a896-96d1-48b9-b043-a3b14e35a85e"},{"name":"Student statuses","id":"e2a3d79f-4d3e-49fe-bb40-7c92c9b33d44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/student_statuses","urlObject":{"protocol":"https","path":["v2","student_statuses"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2a3d79f-4d3e-49fe-bb40-7c92c9b33d44"}],"id":"d04849b1-25c2-4d48-8332-9a0b8ee52650","_postman_id":"d04849b1-25c2-4d48-8332-9a0b8ee52650","description":""},{"name":"Task","item":[{"name":"Task types","id":"a14b9881-cb16-43b8-993f-35d5d20740f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/task_types","urlObject":{"protocol":"https","path":["v2","task_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"a14b9881-cb16-43b8-993f-35d5d20740f6"},{"name":"Subtask templates","id":"3b96c107-0beb-48a3-a0be-9b730e5f2492","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/subtask_templates","urlObject":{"protocol":"https","path":["v2","subtask_templates"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"3b96c107-0beb-48a3-a0be-9b730e5f2492"},{"name":"🆕 Task statuses","id":"2d8713db-d880-4fa7-9fb8-5afa681a9c84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/task_statuses","urlObject":{"protocol":"https","path":["v2","task_statuses"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d8713db-d880-4fa7-9fb8-5afa681a9c84"}],"id":"4fe46f27-0f68-4555-ae82-3de7cb163829","_postman_id":"4fe46f27-0f68-4555-ae82-3de7cb163829","description":""},{"name":"Profession types","id":"9c475703-dbd6-4467-9c6c-fe9ac35a6433","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/profession_types","urlObject":{"protocol":"https","path":["v2","profession_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c475703-dbd6-4467-9c6c-fe9ac35a6433"},{"name":"Access details types","id":"4300e93a-e0ee-403a-9e3d-333162ba2a54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/access_details_types","urlObject":{"protocol":"https","path":["v2","access_details_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"4300e93a-e0ee-403a-9e3d-333162ba2a54"},{"name":"Area types","id":"3b290a64-0d0d-4109-9983-fd14ed7c2701","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/area_types","urlObject":{"protocol":"https","path":["v2","area_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"3b290a64-0d0d-4109-9983-fd14ed7c2701"},{"name":"Certificate types","id":"f6e4e19b-aa33-46a8-a6e3-22ead9f8e2a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/certificate_types","urlObject":{"protocol":"https","path":["v2","certificate_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6e4e19b-aa33-46a8-a6e3-22ead9f8e2a3"},{"name":"Contract types","id":"9cea5e2d-a794-4731-9ae9-ab67884e2cf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/contract_types","urlObject":{"protocol":"https","path":["v2","contract_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"9cea5e2d-a794-4731-9ae9-ab67884e2cf0"},{"name":"Countries","id":"ade4b3ca-8aba-42b1-90d5-38ed5d94cd60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/countries","urlObject":{"protocol":"https","path":["v2","countries"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"ade4b3ca-8aba-42b1-90d5-38ed5d94cd60"},{"name":"Faq types","id":"d3d5da66-4891-4383-9d92-3280a360348d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/faq_types","urlObject":{"protocol":"https","path":["v2","faq_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3d5da66-4891-4383-9d92-3280a360348d"},{"name":"Feature types","id":"c4935a05-3df0-4417-b72d-a225a9401001","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/feature_types","urlObject":{"protocol":"https","path":["v2","feature_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"c4935a05-3df0-4417-b72d-a225a9401001"},{"name":"Genders","id":"a08352cc-b16d-4cfd-9310-6be8b36b6f1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/genders","urlObject":{"protocol":"https","path":["v2","genders"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"a08352cc-b16d-4cfd-9310-6be8b36b6f1a"},{"name":"Home owner statuses","id":"c94b485e-c14d-49bf-b9d2-2725165d9149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/home_owner_statuses","urlObject":{"protocol":"https","path":["v2","home_owner_statuses"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"c94b485e-c14d-49bf-b9d2-2725165d9149"},{"name":"Offer frequency types","id":"3a655ee6-47e1-4a3a-8e1e-b9a773f770d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/offer_frequencies","urlObject":{"protocol":"https","path":["v2","offer_frequencies"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"3a655ee6-47e1-4a3a-8e1e-b9a773f770d0"},{"name":"🆕 Payment types","id":"e592e009-495e-44a8-a923-d8d1d7c9a317","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/payment_types","urlObject":{"protocol":"https","path":["v2","payment_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"e592e009-495e-44a8-a923-d8d1d7c9a317"},{"name":"🆕 Property types","id":"aee20155-88fa-44f3-9a98-c6f386d4457e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/property_types","urlObject":{"protocol":"https","path":["v2","property_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"aee20155-88fa-44f3-9a98-c6f386d4457e"},{"name":"Service types","id":"e21aadb1-82bb-404e-a28a-aa312a397f65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/service_types","urlObject":{"protocol":"https","path":["v2","service_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"e21aadb1-82bb-404e-a28a-aa312a397f65"},{"name":"Tenancy statuses","id":"3abff6dc-2d4d-4154-9176-9fa6be0feaef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/tenancy_statuses","urlObject":{"protocol":"https","path":["v2","tenancy_statuses"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"3abff6dc-2d4d-4154-9176-9fa6be0feaef"},{"name":"Titles","id":"e1efe31e-e2a1-4d72-97e2-532c5d38d01b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"X-EntityID","value":"","type":"text"}],"url":"https://api.arthuronline.co.uk/v2/titles","urlObject":{"protocol":"https","path":["v2","titles"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1efe31e-e2a1-4d72-97e2-532c5d38d01b"},{"name":"Transaction description formats","id":"dde24a1f-5cc2-4cd1-bec2-99079c1c7aba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/description_formats","urlObject":{"protocol":"https","path":["v2","description_formats"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"dde24a1f-5cc2-4cd1-bec2-99079c1c7aba"},{"name":"Unit types","id":"b24bf802-1073-46c5-b894-0829b7878c17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/unit_types","description":"

We have an extra filter available on this endpoint to include just used unit_types.

https://api.arthuronline.co.uk/v2/unit_types?only_inclue_used=1

\n","urlObject":{"protocol":"https","path":["v2","unit_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"b24bf802-1073-46c5-b894-0829b7878c17"},{"name":"🆕 Unit status types","id":"dab42f52-b0d4-418c-942a-91b78fa65785","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.arthuronline.co.uk/v2/unit_statuses","urlObject":{"protocol":"https","path":["v2","unit_statuses"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"dab42f52-b0d4-418c-942a-91b78fa65785"},{"name":"Utility types","id":"82258fe1-b9c0-4aac-a950-a99ba42e6e64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/utility_types","urlObject":{"protocol":"https","path":["v2","utility_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"82258fe1-b9c0-4aac-a950-a99ba42e6e64"},{"name":"Vat codes","id":"9c635fe5-0669-41f5-a1f9-2fff7dcc282f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/vat_codes","urlObject":{"protocol":"https","path":["v2","vat_codes"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c635fe5-0669-41f5-a1f9-2fff7dcc282f"},{"name":"Asset types","id":"d5eabf2e-32eb-4628-9750-2660b9b0cbd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/asset_types","urlObject":{"protocol":"https","path":["v2","asset_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5eabf2e-32eb-4628-9750-2660b9b0cbd9"},{"name":"Viewing statuses","id":"66154058-1f9c-4b1c-ae54-c634e7948c47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "},{"key":"X-EntityID","type":"text","value":""}],"url":"https://api.arthuronline.co.uk/v2/viewing_statuses","urlObject":{"protocol":"https","path":["v2","viewing_statuses"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"66154058-1f9c-4b1c-ae54-c634e7948c47"},{"name":"Tenancy types","id":"dea6340b-2912-4ba6-8afa-4611aba27b3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancy_types","urlObject":{"protocol":"https","path":["v2","tenancy_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"dea6340b-2912-4ba6-8afa-4611aba27b3c"},{"name":"Tenancy subtypes","id":"4a8c02d2-095a-4737-a19f-d4faa995cef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancy_sub_types","urlObject":{"protocol":"https","path":["v2","tenancy_sub_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a8c02d2-095a-4737-a19f-d4faa995cef6"},{"name":"Tenancy subtypes on Tenancy Type","id":"a920a708-ad06-480d-b968-eebd242fada0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/tenancy_types/{id}/tenancy_sub_types","urlObject":{"protocol":"https","path":["v2","tenancy_types","{id}","tenancy_sub_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"a920a708-ad06-480d-b968-eebd242fada0"},{"name":"Transaction types","id":"53c11b4c-71f3-4dad-be4a-41a748f349ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/transaction_types","urlObject":{"protocol":"https","path":["v2","transaction_types"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"53c11b4c-71f3-4dad-be4a-41a748f349ad"},{"name":"Conversation statuses","id":"43c7f842-4569-46a5-8c46-35fcb5f3d678","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/conversation_statuses","urlObject":{"protocol":"https","path":["v2","conversation_statuses"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"43c7f842-4569-46a5-8c46-35fcb5f3d678"},{"name":"Rent frequencies","id":"fe78808f-0820-4983-bfbf-ffaca82f28a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/rent_frequencies","urlObject":{"protocol":"https","path":["v2","rent_frequencies"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe78808f-0820-4983-bfbf-ffaca82f28a2"},{"name":"Workorder statuses","id":"989e4f51-e2a7-44a9-bf78-df8a9e3b2567","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/workorder_statuses","urlObject":{"protocol":"https","path":["v2","workorder_statuses"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"989e4f51-e2a7-44a9-bf78-df8a9e3b2567"},{"name":"Recurring Frequencies","id":"b1f878ae-b69b-4d50-b79d-2b9e88f31823","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.arthuronline.co.uk/v2/frequencies/recurring","urlObject":{"protocol":"https","path":["v2","frequencies","recurring"],"host":["api","arthuronline","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1f878ae-b69b-4d50-b79d-2b9e88f31823"}],"id":"61858ee5-c14b-4a8c-8f54-8ef4974d25bb","description":"

See lists of all possible values for each system type.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c75c6758-7d1c-453c-bcc7-ef0d25f47dd3"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f6fe8ed9-4d80-419c-a285-9ac56df8d131"}}],"_postman_id":"61858ee5-c14b-4a8c-8f54-8ef4974d25bb"}],"id":"ac531de6-1a6b-4c70-9e29-6bc5b87bb4b7","description":"

This folder contains all the available endpoints that can be used in Arthur v2.

You can use these endpoints to interact with the Arthur API and perform various operations such as retrieving data, creating new records, updating existing records, and removing records.

Each endpoint is associated with a specific HTTP method and accepts or returns data in JSON format.

\n
Please refer to the documentation for more details on how to use these endpoints.
\n

\n","_postman_id":"ac531de6-1a6b-4c70-9e29-6bc5b87bb4b7"}],"id":"80d260a6-b55c-4b38-b5cc-2c97561425d4","description":"

The documentation provided here is for Version 2 of Arthur Online's HTTP API, which comes with a number of improvements, including better data structure, enhanced validation and error feedback in responses, and faster response times.

The API will be introduced in modules, with each module covering the major functions of the system. For each request, you can find example responses and the supported filters.

\n","_postman_id":"80d260a6-b55c-4b38-b5cc-2c97561425d4"},{"name":"🎣 Webhook","item":[{"name":"🚀 Getting Started","item":[{"name":"📚 Step-by-Step Guide","item":[],"id":"203e991d-a83c-4684-a52f-b99d1862c22c","description":"

To subscribe to a new webhook, navigate to the webhook page.

\n\n

Then, click \"Subscribe New Webhook\".
Select the event you wish to subscribe to and input your webhook URL.

\n\n

Finally, click \"Save Changes\".

\n\n

After subscribing to a webhook, the system will send a payload to the provided URL each time the corresponding event is triggered in the future.

\n","_postman_id":"203e991d-a83c-4684-a52f-b99d1862c22c"}],"id":"dc130d00-58d8-42f9-b9a3-0884d8d23380","description":"

To make use of Arthur Webhooks, developers need to initially subscribe to particular events by providing their webhook URL.

\n","_postman_id":"dc130d00-58d8-42f9-b9a3-0884d8d23380"},{"name":"📋 Useful Information","item":[{"name":"📩 Headers","item":[],"id":"c817058f-069a-4dcf-87d6-c6f5c55527c7","description":"

When you receive a webhook request, the headers that you will receive as part of the HTTP request will be as follows:

{\n    \"content-length\":\"{{payload-length}}\",\n    \"content-type\":\"application/x-www-form-urlencoded\",\n    \"user-agent\":\"CakePHP\",\n    \"connection\":\"close\",\n    \"host\":\"host-url\"\n}\n\n

\n","_postman_id":"c817058f-069a-4dcf-87d6-c6f5c55527c7"},{"name":"🔔 Triggers","item":[],"id":"52ec5010-1da8-44ae-955e-0dd45324b422","description":"

Webhooks provide triggers for events that can be subscribed to. You can choose to subscribe to one or more of the available events, which are listed below along with their corresponding model and event name.

Model	Event Name	Response
AccessKey	Access Keys (Individual) Expired
Applicant	Applicant added via Middleware	Example payload
Applicant	Applicant added	Example payload
Applicant	Applicant updated via Middleware	Example payload
Asset	File shared with all occupants
Asset	File uploaded
AssetSharingPerson	Asset sharing
Attachment	File attachment shared
Certificate	Certificate Added
Certificate	Certificate Expired Today
Certificate	Certificate Expires in 30 Days
Certificate	Certificate Expires in 7 Days
Inventory	Inventory added
Inventory	Inventory expired today
Message	Email sent
Notice	Notice Added
Notice	Notice expired today
Notice	Notice expires in 30 days
Notice	Notice expires in 7 days
Person	Add Contractor
Person	Add Property Manager
Person	Add Property Owner
Person	Invite Contractor
Person	Invite Property Manager
Person	Invite Property Owner
Property	Property created
Recurring	Recurring Ended
Reminder	Property Manager Email
Reminder	Property Manager Notification
Reminder	Property Manager SMS
Reminder	Property Owner Email
Reminder	Property Owner Notification
Reminder	Property Owner SMS
Reminder	Tenant Email
Reminder	Tenant Notification
Reminder	Tenant SMS
RentReview	Rent Review added
RentReview	Rent Review completed
RentReview	Rent Review due today
RentReview	Rent Review in progress
Renter	Invite Tenant
Renter	Tenant added to tenancy
ReportEntity	Shared Report
SyncScheduler	Quickbooks Start Sync
SyncScheduler	Quickbooks Sync Done
SyncScheduler	Quickbooks Sync Failed
SyncScheduler	Quickbooks Sync Success
SyncScheduler	Xero Start Sync
SyncScheduler	Xero Sync Done
SyncScheduler	Xero Sync Failed
SyncScheduler	Xero Sync Success
Task	Property Manager shared workorder with tenants
Task	Task added
Task	Task cancelled
Task	Task set back to pending
Task	Task set to cancelled
Task	Task set to completed
Task	Task set to completed
Task	Task set to in progress
Task	Task set to live
Task	Task set to pending
Task	Task updated
Task	Tenant raises an issue
Task	Tenant updated issue description
Tenancy	Moving in date confirmed by Contractor
Tenancy	Moving in date confirmed by Letting Agent
Tenancy	Moving out date confirmed by Contractor
Tenancy	Moving out date confirmed by Letting Agent
Tenancy	Prospective tenancy added by Letting Agent
Tenancy	Tenancy Expiring
Tenancy	Tenancy Reference set to Failed by Letting Agent
Tenancy	Tenancy Reference set to Failed by Property Manager
Tenancy	Tenancy Reference set to Passed by Letting Agent
Tenancy	Tenancy Reference set to Passed by Property Manager
Tenancy	Tenancy closing
Tenancy	Tenancy status set to approved
Tenancy	Tenancy status set to current
Tenancy	Tenancy status set to ending
Tenancy	Tenancy status set to past
Tenancy	Tenancy status set to periodic
Tenancy	Tenancy status set to prospective
Tenancy	Tenancy status set to rejected
Tenancy	Tenancy updated
Tenancy	Tenant requests ending tenancy
Tenancy	Tenant requests extending tenancy
TenancyChange	Change Tenancy
Transaction	Holding Deposit Receipt added by Property Manager
Transaction	Late rent 14 days
Transaction	Late rent 21 days
Transaction	Late rent 7 days
Transaction	Remitted to Property Owner Split
Transaction	Remitted to Property Owner
Unit	Unit Added
Unit	Unit set to available to let
Unit	Unit updated
UtilityReading	Utility Reading Added
Viewing	Added Letting Viewing by Property Manager	Example payload
Viewing	Added Sale Viewing by Property Manager
Viewing	Added Viewing by Letting Agent
Viewing	Updated Sale Viewing by Property Manager
Viewing	Updated status Sale Viewing by Property Manager
Viewing	Viewing Cancelled	Example payload
Viewing	Viewing offer entered	Example payload
Viewing	Viewing updated by Letting Agent
Viewing	Viewing updated by Property Manager
ViewingApplicant	Applicant added to viewing	Example payload
VulnerabilityProfile	Tenant COVID Profile updated
Workorder	New Workorder added
Workorder	Property Manager approves completed workorder
Workorder	Require approval from Property Owner
Workorder	Workorder Assigned to Contractor
Workorder	Workorder Cancelled
Workorder	Workorder On Hold
Workorder	Workorder Reallocated
Workorder	Workorder Resumed
WorkorderEntity	Contractor Invited to Workorder
WorkorderEntity	Contractor set workorder to completed
WorkorderEntity	Workorder Declined by Contractor
WorkorderInvoice	Contractor creates invoice
WorkorderInvoice	Property Manager set workorder invoice to Paid
WorkorderQuote	Contractor provided workorder quote
WorkorderQuote	Property Manager Accepted Quote
WorkorderQuote	Property Owner Accepted Quote
WorkorderQuote	Property Owner Rejected Quote
WorkorderQuote	Workorder Accepted by Contractor to Quote

","_postman_id":"52ec5010-1da8-44ae-955e-0dd45324b422"},{"name":"🗒️ Logs","item":[],"id":"0fdf6ccc-4c1d-46ab-bc26-3500a7f8b56e","description":"

Once an event has been triggered, a log of the payload being sent to your webhook is recorded for future reference. To access these logs, simply click on the \"View logs\" button located on your webhook page. This page will display a comprehensive list of all webhook events triggered along with the corresponding timestamps, status, and server response.

By reviewing the webhook logs, developers can gain valuable insights into their system's performance, identify areas for improvement, and troubleshoot any issues that may arise. Additionally, this feature can aid in the debugging process by providing developers with detailed information regarding the status of each webhook event.

I. Go to the Webhook page
II. Select an Event and click on \"View Logs\"

\n\n

III. Check the status of outgoing triggers.

","_postman_id":"0fdf6ccc-4c1d-46ab-bc26-3500a7f8b56e"}],"id":"d7afb81f-a2de-4df2-83a8-ac63f37a0dbe","_postman_id":"d7afb81f-a2de-4df2-83a8-ac63f37a0dbe","description":""},{"name":"🧪 Testing","item":[],"id":"49ef5f10-964d-4eed-9e42-a7e6b4aaa27a","description":"

To test webhook messages, we suggest using RequestBin (https://pipedream.com/requestbin) as a tool to receive and inspect the incoming requests.

\n","_postman_id":"49ef5f10-964d-4eed-9e42-a7e6b4aaa27a"}],"id":"ed84be39-fdd4-4d38-a2a4-f1bdff27b095","description":"

With webhooks, you can keep track of and react to events occurring in your organization, which gives you a live overview of the activity and enables you to expand and integrate Arthur with your systems.

Arthur's webhooks provide a way for your application to receive notifications about events that take place in your Arthur account.

If you want to configure webhooks, you can navigate to the Automated Events option in your account and utilize the Webhook Setting page to indicate the callback URL. Additionally, you can find predefined events in your account settings under the Webhooks section.

Whenever an event occurs in your account, such as adding a new property or editing a tenancy, the relevant JSON data will be sent to the specified callback URL via a webhook.

\n","_postman_id":"ed84be39-fdd4-4d38-a2a4-f1bdff27b095"},{"name":"💬 Getting Support","item":[],"id":"11da6feb-28f1-41e3-accc-8d0227c1260a","description":"

If you require assistance, please submit a ticket via the ticket portal: https://support.arthuronline.co.uk/support/home

If you encounter an API request failure. Make sure to provide the following details:

The complete request URL with the query string.
\n
The request payload.
\n
The HTTP response error code and corresponding text message.
\n

For any queries related to your third-party application, kindly contact the responsible developer and ask them to get in touch with us if they have any API-related questions.

\n","_postman_id":"11da6feb-28f1-41e3-accc-8d0227c1260a"}],"event":[{"listen":"prerequest","script":{"id":"d969ecef-5091-4ffa-b727-95df169f768e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a4a1e560-9a04-4ace-8940-c9f0f67f95f5","type":"text/javascript","exec":[""]}}],"variable":[{"value":"","type":"string","disabled":true}]}