List subscribers
GET
/api/v1/users
prm_users_index
One page of subscribers under the caller's authority. A manager without tenant-wide visibility sees only subscribers owned by their own manager subtree, and that scope is injected server-side, so a filter can narrow within it but never widen past it.
The per-subscriber scan token (lookup_token) is deliberately absent from list rows. It is served by GET /users/{id} and GET /users/resolve only, because a page of a thousand rows is a bulk harvest of codes that each unlock a subscriber record.
نظرة سريعة
- المصادقة
- رمز موظّف أو جلسة
- تتطلب صلاحية
-
prm_users_indexView users - حد المعدل
user_list
المعاملات
| المعامل | الوصف |
|---|---|
q
query · string
|
Searches username, email, first and last name, phone, contract id, national id and static IP. A purely numeric term also matches the subscriber id exactly. |
filter[enabled]
query · boolean
|
The admin suspend flag. Not the same thing as expired. |
filter[expired]
query · boolean
|
Subscription window has passed. |
filter[online]
query · boolean
|
An open RADIUS session exists right now. |
filter[profile_id]
query · integer
|
Bound plan. |
filter[parent_id]
query · integer
|
Owning manager. Ignored, not honoured, when it would widen a restricted caller's scope. |
filter[username_exact]
query · string
|
Case-insensitive exact username, for a caller that already knows the identity and wants one deterministic row instead of a page of substring hits. |
filter[expiring_within_days]
query · integer
|
Future expiries only. |
filter[created_from]
query · string
|
yyyy-MM-dd HH:mm:ss in UTC. A malformed value is a 400, not an ignored filter. |
الأخطاء
| الرمز | متى تُرجَع |
|---|---|
ERR_VALIDATION400
|
filter[created_from] is not a parseable timestamp |