# Upnify API Documentation

This is the complete API documentation for connecting to the Upnify 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 **Upnify connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

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

## Upnify actions

- POST `create-client` Create Client
- POST `create-company` Create Company
- POST `create-product` Create Product
- POST `create-prospect` Create Prospect
- POST `create-sale` Create Sale
- POST `create-user` Create User
- DELETE `delete-client` Delete Client
- DELETE `delete-company` Delete Company
- DELETE `delete-opportunity` Delete Opportunity
- DELETE `delete-prospect` Delete Prospect
- DELETE `delete-sale` Delete Sale
- DELETE `delete-user` Delete User
- GET `get-client` Get Client
- GET `get-company` Get Company
- GET `get-opportunity` Get Opportunity
- GET `get-product` Get Product
- GET `get-prospect` Get Prospect
- GET `get-sale` Get Sale
- GET `get-user` Get User
- GET `list-client-opportunities` List Client Opportunities
- GET `list-clients` List Clients
- GET `list-companies` List Companies
- GET `list-company-contacts` List Company Contacts
- GET `list-opportunities` List Opportunities
- GET `list-opportunity-products` List Opportunity Products
- GET `list-products` List Products
- GET `list-prospect-opportunities` List Prospect Opportunities
- GET `list-prospects` List Prospects
- GET `list-sale-payments` List Sale Payments
- GET `list-sale-products` List Sale Products
- GET `list-sales` List Sales
- GET `list-sales-estimates` List Sales Estimates
- GET `list-users` List Users
- PUT `update-client` Update Client
- PUT `update-company` Update Company
- PUT `update-opportunity` Update Opportunity
- PUT `update-product` Update Product
- PUT `update-prospect` Update Prospect
- PUT `update-sale` Update Sale
- PUT `update-user` Update User