Get a list of users

GET 
/admin/users/list/:flag.json

Get a list of users

Request

Path Parameters

flag stringrequired

Possible values: [active, new, staff, suspended, blocked, suspect]

Query Parameters

order string

Possible values: [created, last_emailed, seen, username, email, trust_level, days_visited, posts_read, topics_viewed, posts, read_time]

asc string

Possible values: [true]

page integer
show_emails boolean

Include user email addresses in response. These requests will be logged in the staff action logs.

stats boolean

Include user stats information

email string

Filter to the user with this email address

ip string

Filter to users with this IP address

Responses

200

response

application/json

Schema

Schema

• Array [
id integerrequired
username stringrequired
name stringnullrequired
avatar_template stringrequired
email stringrequired
secondary_emails undefined[]required
active booleanrequired
admin booleanrequired
moderator booleanrequired
last_seen_at stringnullrequired
last_emailed_at stringnullrequired
created_at stringrequired
last_seen_age numbernullrequired
last_emailed_age numbernullrequired
created_at_age numbernullrequired
trust_level integerrequired
manual_locked_trust_level stringnullrequired
title stringnullrequired
time_read integerrequired
staged booleanrequired
days_visited integerrequired
posts_read_count integerrequired
topics_entered integerrequired
post_count integerrequired
• ]

Example (from schema)

[
  {
    "id": 0,
    "username": "string",
    "avatar_template": "string",
    "email": "string",
    "secondary_emails": [
      null
    ],
    "active": true,
    "admin": true,
    "moderator": true,
    "created_at": "string",
    "trust_level": 0,
    "time_read": 0,
    "staged": true,
    "days_visited": 0,
    "posts_read_count": 0,
    "topics_entered": 0,
    "post_count": 0
  }
]

Loading...