RO App API Documentation
This is the complete API documentation for connecting to the RO App 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 RO App: RO App is a field-service and operations platform for managing contacts, bookings, estimates, orders, invoices, employees, and company data. Keep reading to get started.
Quickstart
Before you run your first RO App 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 RO App connection — create or choose one in Connections. Note its
connectionId.
Every RO App action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/rOApp/latest/actions/{actionSlug}You need a MindCloud API Key and a RO App connection. Then call an action such as Get Booking:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/rOApp/latest/actions/get-booking" \
--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 RO App account that should run the action. MindCloud stores and refreshes the RO App 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.
RO App actions
All 40 published actions for this RO App version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Booking
- POSTCreate Estimate
- POSTCreate Estimate Item
- POSTCreate Order
- POSTCreate Order Item
- POSTCreate Organization
- POSTCreate Person
- GETGet Booking
- GETGet Company
- GETGet Estimate
- GETGet Invoice
- GETGet Order
- GETGet Organization
- GETGet Person
- GETList Bookings
- GETList Employees
- GETList Estimate Items
- GETList Estimate Statuses
- GETList Estimate Types
- GETList Estimates
- GETList Invoice Items
- GETList Invoice Statuses
- GETList Invoices
- GETList Locations
- GETList Order Items
- GETList Order Statuses
- GETList Order Types
- GETList Orders
- GETList Organizations
- GETList People
- GETList Taxes
- PUTUpdate Booking
- PUTUpdate Estimate
- PUTUpdate Estimate Item
- PUTUpdate Estimate Status
- PUTUpdate Order
- PUTUpdate Order Item
- PUTUpdate Order Status
- PUTUpdate Organization
- PUTUpdate Person
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.