REST API Reference

REST API Reference

Base URL: https://api.deskfork.com/v1

All requests require Authorization: Bearer <api-key>.

Resources

Resource	Description
/tickets	Create, list, update, and close support tickets
/tickets/:id/messages	Replies and internal notes on a ticket
/tickets/:id/attachments	File attachments (Worker-proxied, not direct R2)
/workspaces	Workspace configuration and team members
/inboxes	Inbox management (email, web chat, webhook)
/contacts	Customer contact records
/sla-policies	Per-inbox SLA target configuration
/kb/articles	Knowledge base articles for AI triage
/kb/collections	Knowledge base collections
/ai/cache	Semantic cache entries (Vectorize)
/webhooks	Outbound webhook subscriptions
/api-keys	API key management

Common query parameters

Parameter	Type	Description
workspace	string	Workspace slug (required on multi-workspace keys)
page	integer	Page number, 1-indexed
per_page	integer	Results per page (max 100)
status	string	Filter by status (open, pending, resolved, closed)

Error format

{
  "error": {
    "code": "TICKET_NOT_FOUND",
    "message": "Ticket TKT-9999 does not exist in this workspace.",
    "status": 404
  }
}

See API Quickstart for authentication and example calls.