RotaCloud API Documentation
This is the complete API documentation for connecting to the RotaCloud 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 RotaCloud: RotaCloud API integration for workforce scheduling, leave, attendance, users, shifts, and related admin operations. Keep reading to get started.
Quickstart
Before you run your first RotaCloud 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 RotaCloud connection — create or choose one in Connections. Note its
connectionId.
Every RotaCloud action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/rotaCloud/latest/actions/{actionSlug}You need a MindCloud API Key and a RotaCloud connection. Then call an action such as Get Account:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/rotaCloud/latest/actions/get-account" \
--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 RotaCloud account that should run the action. MindCloud stores and refreshes the RotaCloud 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.
RotaCloud actions
All 126 published actions for this RotaCloud version. Each page documents the endpoint, arguments, and response controls.
- PUTAcknowledge Shifts
- POSTClock In User
- PUTClock Out User
- DELETEClose Active Terminal
- DELETEClose Terminal
- POSTCreate Attendance Record
- POSTCreate Availability
- POSTCreate Day Note
- POSTCreate Day Note V2
- POSTCreate Day Off
- POSTCreate Document
- POSTCreate Group
- POSTCreate Leave Embargo
- POSTCreate Leave Entry
- POSTCreate Leave Request
- POSTCreate Location
- POSTCreate Logbook Category
- POSTCreate Logbook Entry
- POSTCreate Onboarding Request
- POSTCreate Role
- POSTCreate Shift
- POSTCreate Terminal
- POSTCreate TOIL Accrual
- POSTCreate User
- POSTCreate Users Onboarding Batch V2
- POSTCreate Users V2
- DELETEDelete Attendance Record
- DELETEDelete Availability
- DELETEDelete Day Note
- DELETEDelete Day Note V2
- DELETEDelete Day Off
- DELETEDelete Document
- DELETEDelete Group
- DELETEDelete Leave Embargo
- DELETEDelete Leave Entry
- DELETEDelete Leave Request
- DELETEDelete Location
- DELETEDelete Logbook Category
- DELETEDelete Logbook Entry
- DELETEDelete Role
- DELETEDelete Shift
- DELETEDelete Shifts Batch
- DELETEDelete TOIL Accrual
- DELETEDelete User
- PUTEnd User Break
- GETGet Account
- GETGet Attendance Record
- GETGet Clocked In User
- GETGet Day Note
- GETGet Day Note V2
- GETGet Document
- GETGet Group
- GETGet Invoice
- GETGet Leave Embargo
- GETGet Leave Entry
- GETGet Leave Request
- GETGet Location
- GETGet Logbook Category
- GETGet Logbook Entry
- GETGet Pin
- GETGet Role
- GETGet Shift
- GETGet Shift History
- GETGet Terminal
- GETGet Timezone
- GETGet Toil Accrual
- GETGet User
- POSTLaunch Active Terminal
- GETList Accounts
- GETList Active Terminals
- GETList Attendance Records
- GETList Auth Context
- GETList Availability
- GETList Clocked In Users
- GETList Daily Budgets
- GETList Daily Revenue
- GETList Day Notes
- GETList Day Notes V2
- GETList Days Off
- GETList Documents
- GETList Groups
- GETList Invoices
- GETList Leave Embargoes
- GETList Leave Entries
- GETList Leave Requests
- GETList Leave Types
- GETList Locations
- GETList Logbook Categories
- GETList Logbook Entries
- GETList Messages
- GETList Roles
- GETList Settings
- GETList Shifts
- GETList Terminals
- GETList Timezones
- GETList Toil Accruals
- GETList Toil Allowance
- GETList Users
- PUTPing Active Terminal
- PUTPublish Shifts
- POSTResend Onboarding Link
- POSTSend Message
- PUTStart User Break
- DELETEUnpublish Shifts
- PUTUpdate Attendance Record
- PUTUpdate Availability
- PUTUpdate Daily Budgets Batch
- PUTUpdate Daily Revenue Batch
- PUTUpdate Day Note
- PUTUpdate Day Note V2
- PUTUpdate Document
- PUTUpdate Group
- PUTUpdate Leave Embargo
- PUTUpdate Leave Entry
- PUTUpdate Leave Request
- PUTUpdate Location
- PUTUpdate Logbook Category
- PUTUpdate Logbook Entry
- PUTUpdate Role
- PUTUpdate Shift
- PUTUpdate Shift Drop Request
- PUTUpdate Shift Swap Request
- PUTUpdate Shifts Batch
- PUTUpdate Terminal
- PUTUpdate User
- PUTUpdate User Onboarding
Related apps
More Productivity apps on the Universal API, behind the same REST shape. Or browse all apps.