Checkmob API Documentation

This is the complete API documentation for connecting to the Checkmob 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 Checkmob: Checkmob verified draft: 63 actions are now in QA with live evidence across auth, client read/create/update flows, bulk client creation, client addresses, client notes, people create/get/update/delete flows, person-to-client linking, segment create/get/update/delete and link/unlink flows, checklist link/unlink flows, group update, service-order create/get/status-change/delete flows, and the supporting lookup/list families. The draft inventory totals 71 actions: 67 official Swagger-backed operations, one retained semantic duplicate search action, and three older candidate detail routes that are not present in Swagger and return HTTP 404. Eight actions remain blocked with explicit notes: Create Group (provider returns HTTP 500 even for Swagger-shaped payloads), Get/Update Person Address (tenant lacks a person record with an existing address row), Get/Update Service (tenant currently has zero service records), and the candidate Get Service Status by ID, Get Step by ID, and Get Temperature by ID routes that return HTTP 404. Keep reading to get started.

Quickstart

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

Every Checkmob action uses the same URL pattern:

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

You need a MindCloud API Key and a Checkmob connection. Then call an action:

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 Checkmob account that should run the action. MindCloud stores and refreshes the Checkmob 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.

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

Quickstart

Authentication

Related apps