# Aspire API Documentation

This is the complete API documentation for connecting to the Aspire API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Aspire connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/aspire/actions/{actionSlug}/run
```

## Aspire actions

- POST `approve-receipt` Approve Receipt
- GET `authenticate` Authenticate
- POST `create-work-ticket` Create As Needed Work Tickets
- POST `create-catalog-item` Create Catalog Item
- POST `create-clock-time` Create Clock Time
- POST `create-companies` Create Company
- POST `create-contact` Create Contact
- POST `create-contact-custom-field` Create Contact Custom Field
- POST `create-equipment-reading-log` Create Equipment Reading Log
- POST `create-estimate` Create Estimate
- POST `create-issue` Create Issue
- POST `create-item-allocation` Create Item Allocation
- POST `create-locality` Create Locality
- POST `create-new-opportunity` Create Opportunity
- POST `create-opportunity-lost-reason` Create Opportunity Lost Reason
- POST `create-opportunity-tag` Create Opportunity Tag
- POST `create-partial-payment` Create Partial Payment
- POST `create-partial-payment-stripe-to-aspire-sync` Create Partial Payment – Stripe to Aspire Sync
- POST `create-pay-codes` Create Pay Codes
- POST `create-pay-rate` Create Pay Rate
- POST `create-pay-rate-override-pay-codes` Create Pay Rate Override Pay Codes
- POST `create-pay-schedule` Create Pay Schedule
- POST `create-property` Create Property
- POST `create-property-availability` Create Property Availability
- POST `create-property-contact` Create Property Contact
- POST `create-receipt` Create Receipt
- POST `create-service-tax-override` Create Service Tax Override
- POST `create-task` Create Task
- POST `create-tax-entity` Create Tax Entity
- POST `create-tax-jurisdiction` Create Tax Jurisdiction
- POST `create-unit-type` Create Unit Type
- POST `create-user` Create User
- POST `create-vendor` Create Vendor
- POST `create-work-ticket-time` Create Work Ticket Time
- POST `create-workers-comp` Create Workers Comp
- DELETE `delete-opportunity-tag` Delete Opportunity Tag
- GET `get-api-version` Get API Version
- GET `get-attachment-file-data` Get Attachment File Data
- GET `get-pay-codes` Get Pay Codes
- GET `get-contact-types` Get Workers Comps
- GET `list-activities` List Activities
- GET `list-activity-categories` List Activity Categories
- GET `list-activity-comment-histories` List Activity Comment Histories
- GET `list-activity-contacts` List Activity Contacts
- GET `list-addresses` List Addresses
- GET `list-attachment-types` List Attachment Types
- GET `list-attachments` List Attachments
- GET `list-bank-deposits` List Bank Deposits
- GET `list-branches` List Branches
- GET `list-catalog-item-categories` List Catalog Item Categories
- GET `list-catalog-items` List Catalog Items
- GET `list-certification-types` List Certification Types
- GET `list-certifications` List Certifications
- GET `list-clock-times` List Clock Times
- GET `list-companies` List Companies
- GET `list-contact-custom-field-definitions` List Contact Custom Field Definitions
- GET `list-contact-custom-fields` List Contact Custom Fields
- GET `list-contact-types` List Contact Types
- GET `list-contacts` List Contacts
- GET `list-division-integration-codes` List Division Integration Codes
- GET `list-divisions` List Divisions
- GET `list-employee-incident-types` List Employee Incident Types
- GET `list-employee-incidents` List Employee Incidents
- GET `list-equipment-classes` List Equipment Classes
- GET `list-equipment-disposal-reasons` List Equipment Disposal Reasons
- GET `list-equipment-manufacturers` List Equipment Manufacturers
- GET `list-equipment-model-service-schedules` List Equipment Model Service Schedules
- GET `list-equipment-models` List Equipment Models
- GET `list-equipment-reading-logs` List Equipment Reading Logs
- GET `list-equipment-requested-services` List Equipment Requested Services
- GET `list-equipment-service-logs` List Equipment Service Logs
- GET `list-equipment-service-tags` List Equipment Service Tags
- GET `list-equipment-sizes` List Equipment Sizes
- GET `list-equipments` List Equipments
- GET `list-inventory-locations` List Inventory Locations
- GET `list-invoice-batches` List Invoice Batches
- GET `get-invoice-revenue` List Invoice Revenues
- GET `list-invoice-taxes` List Invoice Taxes
- GET `list-invoices` List Invoices
- GET `list-item-allocations` List Item Allocations
- GET `list-job-statuses` List Job Statuses
- GET `list-jobs` List Jobs
- GET `list-localities` List Localities
- GET `list-object-codes` List Object Codes
- GET `list-opportunities` List Opportunities
- GET `list-opportunity-lost-reasons` List Opportunity Lost Reasons
- GET `list-opportunity-service-groups` List Opportunity Service Groups
- GET `list-oportunity-service-items` List Opportunity Service Items
- GET `list-opportunity-service-kit-items` List Opportunity Service Kit Items
- GET `list-opportunity-services` List Opportunity Services
- GET `list-opportunity-status` List Opportunity Status
- GET `list-opportunity-tags` List Opportunity Tags
- GET `list-opportunity-tags-assignments` List Opportunity Tags Assignments
- GET `list-pay-rate-override-pay-codes` List Pay Rate Override Pay Codes
- GET `list-pay-rates` List Pay Rates
- GET `list-pay-schedules` List Pay Schedules
- GET `list-payment-categories` List Payment Categories
- GET `list-payment-terms` List Payment Terms
- GET `list-payments` List Payments
- GET `list-payments-stripe-to-aspire-sync` List Payments – Stripe to Aspire Sync
- GET `list-properties` List Properties
- GET `list-property-availabilities` List Property Availabilities
- GET `list-property-contacts` List Property Contacts
- GET `list-property-custom-field-definitions` List Property Custom Field Definitions
- GET `list-property-custom-fields` List Property Custom Fields
- GET `list-property-status` List Property Status
- GET `list-property-types` List Property Types
- GET `get-prospect-ratings` List Prospect Ratings
- GET `list-receipts` List Receipts
- GET `list-regions` List Regions
- GET `list-revenue-variances` List Revenue Variances
- GET `list-roles` List Roles
- GET `list-routes` List Routes
- GET `list-sales-types` List Sales Types
- GET `list-service-type-integration-codes` List Service Type Integration Codes
- GET `list-service-types` List Service Types
- GET `list-services` List Services
- GET `list-tags` List Tags
- GET `list-tax-jurisdictions` List Tax Jurisdictions
- GET `list-unit-types` List Unit Types
- GET `list-users` List Users
- GET `get-users` List Vendors
- GET `list-work-ticket-canceled-reasons` List Work Ticket Canceled Reasons
- GET `list-work-ticket-items` List Work Ticket Items
- GET `list-work-ticket-revenues` List Work Ticket Revenues
- GET `list-work-ticket-times` List Work Ticket Times
- GET `list-work-ticket-visit-notes` List Work Ticket Visit Notes
- GET `list-work-ticket-visits` List Work Ticket Visits
- GET `list-work-tickets` List Work Tickets
- PUT `mark-work-ticket-as-reviewed` Mark Work Ticket As Reviewed
- POST `post-attachment` Post Attachment
- POST `receive-receipt` Receive Receipt
- GET `refresh-authorization-token` Refresh Authorization Token
- PUT `update-catalog-item` Update Catalog Item
- PUT `update-company` Update Company
- PUT `update-contact` Update Contact
- PUT `update-contact-custom-field` Update Contact Custom Field
- PUT `update-equipment-reading-log` Update Equipment Reading Log
- PUT `update-item-allocation` Update Item Allocation
- PUT `update-locality` Update Locality
- PUT `update-opportunity-lost-reason` Update Opportunity Lost Reason
- PUT `update-pay-codes` Update Pay Codes
- PUT `update-pay-rate` Update Pay Rate
- PUT `update-pay-rate-override-pay-codes` Update Pay Rate Override Pay Codes
- PUT `update-pay-schedule` Update Pay Schedule
- PUT `update-property` Update Property
- PUT `update-property-contacts` Update Property Contacts
- PUT `update-service-tax-override` Update Service Tax Override
- PUT `update-tax-entity` Update Tax Entity
- PUT `update-tax-jurisdiction` Update Tax Jurisdiction
- PUT `update-unit-type` Update Unit Type
- PUT `update-user` Update User
- PUT `update-vendor` Update Vendor
- PUT `update-workers-comp` Update Workers Comp