ServiceChannel API Documentation

This is the complete API documentation for connecting to the ServiceChannel 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 ServiceChannel: ServiceChannel empowers facilities and store operations to provide the best possible guest and employee experience. Keep reading to get started.

Quickstart

Before you run your first ServiceChannel request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one ServiceChannel connection — create or choose one in Connections. Note its connectionId.

Every ServiceChannel action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/serviceChannel/actions/{actionSlug}/run

You need a MindCloud API Key and a ServiceChannel connection. Then call an action such as Get Work Order:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/serviceChannel/actions/get-work-order/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 ServiceChannel account. See ServiceChannel API Authentication for the full flow and how to get your connection credentials.

ServiceChannel actions

All 22 published actions for this ServiceChannel version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Attachment to Work Order
• POSTCreate Work Request
• GETGet Work Order
• GETList Categories
• GETList Locations
• GETList Statuses
• GETList Subscribers
• GETList Trades
• GETList Work Orders
• POSTList Work Requests
• GETSearch Work Orders
• PUTUpdate Work Order Caller
• PUTUpdate Work Order Category
• PUTUpdate Work Order Description
• PUTUpdate Work Order NTE
• PUTUpdate Work Order NTE Project Approval
• PUTUpdate Work Order PO Number
• PUTUpdate Work Order Priority
• PUTUpdate Work Order Project Completion Date
• PUTUpdate Work Order Schedule Date
• PUTUpdate Work Order Status
• PUTUpdate Work Order Trade

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionGoogle FormsMailchimp