Particle API Documentation

This is the complete API documentation for connecting to the Particle 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 Particle: Manage Particle Cloud resources including users, devices, diagnostics, integrations, ledgers, logic functions, products, SIMs, and environment variables. Keep reading to get started.

Quickstart

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

Every Particle action uses the same URL pattern:

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

You need a MindCloud API Key and a Particle connection. Then call an action such as Get Current User:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/particle/latest/actions/get-current-user" \
  --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.

Authenticate with a MindCloud API Key plus a connectionId for your Particle account. See Particle API Authentication for the full flow and how to get your connection credentials.

Particle actions

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

• PUTCall Device Function
• POSTCreate Ledger
• POSTCreate Logic Function
• POSTCreate Secret
• POSTCreate Webhook
• DELETEDelete Current Access Token
• DELETEDelete Environment Variable
• DELETEDelete Integration
• DELETEDelete Ledger
• DELETEDelete Ledger Instance
• DELETEDelete Logic Function
• DELETEDelete Secret
• DELETEDelete Webhooks
• GETGet Cellular Network Status
• GETGet Current Access Token
• GETGet Current User
• GETGet Device
• GETGet Device Variable
• GETGet Integration
• GETGet Ledger
• GETGet Ledger Instance
• GETGet Ledger Version
• GETGet Library
• GETGet Logic Function
• GETGet Secret
• GETGet SIM Data Usage
• GETGet SIM Information
• POSTImport Devices into Product
• GETList Account Events
• GETList Device Events
• GETList Devices
• GETList Environment Variables
• GETList Integrations
• GETList Ledger Instances
• GETList Ledger Versions
• GETList Ledgers
• GETList Libraries
• GETList Library Versions
• GETList Logic Functions
• GETList Products
• GETList Secrets
• GETList SIM Cards
• GETList Webhooks
• GETLook Up Device Identification by Serial Number
• PUTPing Device
• DELETERelease SIM from Account
• PUTRename Device
• GETRender Environment Variables
• PUTRoll Out Environment Variables
• PUTTest Integration
• DELETEUnclaim Device
• PUTUpdate Integration
• PUTUpdate Ledger
• PUTUpdate Ledger Instance
• PUTUpdate Logic Function
• PUTUpdate Secret
• PUTUpdate SIM
• PUTUpsert Environment Variable

Related apps

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

GitHubNetlifyMySQLPostgreSQLFirebasePagerDutyGoogle Workspace AdminAdalo