UISP API Reference

Base URLs

System	Base URL
CRM	`https://satlinkgy.uisp.com/crm/api/v1.0/`
NMS	`https://satlinkgy.uisp.com/nms/api/v2.1/`

Full docs: https://unmscrm.docs.apiary.io/
Raw blueprint: curl -H "Accept: text/plain" https://jsapi.apiary.io/apis/unmscrm.apib

Credentials: Infisical /credentials/uisp/

Authentication

# CRM and NMS both use X-Auth-Token header
curl -H "X-Auth-Token: [token from Infisical]" \
  "https://satlinkgy.uisp.com/crm/api/v1.0/clients"

Key Constraints

Field	System	Constraint
`status`	CRM service	READ-ONLY after creation. Delete + Create to change.
`activeFrom`	CRM service	READ-ONLY after creation. Set in POST body.
`invoicingStart`	CRM service	READ-ONLY after creation. Set in POST body.
`tags`	CRM client	READ-ONLY on PATCH. Tags can be created but not assigned via API.

Common Endpoints

Clients

# List clients
GET /crm/api/v1.0/clients
 
# Get client by ID
GET /crm/api/v1.0/clients/{id}
 
# Create client
POST /crm/api/v1.0/clients

Services

# List client services
GET /crm/api/v1.0/clients/{id}/services
 
# Create service (include status=1 for Active)
POST /crm/api/v1.0/clients/{id}/services
 
# Suspend service
PATCH /crm/api/v1.0/clients/services/{id}/suspend
Body: {"suspensionReasonId": 1001}
 
# Unsuspend service (NOT /unsuspend -- that 404s)
PATCH /crm/api/v1.0/clients/services/{id}/cancel-suspend
 
# Get suspension reasons
GET /crm/api/v1.0/service-suspension-reasons

Payments

# List payments (max 500/page)
GET /crm/api/v1.0/payments?limit=500&offset=0
 
# Create payment
POST /crm/api/v1.0/payments

NMS Devices

# List all devices
GET /nms/api/v2.1/devices
 
# Get device by ID
GET /nms/api/v2.1/devices/{id}
 
# List sites
GET /nms/api/v2.1/sites

Service Plan Reference

Plan	servicePlanPeriodId	Rate
Standard Monthly	37	GYD 10,000

Known Issues

GUI cache: After API changes, the CRM web UI may show stale data. Log out and back in, or clear browser cache.
Tags API: PATCH /clients/{id} ignores tags field silently. No error, but tags are not assigned.
Correct base URL is satlinkgy.uisp.com (NOT uisp.satlinkgy.com).

UISP API Reference

On this page