API Response Control

Uploading Attachments (Ticket API)

Attaching files to tickets, comments, or time entries is a two-step process: create an upload session , then verify the upload once it's complete. This design lets users upload files ahead of time in…

Helpdocs Admin
Updated by Helpdocs Admin

The Prefer Header — Overview

Tokity's API uses the standard HTTP Prefer header to let you control the shape and format of API responses — without needing separate endpoints or query parameters for every variation. This overview…

Helpdocs Admin
Updated by Helpdocs Admin

Controlling Returned Data (Ticket API)

Ticket responses can include related data — comments, time entries, activities, and workspaces — but not all of it is needed for every use case. Rather than always returning everything, the Ticket AP…

Helpdocs Admin
Updated by Helpdocs Admin

Controlling Returned Data (Form Result API)

Background: how Tokity forms work. Tokity's dynamic forms work similarly to Microsoft Forms or Google Forms. A form's definition is a JSON payload made up of fields, where each field includes: A fiel…

Helpdocs Admin
Updated by Helpdocs Admin

Controlling Returned Data (Workspace API)

What is a workspace? A workspace is a way to organize tickets — think of it as a collaborative workspace rather than a permissions boundary. Agents can be added to a workspace, and within it, tickets…

Helpdocs Admin
Updated by Helpdocs Admin

Contact