support

Support

Report a problem or suggest a feature to the vendor from a self-hosted install, and see the vendor's status and replies (self-hosted installs only).

5 نقاط النهاية

GET `/api/v1/support/submissions`

What this institute sent the vendor, newest first (cursor-paginated): the text, whether it has left the install, what the vendor did with it and the vendor’s replies. Self-hosted only.

يتطلّب المصادقةالصلاحيةsupport.submit

معطيات المسار والاستعلام

الاسم	الموضع	النوع	القيود
cursor	query	string	—
limit	query	integer	1–100 · default: 25

مثال بأمر curl

curl

curl -X GET "https://your-institute.example/api/v1/support/submissions" \
  -H "Authorization: Bearer $INSTITFLOW_API_KEY"

الاستجابات

200A page of submissions.

الاسم	النوع	القيود
dataمطلوب	array<object>	—
nextCursorمطلوب	string \| null	—

json

{
  "data": [
    {
      "id": "37386ae0-3738-7738-8386-37386ae03738",
      "kind": "problem",
      "category": "login_access",
      "title": "Midterm Exam",
      "body": "string",
      "delivery": "queued",
      "lastError": "string",
      "remoteStatus": "new",
      "createdAt": "2026-03-02T09:00:00.000Z",
      "sentAt": "2026-03-02T09:00:00.000Z",
      "syncedAt": "2026-03-02T09:00:00.000Z",
      "replies": [
        {
          "id": "37386ae0-3738-7738-8386-37386ae03738",
          "body": "string",
          "createdAt": "2026-03-02T09:00:00.000Z"
        }
      ]
    }
  ],
  "nextCursor": null
}

400The request could not be read at all — unparseable body, unusable content type, oversized payload (`MALFORMED_REQUEST`). Never a schema failure: those are 422.

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

401Missing, expired or invalid credentials (`UNAUTHORIZED`, `TOKEN_INVALID`, `SESSION_REVOKED`).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

402The tenant’s subscription or license is locked (`PAYMENT_REQUIRED`, `SUBSCRIPTION_SUSPENDED`).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

403Authenticated, but not allowed (`FORBIDDEN`, `FEATURE_DISABLED`, `QUOTA_EXCEEDED`, …).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

404No such resource, or it is not visible to this tenant (`NOT_FOUND`).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

409Conflicts with current state (`CONFLICT`, `VERSION_CONFLICT`, `IDEMPOTENCY_KEY_REUSED`).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

422The request was read but its content is not acceptable: body/query/path/header failed schema validation (`VALIDATION_ERROR`, with `details.issues`), or a domain rule rejected a well-formed value (`VIDEO_URL_INVALID`, …).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

429Rate limit exceeded — see the `RateLimit-*` and `Retry-After` headers (`RATE_LIMITED`).

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

500Unexpected server error (`INTERNAL_ERROR`). Never carries a stack trace or SQL.

تُعيد مغلّف الخطأ المشترك `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. جميع الرموز مذكورة في دليل الاصطلاحات.

POST `/api/v1/support/submissions`

Report a problem or suggest a feature to the vendor. Saved here first and sent in the background, retried if the vendor cannot be reached. Do not include personal data. Self-hosted only.

يتطلّب المصادقةالصلاحيةsupport.submit

محتوى الطلب

الاسم	النوع	القيود
kindمطلوب	enum: "problem" \| "feature"	—
categoryمطلوب	enum: "login_access" \| "people" \| "attendance" \| "billing" \| "courses_content" \| "notifications" \| "updates_backups" \| "performance" \| "other"	—
titleمطلوب	string	1–120 chars
textمطلوب	string	1–4000 chars

مثال

json

{
  "kind": "problem",
  "category": "login_access",
  "title": "Midterm Exam",
  "text": "string"
}

مثال بأمر curl

curl

curl -X POST "https://your-institute.example/api/v1/support/submissions" \
  -H "Authorization: Bearer $INSTITFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "kind": "problem",
    "category": "login_access",
    "title": "Midterm Exam",
    "text": "string"
  }'

الاستجابات

201The saved submission, queued.

الاسم	النوع	القيود
idمطلوب	string (uuid)	—
kindمطلوب	enum: "problem" \| "feature"	—
categoryمطلوب	enum: "login_access" \| "people" \| "attendance" \| "billing" \| "courses_content" \| "notifications" \| "updates_backups" \| "performance" \| "other"	—
titleمطلوب	string	—
bodyمطلوب	string	—
deliveryمطلوب	enum: "queued" \| "sent" \| "failed"	—
lastErrorمطلوب	string \| null	—
remoteStatusمطلوب	enum: "new" \| "acknowledged" \| "in_progress" \| "resolved" \| "declined" \| "duplicate" \| null \| null	—
createdAtمطلوب	string (date-time)	—
sentAtمطلوب	string (date-time) \| null	—
syncedAtمطلوب	string (date-time) \| null	—
repliesمطلوب	array<object>	—

json

{
  "id": "37386ae0-3738-7738-8386-37386ae03738",
  "kind": "problem",
  "category": "login_access",
  "title": "Midterm Exam",
  "body": "string",
  "delivery": "queued",
  "lastError": "string",
  "remoteStatus": "new",
  "createdAt": "2026-03-02T09:00:00.000Z",
  "sentAt": "2026-03-02T09:00:00.000Z",
  "syncedAt": "2026-03-02T09:00:00.000Z",
  "replies": [
    {
      "id": "37386ae0-3738-7738-8386-37386ae03738",
      "body": "string",
      "createdAt": "2026-03-02T09:00:00.000Z"
    }
  ]
}