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:
- 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 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 Get API Version:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/aspire/latest/actions/get-api-version" \
--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 Aspire account. See Aspire API Authentication for the full flow and how to get your connection credentials.
Aspire actions
All 149 published actions for this Aspire version. Each page documents the endpoint, arguments, and response controls.
- POSTApprove Receipt
- GETAuthenticate
- POSTCreate As Needed Work Tickets
- POSTCreate Catalog Item
- POSTCreate Clock Time
- POSTCreate Company
- POSTCreate Contact
- POSTCreate Contact Custom Field
- POSTCreate Equipment Reading Log
- POSTCreate Estimate
- POSTCreate Issue
- POSTCreate Item Allocation
- POSTCreate Locality
- POSTCreate Opportunity
- POSTCreate Opportunity Lost Reason
- POSTCreate Opportunity Tag
- POSTCreate Partial Payment
- POSTCreate Pay Codes
- POSTCreate Pay Rate
- POSTCreate Pay Rate Override Pay Codes
- POSTCreate Pay Schedule
- POSTCreate Property
- POSTCreate Property Availability
- POSTCreate Property Contact
- POSTCreate Receipt
- POSTCreate Service Tax Override
- POSTCreate Task
- POSTCreate Tax Entity
- POSTCreate Tax Jurisdiction
- POSTCreate Unit Type
- POSTCreate User
- POSTCreate Vendor
- POSTCreate Work Ticket Time
- POSTCreate Workers Comp
- DELETEDelete Opportunity Tag
- GETGet API Version
- GETGet Attachment File Data
- GETGet Pay Codes
- GETGet Workers Comps
- GETList Activities
- GETList Activity Categories
- GETList Activity Comment Histories
- GETList Activity Contacts
- GETList Addresses
- GETList Attachment Types
- GETList Attachments
- GETList Bank Deposits
- GETList Branches
- GETList Catalog Item Categories
- GETList Catalog Items
- GETList Certification Types
- GETList Certifications
- GETList Clock Times
- GETList Companies
- GETList Contact Custom Field Definitions
- GETList Contact Custom Fields
- GETList Contact Types
- GETList Contacts
- GETList Division Integration Codes
- GETList Divisions
- GETList Employee Incident Types
- GETList Employee Incidents
- GETList Equipment Classes
- GETList Equipment Disposal Reasons
- GETList Equipment Manufacturers
- GETList Equipment Model Service Schedules
- GETList Equipment Models
- GETList Equipment Reading Logs
- GETList Equipment Requested Services
- GETList Equipment Service Logs
- GETList Equipment Service Tags
- GETList Equipment Sizes
- GETList Equipments
- GETList Inventory Locations
- GETList Invoice Batches
- GETList Invoice Revenues
- GETList Invoice Taxes
- GETList Invoices
- GETList Item Allocations
- GETList Job Statuses
- GETList Jobs
- GETList Localities
- GETList Oportunity Service Items
- GETList Opportunities
- GETList Opportunity Lost Reasons
- GETList Opportunity Service Groups
- GETList Opportunity Service Kit Items
- GETList Opportunity Services
- GETList Opportunity Status
- GETList Pay Rate Override Pay Codes
- GETList Pay Rates
- GETList Pay Schedules
- GETList Payment Categories
- GETList Payment Terms
- GETList Payments
- GETList Properties
- GETList Property Availabilities
- GETList Property Contacts
- GETList Property Custom Field Definitions
- GETList Property Custom Fields
- GETList Property Status
- GETList Property Types
- GETList Prospect Ratings
- GETList Receipts
- GETList Regions
- GETList Revenue Variances
- GETList Roles
- GETList Routes
- GETList Sales Types
- GETList Service Type Integration Codes
- GETList Service Types
- GETList Services
- GETList Tags
- GETList Tax Jurisdictions
- GETList Unit Types
- GETList Users
- GETList Vendors
- GETList Work Ticket Canceled Reasons
- GETList Work Ticket Items
- GETList Work Ticket Revenues
- GETList Work Ticket Times
- GETList Work Ticket Visit Notes
- GETList Work Ticket Visits
- GETList Work Tickets
- PUTMark Work Ticket As Reviewed
- POSTPost Attachment
- POSTReceive Receipt
- GETRefresh Authorization Token
- PUTUpdate Catalog Item
- PUTUpdate Company
- PUTUpdate Contact
- PUTUpdate Contact Custom Field
- PUTUpdate Equipment Reading Log
- PUTUpdate Item Allocation
- PUTUpdate Locality
- PUTUpdate Opportunity Lost Reason
- PUTUpdate Pay Codes
- PUTUpdate Pay Rate
- PUTUpdate Pay Rate Override Pay Codes
- PUTUpdate Pay Schedule
- PUTUpdate Property
- PUTUpdate Property Contacts
- PUTUpdate Service Tax Override
- PUTUpdate Tax Entity
- PUTUpdate Tax Jurisdiction
- PUTUpdate Unit Type
- PUTUpdate User
- PUTUpdate Vendor
- PUTUpdate Workers Comp
Related apps
More Human Resources apps on the Universal API, behind the same REST shape. Or browse all apps.