UISP CRM API

The UISP CRM API is the per-instance REST API for the customer-relationship-management half of UISP, covering clients, services (subscriptions), invoices, payments, quotes, tickets, jobs, taxes, and product/service plans. Endpoints are served from each UISP instance under `/crm/api/v1.0/`. Authentication uses an `X-Auth-App-Key` header carrying an App Key generated under Settings → Security → App keys. The full reference is mirrored on Apiary at unmscrm.docs.apiary.io.

API entry from apis.yml

apis.yml Raw ↑
aid: ubiquiti:uisp-crm-api
name: UISP CRM API
tags:
- ISP
- UISP
- WISP
- CRM
- Billing
humanURL: https://unmscrm.docs.apiary.io/
properties:
- url: https://unmscrm.docs.apiary.io/
  type: Documentation
- url: https://help.uisp.com/hc/en-us/articles/22590956856087-UISP-CRM-API-Usage
  type: Documentation
description: The UISP CRM API is the per-instance REST API for the customer-relationship-management half
  of UISP, covering clients, services (subscriptions), invoices, payments, quotes, tickets, jobs, taxes,
  and product/service plans. Endpoints are served from each UISP instance under `/crm/api/v1.0/`. Authentication
  uses an `X-Auth-App-Key` header carrying an App Key generated under Settings → Security → App keys.
  The full reference is mirrored on Apiary at unmscrm.docs.apiary.io.