Synchroteam API Documentation

This is the complete API documentation for connecting to the Synchroteam 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 Synchroteam: Synchroteam is a field service management (FSM) platform. This app integrates with the Synchroteam API to manage jobs, customers, sites, equipment, parts, invoices, and users. Keep reading to get started.

Quickstart

Before you run your first Synchroteam 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 Synchroteam connection — create or choose one in Connections. Note its connectionId.

Every Synchroteam action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/synchroteam/latest/actions/{actionSlug}

You need a MindCloud API Key and a Synchroteam connection. Then call an action such as Get Customer:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/synchroteam/latest/actions/get-customer" \
  --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 Synchroteam account that should run the action. MindCloud stores and refreshes the Synchroteam 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.

Synchroteam actions

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

• PUTCancel Job
• PUTComplete Replenishment
• GETGet Customer
• GETGet Equipment
• GETGet Job Detail
• GETGet Job Photos
• GETGet Part Detail
• GETGet Site
• GETGet User Detail
• PUTInitialize Quantities
• GETList Customers
• GETList Invoices and Quotations
• GETList Shared Blocks
• GETList Sites by Customer ID
• GETSearch Activities
• GETSearch Activity Types
• GETSearch Jobs
• GETSearch Replenishment Requests
• GETSearch Users
• PUTSend Activity Type
• POSTSend Attachment
• PUTSend Customer
• PUTSend Equipment
• PUTSend Invoice or Quotation
• PUTSend Job
• PUTSend Part
• PUTSend Site
• PUTSend User
• PUTUpdate Parts Pricing
• PUTValidate Job

Related apps

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

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear