Skip to main content
GET
/
v1
/
users
/
search
curl "https://portal-api.7331.org/v1/users/search?q=example&tier=1&limit=10" \
  -b "psession=YOUR_SESSION"

{
  "users": [
    {
      "id": 42,
      "username": "exampleuser",
      "subscription_tier": 1,
      "created_at": "2025-01-01T00:00:00Z"
    }
  ],
  "total": 1,
  "limit": 10,
  "offset": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.7331.org/llms.txt

Use this file to discover all available pages before exploring further.

Requires an active session cookie. The response varies based on the caller’s permission level:
  • Regular users: Public profiles (UserPublicResponse) with basic info only. Permission and state filters are ignored.
  • Admins+: Full user details (UserPrivateResponse) with all filters available. Non-owners only see users below their permission level.
​
q
string
Search query (max 50 characters). Searches by username or ID.
​
tier
integer
Filter by subscription tier. 0 = Basic, 1 = Trial, 2 = Premium, 3 = Lifetime.
​
permission
integer
Filter by permission level (admin+ only). 0 = User, 2 = Admin, 3 = Owner.
​
state
integer
Filter by user state (admin+ only). 0 = Active, 1 = Timeout, 2 = Banned.
​
limit
integer
default:"50"
Page size. Range: 1-100.
​
offset
integer
default:"0"
Offset for pagination. Range: 0-10000.

​
Response

​
users
object[]
required
Page of user objects. Fields vary by caller’s permission level.
​
total
integer
required
Total matching users.
​
limit
integer
required
Page size used.
​
offset
integer
required
Offset used.
curl "https://portal-api.7331.org/v1/users/search?q=example&tier=1&limit=10" \
  -b "psession=YOUR_SESSION"

{
  "users": [
    {
      "id": 42,
      "username": "exampleuser",
      "subscription_tier": 1,
      "created_at": "2025-01-01T00:00:00Z"
    }
  ],
  "total": 1,
  "limit": 10,
  "offset": 0
}