Reference

Routes that exist today.

Auth is the X-API-Key header. Writes take dry_run (default false; writes are real). Import the OpenAPI file. This page is not the spec.

OpenAPI 0.100.0. Alert catalog, send, test, routing, snooze, and billing CSV bodies are typed. Field names are the schema titles on Alerts and What we write.

Billing quantities: POST /tenants/{tenant_id}/billing/quantities. The MSP matches the line. You send an absolute quantity (0 stops billing) on your cadence (daily or monthly). The MSP's change limit defaults to 25%. A change over that limit waits. Ending a line is refused. Each row takes optional trial_end_date, an ISO date YYYY-MM-DD or null. Trial ending, Trial converted, and Trial expired use it. Omit it and the stored date stays. A bad date fails that row.

{
  "idempotency_key": "docs-probe-1",
  "dry_run": true,
  "quantities": [
    {
      "customer_ref": "cust-42",
      "customer_name": "Brightside Pediatrics",
      "service": "managed-edr",
      "quantity": 44
    }
  ]
}

{
  "tenant_id": "sandbox-mainstreet",
  "results": [
    {
      "tenant_id": "sandbox-mainstreet",
      "customer_ref": "cust-42",
      "service": "managed-edr",
      "quantity": "44.0000",
      "previous_quantity": null,
      "status": "not_mapped",
      "reason": "customer_not_matched",
      "dry_run": true,
      "sandbox": true
    }
  ],
  "counts": { "not_mapped": 1 },
  "dry_run": true,
  "sandbox": true
}

The request matches BillingQuantitiesBody. trial_end_date is optional on each row and this example omits it. The response is the sandbox body for that request when the customer is not matched yet. The 200 schema is an object.

SDK 2.0.0 (breaking): the generated Python and TypeScript clients now return typed response models where the spec declares one (for example TicketList) instead of plain dicts. Read attributes (listed.sandbox) or call .to_dict().

GET|PUT /isv/experience-config sets category config for PSA, RMM, Docs, CS, and Commerce, plus recommended grants and branding. Vendors inherit the category template. Access is List, Read, and Write, and those stack. Never is its own setting. The MSP can tighten the starting verbs. Sandbox Experience Preview walks Connect after Save: keys, grants, boards, map, done. Getting Started on Setup is Suggest, Save, Preview, then Use MCP or Use API. After Save, copy-paste prompts follow the saved profile. Partner credentials and Production MSP Connect keys are separate. Connections lists each MSP and vendor, last sync, and sync detail. Issues gives a support blurb and a redacted request debug.

Halo and ConnectWise company custom fields: POST /tenants/{tenant_id}/companies/write writes a value on an existing company with vendor_native, and ensure_custom_field creates the missing field definition. The field works live on Halo and ConnectWise. It is created once in your stack under the MSP's standing psa.company.field.create grant, and an existing field with the same label is reused. The field label shows on Configure. Value writes use the psa.company.update grant, off by default. A missing grant is grant_missing. If the update does not run, the code is psa_company_update_refused.

Machine API auth is X-API-Key. Console login is a magic link or Sign in with Microsoft, for an email that is already seated or invited.