{
  "opencollection": "1.0.0",
  "info": {
    "name": "Open API, powered by Propertyware Accounting Prospects API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-propertyware-client-id",
      "value": "{{x-propertyware-client-id}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Prospects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve all prospects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100."
              },
              {
                "name": "lastModifiedDateTimeStart",
                "value": "",
                "type": "query",
                "description": "Filters results to any item modified on or after the date time specified. "
              },
              {
                "name": "lastModifiedDateTimeEnd",
                "value": "",
                "type": "query",
                "description": "Filters results to any item modified on or prior to the date time specified. "
              },
              {
                "name": "orderby",
                "value": "",
                "type": "query",
                "description": "Indicates the field(s) and direction to sort the results in the response."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filters results to prospects with a specific status."
              },
              {
                "name": "portfolioID",
                "value": "",
                "type": "query",
                "description": "Filters results to prospects associated with a specific portfolio."
              },
              {
                "name": "buildingID",
                "value": "",
                "type": "query",
                "description": "Filters results to prospects associated with a specific building."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filters results to prospects with a specific type."
              },
              {
                "name": "includeCustomFields",
                "value": "",
                "type": "query",
                "description": "includeCustomFields"
              }
            ]
          },
          "docs": "Retrieves a list of prospects.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Read</code>\n<br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>type</code>, <code>lastmodifieddatetime</code>, <code>status</code>, <code>id</code>"
        },
        {
          "info": {
            "name": "Create a prospect",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a specific prospect.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Write</code>\n"
        },
        {
          "info": {
            "name": "Create prospects in bulk",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects/bulk",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates prospects in bulk.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">UNITS</span> - <code>Write</code>\n"
        },
        {
          "info": {
            "name": "Update a prospect custom fields (BETA)",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects/customfields",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p>\nUpdates an existing prospect custom fields<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Write</code>\n"
        },
        {
          "info": {
            "name": "Retrieve all prospect statuses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects/statuses"
          },
          "docs": "Retrieves a list of all prospect statuses<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Read</code>\n"
        },
        {
          "info": {
            "name": "Retrieve a prospect",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects/:prospectID",
            "params": [
              {
                "name": "prospectID",
                "value": "",
                "type": "path",
                "description": "Prospect ID"
              },
              {
                "name": "includeCustomFields",
                "value": "",
                "type": "query",
                "description": "includeCustomFields"
              }
            ]
          },
          "docs": "Retrieves a specific prospect.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Read</code>\n"
        },
        {
          "info": {
            "name": "Retrieve prospect campaign",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects/:prospectID/campaign",
            "params": [
              {
                "name": "prospectID",
                "value": "",
                "type": "path",
                "description": "Prospect ID"
              }
            ]
          },
          "docs": "Retrieves the campaign details of a prospect.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Read</code>\n"
        },
        {
          "info": {
            "name": "Retrieve all prospect conversations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects/:prospectID/conversations",
            "params": [
              {
                "name": "prospectID",
                "value": "",
                "type": "path",
                "description": "Prospect ID"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100."
              },
              {
                "name": "lastModifiedDateTimeStart",
                "value": "",
                "type": "query",
                "description": "Filters results to any item modified on or after the date time specified. "
              },
              {
                "name": "lastModifiedDateTimeEnd",
                "value": "",
                "type": "query",
                "description": "Filters results to any item modified on or prior to the date time specified. "
              },
              {
                "name": "orderby",
                "value": "",
                "type": "query",
                "description": "Indicates the field(s) and direction to sort the results in the response."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filters results by the conversation type."
              }
            ]
          },
          "docs": "Retrieves all the conversations of a prospect.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Read</code>\n<br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>"
        },
        {
          "info": {
            "name": "Create a prospect conversation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects/:prospectID/conversations",
            "params": [
              {
                "name": "prospectID",
                "value": "",
                "type": "path",
                "description": "Prospect ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a specific prospect conversation.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Write</code>\n"
        },
        {
          "info": {
            "name": "Retrieve a prospect conversation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects/:prospectID/conversations/:conversationID",
            "params": [
              {
                "name": "prospectID",
                "value": "",
                "type": "path",
                "description": "Prospect ID"
              },
              {
                "name": "conversationID",
                "value": "",
                "type": "path",
                "description": "Conversation ID"
              }
            ]
          },
          "docs": "Retrieves a specific prospect conversation.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Read</code>\n"
        },
        {
          "info": {
            "name": "Delete a prospect conversation (BETA)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.propertyware.com/pw/api/rest/v1/prospects/:prospectID/conversations/:conversationID",
            "params": [
              {
                "name": "prospectID",
                "value": "",
                "type": "path",
                "description": "Prospect ID"
              },
              {
                "name": "conversationID",
                "value": "",
                "type": "path",
                "description": "Conversation ID"
              }
            ]
          },
          "docs": "<p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p>\nDeletes a specific prospect conversation.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Delete</code>\n"
        }
      ]
    }
  ],
  "bundled": true
}