InventoryBase API Documentation
This is the complete API documentation for connecting to the InventoryBase API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet InventoryBase: InventoryBase provides property, inspection, report, client, staff, template, webhook, file sharing, and configuration APIs for property inventory and inspection workflows. Keep reading to get started.
Quickstart
Before you run your first InventoryBase request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one InventoryBase connection — create or choose one in Connections. Note its
connectionId.
Every InventoryBase action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/inventoryBase/actions/{actionSlug}/runYou need a MindCloud API Key and a InventoryBase connection. Then call an action such as Get Current User:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/inventoryBase/actions/get-current-user/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your InventoryBase account. See InventoryBase API Authentication for the full flow and how to get your connection credentials.
InventoryBase actions
All 41 published actions for this InventoryBase version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Client
- POSTCreate Custom Field
- POSTCreate Inspection
- POSTCreate Inspection Contact
- POSTCreate Property
- POSTCreate Property Contact
- POSTCreate Property Meter
- POSTCreate Staff Member
- DELETEDelete Custom Field
- DELETEDelete Inspection Contact
- DELETEDelete Property Contact
- DELETEDelete Property Meter
- DELETEDelete Webhook Listener
- GETGet Client
- GETGet Current User
- GETGet Inspection
- GETGet Inspection Report
- GETGet Inspection Report Metadata
- GETGet Property
- GETGet Property Meter
- GETGet Staff Member
- GETGet Template Report
- GETList Action Reports by Inspection
- GETList Clients
- GETList Custom Fields
- GETList Inspection Contacts
- GETList Inspections
- GETList Properties
- GETList Property Contacts
- GETList Property Meters
- GETList Staff Members
- PUTLoad Template into Inspection
- POSTRegister Webhook Listener
- PUTUpdate Client
- PUTUpdate Custom Field
- PUTUpdate Inspection
- PUTUpdate Inspection Contact
- PUTUpdate Property
- PUTUpdate Property Contact
- PUTUpdate Property Meter
- PUTUpdate Staff Member
Related apps
More Support apps on the Universal API, behind the same REST shape. Or browse all apps.