mfr Field Service Management API Documentation
This is the complete API documentation for connecting to the mfr Field Service Management 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 mfr Field Service Management: mfr Field Service Management is a cloud platform for dispatching, work order management, service objects, technicians, documents, and related field-service operations. This app wraps the official mfr OData and REST endpoints for read and write automation. Keep reading to get started.
Quickstart
Before you run your first mfr Field Service Management 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 mfr Field Service Management connection — create or choose one in Connections. Note its
connectionId.
Every mfr Field Service Management action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/mfrFieldServiceManagement/latest/actions/{actionSlug}You need a MindCloud API Key and a mfr Field Service Management connection. Then call an action such as Find Company by ID:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/mfrFieldServiceManagement/latest/actions/find-company-by-id" \
--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 mfr Field Service Management account that should run the action. MindCloud stores and refreshes the mfr Field Service Management 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.
mfr Field Service Management actions
All 24 published actions for this mfr Field Service Management version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Appointment
- POSTCreate Company
- POSTCreate Contact
- POSTCreate Service Object
- POSTCreate Service Request
- DELETEDelete Service Object
- DELETEDelete Service Request
- GETFind Company by ID
- GETFind Contact by ID
- GETFind Service Object by ID
- GETFind Service Request by ID
- GETList Appointments
- GETList Companies
- GETList Contacts
- GETList Service Objects
- GETList Service Objects by Company
- GETList Service Requests
- GETList Service Requests by External ID
- GETList Time Events
- PUTUpdate Appointment
- PUTUpdate Company
- PUTUpdate Contact
- PUTUpdate Service Object
- PUTUpdate Service Request
Related apps
More Support apps on the Universal API, behind the same REST shape. Or browse all apps.