{
"opencollection": "1.0.0",
"info": {
"name": "Open API, powered by Propertyware Accounting Inspections API",
"version": "1.0"
},
"request": {
"auth": {
"type": "apikey",
"key": "x-propertyware-client-id",
"value": "{{x-propertyware-client-id}}",
"placement": "header"
}
},
"items": [
{
"info": {
"name": "Inspections",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all inspections",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.propertyware.com/pw/api/rest/v1/inspections",
"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 inspections with a specific status."
},
{
"name": "portfolioID",
"value": "",
"type": "query",
"description": "Filters results to inspections associated with a specific portfolio."
},
{
"name": "buildingID",
"value": "",
"type": "query",
"description": "Filters results to inspections associated with a specific building."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Filters results to inspections with a specific type."
}
]
},
"docs": "Retrieves a list of inspections.
Required permission:
INSPECTIONS - Read\n
Sortable by: createddate, number, lastmodifieddatetime, status, id"
},
{
"info": {
"name": "Retrieve a inspection",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.propertyware.com/pw/api/rest/v1/inspections/:inspectionId",
"params": [
{
"name": "inspectionId",
"value": "",
"type": "path",
"description": "Inspection ID"
},
{
"name": "includeCustomFields",
"value": "",
"type": "query",
"description": "includeCustomFields"
}
]
},
"docs": "Retrieves a specific inspection.
Required permission:
INSPECTIONS - Read\n"
}
]
}
],
"bundled": true
}