Admin Overview
Admin endpoints require platform_admin permission.
Dashboard Statistics
Response
User Management
List Users
Query Parameters
| Parameter | Type | Description |
|---|---|---|
q | string | Keyword search (username/email) |
status | string | User status filter |
limit | int | |
cursor | string | Pagination cursor |
Response
Get User Details
Response includes basic user information and a list of organizations they belong to.
Update User
Request Body (All fields optional)
| Field | Type | Description |
|---|---|---|
status | string | User status |
username | string | |
email | string | |
email_verified | bool | |
locale | string | |
timezone | string |
Delete User
Responds with 204 No Content.
Run Details
Response (Contains full execution details)
Email Configuration
Get Email Status
Response
source values: db (database configuration), env (environment variables), none (not configured).
Get Email Configuration
Response (Does not include plaintext password)
Update Email Configuration
Request Body
| Field | Type | Description |
|---|---|---|
from | string | Sender's email address |
smtp_host | string | |
smtp_port | int | |
smtp_user | string | |
smtp_pass | string | |
smtp_tls_mode | string | none/starttls/tls |
Responds with 204 No Content.
Send Test Email
Request Body
| Field | Type | Required |
|---|---|---|
to | string | Yes |
Responds with 204 No Content.
Gateway Configuration
Get Gateway Configuration
Response
Update Gateway Configuration
Request Body
| Field | Type | Description |
|---|---|---|
ip_mode | string | direct/proxy/cdn |
trusted_cidrs | []string | Trusted CIDR list |
risk_reject_threshold | float64 | Risk rejection threshold (0-1) |
Access Log
Real-time access log query based on Redis Stream.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
limit | int | Items per page |
before | string | cursor (forward pagination) |
since | string | Starting from this ID |
method | string | HTTP method filter |
path | string | Path prefix filter |
ip | string | IP filter |
country | string | Country code filter |
risk_min | float64 | Minimum risk score |
ua_type | string | UA type filter |
Response
Invitation Code Management
List Invitation Codes
Query Parameters: limit, q (keyword), cursor
Response
Get Invitation Code
Update Invitation Code
Request Body
| Field | Type |
|---|---|
max_uses | int |
is_active | bool |
Referral Relationship
List Referral Records
Query Parameters: inviter_user_id, limit, cursor
Get Referral Tree
Response
Redemption Code Management
Bulk Create Redemption Codes
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
count | int | Yes | Number to generate |
type | string | Yes | Type (e.g., credits) |
value | string | Yes | Redemption value |
max_uses | int | No | Maximum uses per code |
expires_at | string | No | Expiration time (RFC3339) |
batch_id | string | No | Batch identifier |
List Redemption Codes
Query Parameters: limit, q, type, cursor
Update Redemption Code
Request Body
| Field | Type |
|---|---|
is_active | bool |