مرجع عام

Managers

كل نقاط النهاية في هذه المجموعة. افتح أي واحدة لعرض معاملاتها ومثال عملي عليها.

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

اعرض الصفحة بصيغة Markdown

Managers

32
POST /api/v1/admin/managers/bulk-group Assign groups prm_groups_assign
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_groups_assign Assign groups
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

POST /api/v1/admin/managers/{id}/group Assign groups prm_groups_assign
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_groups_assign Assign groups
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

GET /api/v1/managers List managers prm_managers_index

One page of managers. A caller without tenant-wide visibility sees their own descendants only — never their parent, never a sibling branch.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_index View managers

debt, parent_username, users_count and the other joined fields are computed by the list projection only. Fetching one manager by id returns the same record without them, so a client that reads users_count off a detail response will always see zero.

المعاملات

المعامل الوصف
filter[parent_id] query · integer Direct children of one manager. Also accepted as a bare parent_id query parameter. Narrows within the caller's subtree, never past it.
q query · string Searches name, username and email.
الاستجابة 200 OK
{
  "data": [
    {
      "id": 57,
      "tenant_id": 12,
      "email": "giza@acme.example",
      "username": "giza-reseller",
      "firstname": "Mona",
      "status": "active",
      "parent_manager_id": 41,
      "parent_username": "cairo-reseller",
      "balance": 1840.00,
      "debt_limit": 5000.00,
      "debt": 0.00,
      "discount_rate": 10.00,
      "points_balance": 240,
      "users_count": 312,
      "created_at": "2026-05-02 09:00:00"
    }
  ],
  "meta": { "page": 1, "page_size": 50, "total": 9, "has_next": false }
}
POST /api/v1/managers Create a manager prm_managers_create

Creates a staff or reseller account. A manager needs at least one login identity, so email or username must be present.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_create Create managers
حد المعدل
t_mutate

المعاملات

المعامل الوصف
email body · string Login email. Unique within the tenant. Required unless username is given.
username body · string Login username. Required unless email is given.
passwordمطلوب body · string Hashed with Argon2id before storage, unlike a subscriber's.
parent_manager_id body · integer Defaults to the caller. Never null — a tenant keeps exactly one root manager, its owner. A named parent must be one the caller may act on.
GET /api/v1/managers/all List managers for a picker prm_managers_index

Id and name only, un-paginated, for populating a select control. Same subtree scope as the full list.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_index View managers
POST /api/v1/managers/bulk-activate Edit managers prm_managers_update
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_update Edit managers
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

POST /api/v1/managers/bulk-delete Delete managers prm_managers_delete
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_delete Delete managers
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

POST /api/v1/managers/bulk-suspend Edit managers prm_managers_update
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_update Edit managers
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

DELETE /api/v1/managers/{id} Delete a manager prm_managers_delete

Hard-deletes the manager. Refused while they are still referenced by subscribers, card stock or ledger records — move those first.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_delete Delete managers
حد المعدل
t_mutate

المعاملات

المعامل الوصف
idمطلوب path · integer Manager id.
GET /api/v1/managers/{id} Fetch one manager prm_managers_index

The manager record, including their custom form fields.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_index View managers

المعاملات

المعامل الوصف
idمطلوب path · integer Manager id.
PATCH /api/v1/managers/{id} Update a manager prm_managers_update

Partial update. An omitted field is left alone.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_update Edit managers
حد المعدل
t_mutate

المعاملات

المعامل الوصف
idمطلوب path · integer Manager id.
POST /api/v1/managers/{id}/2fa/reset Edit managers prm_managers_update
المصادقة
رمز موظّف أو جلسة جلسة موظّف فقط — لا يمكن لرمز API استدعاؤها
تتطلب صلاحية
prm_managers_update Edit managers
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

POST /api/v1/managers/{id}/activate Edit managers prm_managers_update
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_update Edit managers
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

GET /api/v1/managers/{id}/debt Read a manager's debt prm_managers_journal

Outstanding debt for this manager, read off the loan ledger.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_journal View manager journal

المعاملات

المعامل الوصف
idمطلوب path · integer Manager id.
GET /api/v1/managers/{id}/invoices View manager invoices prm_managers_invoices
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_invoices View manager invoices

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

GET /api/v1/managers/{id}/journal Read a manager's ledger prm_managers_journal

Every money movement on this manager's wallet, newest first, with a running balance. This is the authoritative record — the wallet balance is its consequence, not a parallel truth.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_journal View manager journal

المعاملات

المعامل الوصف
idمطلوب path · integer Manager id.
GET /api/v1/managers/{id}/loans View manager journal prm_managers_journal
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_journal View manager journal

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

POST /api/v1/managers/{id}/login-as Log in as manager prm_managers_login_as
المصادقة
رمز موظّف أو جلسة جلسة موظّف فقط — لا يمكن لرمز API استدعاؤها
تتطلب صلاحية
prm_managers_login_as Log in as manager
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

GET /api/v1/managers/{id}/overview View managers prm_managers_index
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_index View managers

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

GET /api/v1/managers/{id}/payments View manager receipts prm_managers_receipts
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_receipts View manager receipts

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

POST /api/v1/managers/{id}/points/add Add / deduct manager reward points prm_managers_reward_points
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_reward_points Add / deduct manager reward points
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

POST /api/v1/managers/{id}/points/deduct Add / deduct manager reward points prm_managers_reward_points
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_reward_points Add / deduct manager reward points
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

GET /api/v1/managers/{id}/profile View managers prm_managers_index
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_index View managers

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

GET /api/v1/managers/{id}/receipts View manager receipts prm_managers_receipts
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_receipts View manager receipts

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

POST /api/v1/managers/{id}/reset-password Edit managers prm_managers_update
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_update Edit managers
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

GET /api/v1/managers/{id}/roles Read a manager's roles prm_managers_index

The roles assigned to this manager, which is what their permissions resolve from.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_index View managers

المعاملات

المعامل الوصف
idمطلوب path · integer Manager id.
PUT /api/v1/managers/{id}/roles Replace a manager's roles prm_roles_manage

Replaces the whole set. A caller may only grant roles whose permissions are a subset of their own, so this cannot be used to escalate.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_roles_manage Manage roles & permissions
حد المعدل
t_mutate

This takes effect on every API token that manager holds, immediately and silently. A token's authority is its owner's live permissions intersected with its own scope, so removing a role here shrinks every integration running as that person with no notification and no change to the token record.

المعاملات

المعامل الوصف
idمطلوب path · integer Manager id.
role_idsمطلوب body · array The complete new set of role ids.
POST /api/v1/managers/{id}/suspend Suspend a manager prm_managers_update

Sets the account to suspended. They can no longer sign in, and every API token they own stops authenticating with reason api_token_owner_inactive.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_update Edit managers
حد المعدل
t_mutate

Suspending a reseller does not touch the subscribers below them. Those keep connecting; only the person's own access ends.

المعاملات

المعامل الوصف
idمطلوب path · integer Manager id.
POST /api/v1/managers/{id}/wallet/deposit Credit a manager wallet prm_managers_deposit

Moves money into a reseller's wallet and posts the matching ledger entry. Idempotent on request_id through the ledger's own unique constraint.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_deposit Deposit to manager wallet
حد المعدل
t_mutate
مفتاح عدم التكرار
request_id

issue_invoice defaults differently here than on the subscriber wallet. Omitting it on a manager deposit issues the document; omitting it on a subscriber deposit does not. Send it explicitly if you care either way.

المعاملات

المعامل الوصف
idمطلوب path · integer Manager id. May not be the caller themselves.
amountمطلوب body · number Major units, a bare JSON number.
request_idمطلوب body · string Idempotency key.
reason body · string Free-text note recorded on the ledger row.
issue_invoice body · boolean Also record the human-facing accounting document. Defaults to TRUE when omitted on the manager side, unlike the subscriber side.
POST /api/v1/managers/{id}/wallet/pay-debt Settle a manager's debt prm_managers_pay_debt

Records a repayment against a creditor. The creditor defaults to the debtor's parent manager.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_pay_debt Settle manager debt
حد المعدل
t_mutate
مفتاح عدم التكرار
request_id

المعاملات

المعامل الوصف
idمطلوب path · integer The debtor. May not be the caller themselves.
amountمطلوب body · number Major units.
creditor_manager_id body · integer Which creditor is being repaid. Absent means the debtor's parent.
request_idمطلوب body · string Idempotency key.
POST /api/v1/managers/{id}/wallet/topup Deposit to manager wallet prm_managers_deposit
المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_deposit Deposit to manager wallet
حد المعدل
t_mutate

مقروء مباشرة من الموجّه الذي يخدم هذه النسخة. لم يُضَف بعد وصف مكتوب لنقطة النهاية هذه.

POST /api/v1/managers/{id}/wallet/withdraw Debit a manager wallet prm_managers_withdrawal

The inverse of deposit, posting the matching ledger entry.

المصادقة
رمز موظّف أو جلسة
تتطلب صلاحية
prm_managers_withdrawal Withdraw from manager wallet
حد المعدل
t_mutate
مفتاح عدم التكرار
request_id

المعاملات

المعامل الوصف
idمطلوب path · integer Manager id.
amountمطلوب body · number Major units.
request_idمطلوب body · string Idempotency key.
allow_negative body · boolean Permit the withdrawal to drive the balance below zero.

مكتوب لتقرأه الأدوات الآلية أيضًا

المرجع عام ولا يتطلب حسابًا، فتستطيع أداة لم تَرَ X-Radius من قبل أن تصل إلى أول استدعاء صحيح بنفسها.

/llms.txt
فهرس لكل صفحة، مع ملخّص من سطر واحد.
/llms-full.txt
المرجع كاملًا في ملف Markdown واحد، دون تنقّل يحتاج إلى زحف.
/openapi.json
‏OpenAPI 3.1، مُولَّد من الموجّه الذي يخدم هذه النسخة.
/skill.md
ملف مهارة جاهز لمساعد آلي: المصادقة وشكل الاستجابة ورموز الأخطاء في صفحة واحدة.
<page-url>.md
أضف ‎.md إلى رابط أي صفحة في المرجع لتحصل على الصفحة نفسها بصيغة Markdown.
Accept: text/markdown
أرسل هذه الترويسة على الرابط المعتاد فتصلك الإجابة بصيغة Markdown بدلًا من الصفحة.
سلّم هذا السطر إلى مساعدك الآلي
اقرأ https://x-radius.com/llms.txt، ثم اجلب نقطة النهاية التي تحتاجها بصيغة Markdown بإضافة ‎.md إلى رابطها.

جرّبه على شبكتك.

50 مشترك لمدة 7 أيام، من غير ما تدفع حاجة.