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:
https://connect.mindcloud.co/v1/universal/inventoryBase/latest/actions/{actionSlug}You need a MindCloud API Key and a InventoryBase connection. Then call an action such as Get Client:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/inventoryBase/latest/actions/get-client" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"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.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected InventoryBase account that should run the action. MindCloud stores and refreshes the InventoryBase credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
How to set up your connection?
You need an InventoryBase account and an OAuth application whose Redirect URL exactly matches the redirect URL shown in the connection form.
- Sign in to your InventoryBase account
Open your InventoryBase account so you can register an OAuth application for this connection.
InventoryBase account - Create an OAuth application
Create a new application and enter the redirect URL shown in the connection form as the application's Redirect URL.
- Copy the Client ID and Client Secret
After the application is created, copy the Client ID and Client Secret into the connection form using the same labels.
- Finish the connection
Submit the connection form and complete the InventoryBase consent screen.
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.