Sign inGet started
Docs
Get started

Aspire API Documentation

This is the complete API documentation for connecting to the Aspire 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 Aspire: Field service software to drive growth. Keep reading to get started.

Quickstart

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

Every Aspire action uses the same URL pattern:

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

You need a MindCloud API Key and a Aspire connection. Then call an action such as Authenticate:

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

Set up Aspire credentials

You need an Aspire user account with Admin permissionsThe Aspire access level that lets you manage settings and create credentials..

  1. Create a new Aspire credentialThe connection details Aspire creates so MindCloud can sign in.

    Sign in to Aspire with an account that has Admin permissionsThe Aspire access level that lets you manage settings and create credentials.. Go to Administration > Application > API > New. Add a Description for this integration, choose the access this credentialThe connection details Aspire creates so MindCloud can sign in. should have in ScopeThe access this credential is allowed to use., and select Save.

    Administration → Application → API → New

  2. Copy the Client IDThe public identifier Aspire gives this connection. and SecretThe private code that pairs with the Client ID.

    After Aspire creates the credentialThe connection details Aspire creates so MindCloud can sign in., copy the Client IDThe public identifier Aspire gives this connection. and SecretThe private code that pairs with the Client ID.. Return to the connection form and paste them into the Client IDThe public identifier Aspire gives this connection. and SecretThe private code that pairs with the Client ID. fields.

  3. Choose the correct EnvironmentWhich Aspire system this connection should use.

    In the connection form, choose the EnvironmentWhich Aspire system this connection should use. that matches the Aspire system you want to connect. Select SandboxAspire's test system for trying the integration without using live data. for testing or ProductionYour live Aspire system that uses real data. for your live Aspire system.

Aspire actions

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

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

LinkedInClockifyConnecteamBambooHRTalentLMSCertifierZoho RecruitMemberVault