{
  "opencollection": "1.0.0",
  "info": {
    "name": "Arthur Assets API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://auth.arthuronline.co.uk/oauth/authorize",
      "accessTokenUrl": "https://auth.arthuronline.co.uk/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Assets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Assets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.arthuronline.co.uk/v2/assets",
            "headers": [
              {
                "name": "X-EntityID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter by asset type (image, notimage, document, other)"
              },
              {
                "name": "main_image",
                "value": "",
                "type": "query",
                "description": "To display only main images, set this to true"
              },
              {
                "name": "created_from",
                "value": "",
                "type": "query",
                "description": "Filters assets by the created date, starting from the specified date. Use the format yyyy-mm-dd to input the date"
              },
              {
                "name": "created_to",
                "value": "",
                "type": "query",
                "description": "Filters assets by the created date, up to the specified date. Use the format yyyy-mm-dd to input the date."
              },
              {
                "name": "model",
                "value": "",
                "type": "query",
                "description": "Filter by attachment type (Property, Unit, Tenancy, Transaction)"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number, between 1 and the total number of pages."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items per page, between 1 and 100."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Field to sort the collection by."
              },
              {
                "name": "direction",
                "value": "",
                "type": "query",
                "description": "Sort direction."
              }
            ]
          },
          "docs": "This retrieves a list of assets.\n\nSee available filters below to customize the list of properties returned."
        },
        {
          "info": {
            "name": "Create Asset",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.arthuronline.co.uk/v2/assets",
            "headers": [
              {
                "name": "X-EntityID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "strict",
                "value": "",
                "type": "query",
                "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this endpoint to create a new asset. The API will return the saved data and a unique Asset ID.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nasset_type \n image \n String \n No \n\nname \n Inventory \n String \n No \n\nshare_manager \n true \n Boolean \n No \n\nshare_tenant \n false \n Boolean \n No \n\nshare_contractor \n true \n Boolean \n No \n\nshare_owner \n true \n Boolean \n No \n\nfile \n base64 \n String \n Yes \n\nmime_type \n application/pdf \n Strin"
        },
        {
          "info": {
            "name": "View Asset",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.arthuronline.co.uk/v2/assets/:asset_id",
            "headers": [
              {
                "name": "X-EntityID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "asset_id",
                "value": "",
                "type": "path",
                "description": "Arthur asset id."
              }
            ]
          },
          "docs": "This API endpoint retrieves the details of a single asset, identified by its unique  asset_id .\n\nUse this endpoint to view the specific details of an asset."
        },
        {
          "info": {
            "name": "Update Asset",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.arthuronline.co.uk/v2/assets/:asset_id",
            "headers": [
              {
                "name": "X-EntityID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "asset_id",
                "value": "",
                "type": "path",
                "description": "Arthur asset id."
              },
              {
                "name": "strict",
                "value": "",
                "type": "query",
                "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint updates an existing 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.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nasset_type \n image \n String \n No \n\nname \n inventory \n String \n No \n\nshare_manager \n true \n Boolean \n No \n\nshare_tenant \n false \n Boolean \n No \n\nshare_contractor \n true \n Boo"
        },
        {
          "info": {
            "name": "Delete Asset",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.arthuronline.co.uk/v2/assets/:asset_id",
            "headers": [
              {
                "name": "X-EntityID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "asset_id",
                "value": "",
                "type": "path",
                "description": "Arthur asset id."
              }
            ]
          },
          "docs": "This endpoint deletes an existing asset record using the asset id ."
        }
      ]
    }
  ],
  "bundled": true
}