الانتقال إلى المحتوى
مركز المساعدة
المنتجات

مرجع API

GET /api/v1/public/departments

Return departments

Returns the active departments configured for the account, ordered by name. Takes no parameters.

operationId Return departments

الاستجابات

200 Every active department, ordered by name.

ترويسات الاستجابة

الاسمالنوعالوصف
X-RateLimit-Limit integer Your hourly allowance.
X-RateLimit-Remaining integer Requests left in the current window.
X-RateLimit-Reset integer When the window resets, as an absolute Unix epoch time in seconds — not a countdown.

نص application/json

الحقل النوع الإلزامية الوصف
error boolean مطلوب Always `false` on a successful response. Authentication and rate-limit failures instead return a string error code in this field.
data array مطلوب The full, unpaginated list.
id string (uuid) مطلوب Department identifier.
name string مطلوب Department name.
created_at string (date-time) مطلوب When the department was created.

مثال

{
  "error": false,
  "data": [
    {
      "id": "b18f…",
      "name": "Operations",
      "created_at": "2026-01-09T09:00:00.000Z"
    }
  ]
}

401 `API_KEY_REQUIRED` — the `Authorization: Bearer kcs_…` header is missing or malformed. `API_KEY_INVALID` — the key is unknown, revoked, or expired.

403 `INSUFFICIENT_SCOPE` — the key's scope does not permit this method. `FEATURE_NOT_AVAILABLE` — the account's plan does not include API access.

429 `RATE_LIMIT_EXCEEDED` — the hourly limit was reached. Read `Retry-After` (seconds); `X-RateLimit-Reset` is not set on a 429.

ترويسات الاستجابة

الاسمالنوعالوصف
Retry-After integer Seconds to wait before retrying.

500 Unexpected server error.