All Systems Operational
02 7250 7638
Docs/Support Desk/REST API Reference

Support Desk REST API Reference

Complete REST API reference for the Vyntech Support Desk platform. Integrate customer ticketing, agent workflows, SLA tracking, email processing, and embedded customer portals into any application.

Production Base URL
HTTPS JSON REST
https://api.vyntech.com.au/v1/support

API Resource Modules

Tickets

Core

Create, query, prioritize, assign, and manage ticket lifecycles.

POST /tickets
GET /tickets
GET /tickets/stats
GET /tickets/{id}
PATCH /tickets/{id}/status
POST /tickets/{id}/assign

Messages & Attachments

Omnichannel

Customer public messages, confidential agent notes, attachments, and timeline activities.

POST /tickets/{id}/messages
GET /tickets/{id}/messages
POST /attachments
GET /activities

Customers

CRM

Customer profiles, external CRM identity links, and contact records.

POST /customers
GET /customers
GET /customers/{id}
PUT /customers/{id}

Agents & Roles

RBAC

Agent roster, RBAC roles (Admin, Agent, Viewer), and concurrent workload caps.

GET /agents
POST /agents
PATCH /agents/{id}/role
POST /agents/{id}/activate

Departments

Routing

Routing queues, dedicated department mailboxes, and team assignments.

GET /departments
POST /departments
PUT /departments/{id}
DELETE /departments/{id}

SLA Policies

Automation

Target matrices for first response and resolution, business hours, and automated breach engine.

GET /sla-policies
POST /sla-policies
PUT /sla-policies/{id}
DELETE /sla-policies/{id}

Canned Responses

Macros

Pre-written response templates, quick slash commands, and variable placeholders.

GET /canned-responses
POST /canned-responses
PUT /canned-responses/{id}

Tags & Categorization

Taxonomy

Unified platform tag taxonomy and ticket association sync.

GET /tags
POST /tags
PUT /tickets/{id}/tags
GET /tickets/{id}/tags

Email Settings

Mail

Custom domain inbound routing, outbound SMTP configuration, and webhook ingestion.

GET /email-settings
POST /email-settings
POST /inbound-email

Customer Portal

Portal

Customer-facing REST API for embedded help centers, ticket status, and CSAT ratings.

POST /portal/tickets
GET /portal/tickets
POST /portal/tickets/{id}/reply
POST /portal/tickets/{id}/rate

Webhooks

Events

Event stream subscriptions with HMAC-SHA256 signature verification.

GET /webhooks
POST /webhooks
PUT /webhooks/{id}
DELETE /webhooks/{id}

We use cookies and similar technologies to measure traffic and improve the site. You can choose which categories to allow. Manage Preferences.