REST API Reference

The SilentChat REST API lets you access and manage all platform resources programmatically. All endpoints are versioned and return JSON.

Overview

Base URL

https://api.silentchat.de/api

Versioning

All endpoints live under /api/v1/. When breaking changes are introduced, a new version prefix is published and the old version is deprecated with six months' notice.

Content Type

Send all request bodies as JSON with the Content-Type: application/json header.

Authentication

See the Authentication guide for full details. Every endpoint (unless marked Public) requires either a valid JWT bearer token or an X-API-Key header.

Auth

Tenants

Conversations

Hand over and reopen

Both actions require a user token (JWT) with write access to conversations. They are rejected for API keys and for lite seats.

Hand over

The body names exactly one target: user_id (a person) or department_id (a department). For a department, SilentChat picks an active member, preferring one who is online. note is optional (at most 2,000 characters) and is saved as an internal note. The conversation is then "assigned"; the recipient is notified and the visitor sees a short notice without names.

POST /api/v1/conversations/:id/transfer
Authorization: Bearer <token>
Content-Type: application/json

{ "user_id": "<uuid>", "note": "…" }
// oder / or: { "department_id": "<uuid>" }

200 → { "message": "Conversation transferred", "conversation": { … } }

Reopen

No body. The conversation is then "open" and unassigned; the AI bot's state is left as it was. The visitor sees a short notice.

POST /api/v1/conversations/:id/reopen
Authorization: Bearer <token>

200 → { "conversation": { "status": "open", "assigned_user_id": null, … } }

Error codes

Real-time events over the WebSocket: conversation.transferred (conversation_id, assigned_user_id, department_id) and conversation.reopened (conversation_id). For a picker, GET /api/v1/team/members?include=presence adds presence (online, away, offline) and open_conversations to each member.

Messages

Visitors

Contacts

Widgets

Domains

Canned Responses

Files

Billing

Example Request & Response

The SilentChat REST API lets you access and manage all platform resources programmatically. All endpoints are versioned and return JSON.

Request

GET /v1/conversations?status=open&limit=10 HTTP/1.1
Host: api.silentchat.de
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Content-Type: application/json
X-Tenant-ID: tn_abc123

Response

{
  "data": [
    {
      "id": "conv_01HXYZ",
      "status": "open",
      "visitor_id": "vis_9f2c4e1a",
      "assigned_to": "usr_d4e5f6",
      "last_message": "Hi, I have a question about pricing.",
      "last_message_at": "2025-10-12T14:32:00Z",
      "created_at": "2025-10-12T14:30:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 10,
    "offset": 0,
    "has_more": true
  }
}