Developer Resources
Getting Started
Start here: what the API is, where to find Swagger, versions, roles, scopes, and authorization options.
API Key Authorization
Create and use API keys to access the Toki Iti API — personal and system-level keys, scopes, and limits.
OAuth Fundamentals
Learn the core concepts behind OAuth in the Toki Iti API, including how authorized sessions and consent grants work, and how OAuth scopes differ from API key scopes. This section also walks through the supported authorization flows, including OpenID Connect, so you can understand how the handshake works before implementing it.
OAuth App Registration
Learn how to register an OAuth application in Tokity, from creating the app to choosing the right configuration for your use case. This section covers the difference between confidential and public applications, when a client secret is required, and how personal secrets fit into the picture — everything you need to get an app ready for the authorization flow.
OAuth Administration
Manage OAuth access after it's been granted. This section covers how to view and control authorized sessions and consent grants — including who can revoke or reduce access — as well as how admin-level (root) consent works across contacts and agents, and how to configure tenant-wide OAuth settings.
API Response Control
Learn how to control what data the Ticket and Workspace APIs return, and in what format. This section covers the Prefer header and related query options — including how to include related data like comments, time entries, and activities in a single response, and how to choose between HTML and Markdown when returning ticket or form content.
Workspace Ordering
Learn how Tokity manages the order of groups and tickets within a workspace, and how to create, move, and reorder them through the API. This section covers the anchor-based positioning model used for ordering, along with the specific payloads for reordering groups and for adding or moving tickets within a workspace's groups.
Data Sync & Notifications
Learn how to keep your integration in sync with Tokity data, and how to stay informed of changes as they happen. This section covers the Delta API for pulling incremental updates, and the difference between webhooks and events for receiving real-time notifications — helping you choose the right approach for your integration's needs.
Ticket Widgets
Ticket widgets show dynamic content from your own API inside the ticket, and let users navigate, make choices and take actions without leaving it. Learn how to build the API responses that power them.
