API / Nº 04
API endpoints
The Vicket API is REST, JSON, versioned at /v1 for the dashboard surface and /support/v1 for the public surface your support page calls. All endpoints return a stable envelope: data on success, { "error": { "code", "message" } } on failure. Authentication rules are in api-authentication.
Endpoint groups
| Group | Auth | Purpose |
|---|---|---|
GET /v1/me | session | Current user |
/v1/orgs | session | List, create orgs |
/v1/orgs/{slug} | session | Read, update a specific org |
/v1/orgs/{slug}/members | session | Invite, list, role-set members |
/v1/orgs/{slug}/sites | session | CRUD sites in an org |
/v1/orgs/{slug}/statuses | session | CRUD ticket statuses |
/v1/orgs/{slug}/priorities | session | CRUD priorities |
/v1/orgs/{slug}/templates | session | CRUD ticket form templates |
/v1/orgs/{slug}/workflows | session | CRUD workflows + run history |
/v1/orgs/{slug}/help/articles | session | Author articles |
/v1/orgs/{slug}/help/faqs | session | Author FAQs |
/v1/orgs/{slug}/tickets | session | Agent-facing ticket inbox |
/support/v1/templates | site key | Published ticket form templates |
/support/v1/tickets | site key | Public ticket submission |
/support/v1/help/articles | site key | Published articles |
/support/v1/help/faqs | site key | Published FAQs |
Verbs and conventions
| Verb | Effect |
|---|---|
GET | Read. Idempotent. |
POST | Create. Returns the created resource with a server-issued ID. |
PATCH | Partial update. Send only fields you want to change. |
PUT | Full replace. Rare, used for workflow graphs. |
DELETE | Delete. 204 on success. |
Idempotency
POST /support/v1/tickets accepts an optional Idempotency-Key header. The same key with the same body returns the cached response; the same key with a different body returns 409. The scaffolded components send a UUID per submission so accidental double-clicks are safe.
Rate limits
Public endpoints are rate limited per site and per IP. Exceeding the limit returns 429; back off and retry.
Example: list published articles
GET /support/v1/help/articles HTTP/1.1
Host: api.vicket.app
X-Vicket-Key: pk_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0
Next
- Outbound from us to you: webhooks.
- Auth specifics: api-authentication.