What is the Toki Iti API

Helpdocs Admin Updated by Helpdocs Admin

Tokity is our ITSM (IT Service Management) platform. It provides a RESTful API that lets you integrate with and extend your Tokity instance. Tokity is a single-tenant system — each customer's data is fully isolated, with no risk of data crossing between tenants.

Our API has a long history. It originally came from our previous product, DeskDirector, which integrated with Autotask and ConnectWise. Over time, the API has grown and evolved on top of that original foundation.

Where to find the API reference (Swagger)

Full endpoint definitions are available through Swagger, hosted at the tenant level:

https://<your-instance-host>/swagger

Most of our API is documented in OpenAPI v3 format. The exception is our Power Automate connector, published in OpenAPI v2 format — a requirement from Microsoft, not a choice we made.

Inside Swagger, endpoints are grouped into four categories:

Category

What it's for

Public v4

Our current public API — the modern equivalent of tenant-level access via API key

Legacy public API

The older v2 public API, kept for backward compatibility

Internal v1–v4

Originally built for our Admin Portal, TECH Portal, and Client Portal. Now also accessible via personal API keys and OAuth

Connector API

Used by our registered Power Automate connector

A quick word on versions

Our API is currently on v4, which is what you should use for all new integrations. Older versions (v1–v3) come from our DeskDirector era — v1 is fully retired, while v2 and v3 remain available for backward compatibility.

👉 See API Versions & Routes for full details on version history, our compatibility guarantees, and how API routes are structured across the TECH Portal, Client Portal, and system-wide endpoints.

Roles and scopes, in brief

Access to the API is shaped by two things: an agent's role (Agent, Advanced Agent, Admin, or Master Admin) and, when using API keys or OAuth, scopes — which define exactly what an integration is allowed to read or modify.

👉 See Roles & Scopes for a full breakdown.

Authorizing your requests

There are two ways to authorize access to the API: API keys and OAuth. API keys are quick to set up and well understood; OAuth offers finer-grained control and full visibility into what's been granted to whom.

👉 See Authorization Options to compare both and decide which fits your use case.

Where to go next

How did we do?

API Versions & Routes

Contact